tiesdekok / chat-gpt-jupyter-extension

A browser extension to provide various AI helper functions in Jupyter Notebooks, powered by ChatGPT.

ChatGPT for Jupyter

⚠️ September 2023 Update: This repository is archived as I am unable to maintain it in my new role. I recommend using: https://github.com/jupyterlab/jupyter-ai as an alternative.

---

A browser extension to provide various helper functions in Jupyter Notebooks and Jupyter Lab, powered by ChatGPT or GPT-4.

Primary functions, have ChatGPT/GPT-4:

• Format - Automatically add comments, docstrings, and formatting to your code cell.
• Explain - Explain the content of your code cell, ELI5 style.
• Debug - Help you debug an error message in your code cell.
• Complete - Help you complete a code snippet in your code cell.
• Review - Provide a code review of your code cell.
• Ask a question - Ask ChatGPT a custom question.
• Voice command - Ask ChatGPT a custom question through your microphone.
  • Note: this requires an OpenAI API key and uses the OpenAI Whisper API, which charges $0.006 per minute.

Note: Ask a question and Voice command are a work-in-progress.

Project status: Stable - but developments happen frequently - if you run into problems or have feature suggestions --> Submit them as an issue!

Major acknowledgements:

• ChatGPT/GPT-4 for doing all the heavy lifting.
• wong2/chat-gpt-google-extension for serving as the original base for the extension.

Caveats & Warnings:

• ChatGPT is amazing, however, it is not perfect and it does make mistakes. I consider ChatGPT to be a "keep your hands on the wheel and look at the road at all times" type of situation. You cannot blindly rely on it. Don't be surprised if it does any of the following:
  • Modify your code in unexpected ways
  • Generate code that does not work
  • Provide incorrect explanations & error explanations
  • Incorrectly highlight correct code as incorrect
• In many cases you will get better results if you try a few times and pick the result you like best. ChatGPT likely can do what you want, but it might not be the first result it gives you.

Screenshot Gallery

ChatGPT - Format

ChatGPT - Explain

ChatGPT - Debug

ChatGPT - Complete

Installation

Install to Chrome/Edge

Install from Chrome Web Store (Preferred)

https://chrome.google.com/webstore/detail/chatgpt-jupyter-ai-assist/dlipncbkjmjjdpgcnodkbdobkadiejll

Local Install

1. Download chromium.zip from Releases.
2. Unzip the file.
3. In Chrome/Edge go to the extensions page (chrome://extensions or edge://extensions).
4. Enable Developer Mode.
5. Drag the unzipped folder anywhere on the page to import it (do not delete the folder afterwards).

Install to Firefox

Local Install

1. Download firefox.zip from Releases.
2. Unzip the file.
3. Go to about:debugging, click "This Firefox" on the sidebar.
4. Click "Load Temporary Add-on" button, then select any file in the unzipped folder.

Build from source

1. Clone the repo
2. Install dependencies with npm
3. npm run build
4. Load build/chromium/ or build/firefox/ directory to your browser

Issues & Feature requests

Please report any issues or feature requests on the GitHub Issue tab. I will try to respond as soon as possible!

Outstanding items & Future plans

• Add Jupyter Lab support
• Refactor prompt engineering
• Add copy-paste functionality and/or auto-adding
• Add interupt button
• Add integration tests