A generative AI extension for JupyterLab
Project description
jupyter_ai
This extension is composed of a Python package named jupyter_ai
for the server extension and a NPM package named jupyter_ai
for the frontend extension.
Requirements
- JupyterLab >= 3.5 (not JupyterLab 4)
Install
To install the extension, execute:
pip install jupyter_ai
Uninstall
To remove the extension, execute:
pip uninstall jupyter_ai
Usage with GPT-3
To use the GPT3ModelEngine in jupyter_ai, you will need an OpenAI API key.
Copy the API key and then create a Jupyter config file locally at config.py to
store the API key.
c.GPT3ModelEngine.api_key = "<your-api-key>"
Finally, start a new JupyterLab instance pointing to this configuration file.
jupyter lab --config=config.py
If you are doing this in a Git repository, you can ensure you never commit this
file on accident by adding it to .git/info/exclude.
Alternately, you can also specify your API key while launching JupyterLab.
jupyter lab --GPT3ModelEngine.api_key=<api-key>
Troubleshoot
If you can see the extension UI, but it is not working, check that the server extension is enabled:
jupyter server extension list
If the server extension is installed and enabled, but you don't see the extension UI, verify that the frontend extension is installed:
jupyter labextension list
Contributing
Development install
Note: You will need NodeJS to build the extension package.
The jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn or npm in lieu of jlpm below.
# Clone the repo to your local environment
# Change directory to the jupyter_ai directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyter_ai
# Rebuild extension Typescript source after making changes
jlpm build
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
Development uninstall
# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyter_ai
pip uninstall jupyter_ai
In development mode, you will also need to remove the symlink created by jupyter labextension develop
command. To find its location, you can run jupyter labextension list to figure out where the labextensions
folder is located. Then you can remove the symlink named jupyter_ai within that folder.
Testing the extension
Server tests
This extension is using Pytest for Python code testing.
Install test dependencies (needed only once):
pip install -e ".[test]"
To execute them, run:
pytest -vv -r ap --cov jupyter_ai
Frontend tests
This extension is using Jest for JavaScript code testing.
To execute them, execute:
jlpm
jlpm test
Integration tests
This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.
More information are provided within the ui-tests README.
Packaging the extension
See RELEASE
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jupyter_ai-0.4.0.tar.gz.
File metadata
- Download URL: jupyter_ai-0.4.0.tar.gz
- Upload date:
- Size: 193.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dc50892ba610823e21c414b337657698de80abea9420e3504f9a9b08345b36d3 |
|
| MD5 | 2e6734d038b63d792e9a2bfd2b2c73ef |
|
| BLAKE2b-256 | 6932b3602b730fe12a51581b605d1b820facbbe0e56ccd5e9251f72b07705a7a |
File details
Details for the file jupyter_ai-0.4.0-py3-none-any.whl.
File metadata
- Download URL: jupyter_ai-0.4.0-py3-none-any.whl
- Upload date:
- Size: 193.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c556112f7b3c7ffe38360375ad28554d01c395f0a3b8fbf0c48159b55e7ee5a5 |
|
| MD5 | 47425384749b182795b8517f27a7ab73 |
|
| BLAKE2b-256 | a36e94cbaf1d6cd73df59f3d9d26c503d1c1835fb7a005c855b36d04680572e1 |
