Welcome to Jupyter AI, which brings generative AI to Jupyter. Jupyter AI provides a user-friendly and powerful way to explore generative AI models in notebooks and improve your productivity in JupyterLab and the Jupyter Notebook. More specifically, Jupyter AI offers:
- An
%%aimagic that turns the Jupyter notebook into a reproducible generative AI playground. This works anywhere the IPython kernel runs (JupyterLab, Jupyter Notebook, Google Colab, VSCode, etc.). - A native chat UI in JupyterLab that enables you to work with generative AI as a conversational assistant.
- Support for a wide range of generative model providers and models (AI21, Anthropic, Cohere, Hugging Face, OpenAI, SageMaker, etc.).
Documentation is available on ReadTheDocs.
If you want to install both the %%ai magic and the JupyterLab extension, you can run:
$ pip install jupyter_ai
If you are not using JupyterLab and only want to install the Jupyter AI %%ai magic you can run:
$ pip install jupyter_ai_magics
The %%ai magic works anywhere the IPython kernel runs (JupyterLab, Jupyter Notebook, Google Colab, VSCode, etc.).
To complete your installation, you will also need to install any packages and API keys for the model providers you wish to use. See our documentation for details.
Once you installed the %%ai magic, you can enable it in any notebook or the IPython shell by running:
%load_ext jupyter_ai_magics
Or
%load_ext jupyter_ai
Then you can use the %%ai magic command to specify a model and natural language prompt:
Jupyter AI can also generate HTML and math to be rendered as cell output.
Jupyter AI can interpolate IPython expressions, allowing you to run prompts that include variable values.
The Jupyter AI extension for JupyterLab offers a native UI that enables multiple users
to chat with the Jupyter AI conversational assistant. If you have JupyterLab instaled,
this should be installed and activated when you install the jupyter_ai package.
For help with installing and using Jupyter AI, please see our user documentation on ReadTheDocs.
If you would like to contribute to Jupyter AI, see our contributor documentation on ReadTheDocs.