Are you sure you want to delete this task? Once this task is deleted, it cannot be recovered.
michaelchia 759c60c079 | 4 days ago | |
---|---|---|
.github/workflows | 4 months ago | |
docs | 4 days ago | |
examples | 3 months ago | |
packages | 4 days ago | |
playground | 10 months ago | |
scripts | 9 months ago | |
.gitignore | 2 months ago | |
.jupyter-releaser.toml | 9 months ago | |
.pre-commit-config.yaml | 7 months ago | |
.readthedocs.yaml | 1 year ago | |
.yarnrc.yml | 9 months ago | |
CHANGELOG.md | 1 week ago | |
LICENSE | 1 year ago | |
README.md | 1 week ago | |
conftest.py | 8 months ago | |
lerna.json | 1 week ago | |
nx.json | 4 months ago | |
package.json | 1 week ago | |
pyproject.toml | 3 months ago | |
yarn.lock | 3 months ago |
Jupyter AI is under incubation as part of the JupyterLab organization.
Jupyter AI connects generative AI with Jupyter notebooks. 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:
%%ai
magic that turns the Jupyter notebook into a reproducible generative AI playground.Documentation is available on ReadTheDocs.
You will need to have installed the following software to use Jupyter AI:
In addition, you will need access to at least one model provider.
[!IMPORTANT]
JupyterLab 3 will reach its end of maintenance date on May 15, 2024, anywhere on Earth. As a result, we will not backport new features to the v1 branch supporting JupyterLab 3 after this date. Fixes for critical issues will still be backported until December 31, 2024. If you are still using JupyterLab 3, we strongly encourage you to upgrade to JupyterLab 4 as soon as possible. For more information, see JupyterLab 3 end of maintenance on the Jupyter Blog.
To use any AI model provider within this notebook, you'll need the appropriate credentials, such as API keys.
Obtain the necessary credentials, such as API keys, from your model provider's platform.
You can set your keys using environment variables or in a code cell in your notebook.
In a code cell, you can use the %env magic command to set the credentials as follows:
# NOTE: Replace 'PROVIDER_API_KEY' with the credential key's name,
# and replace 'YOUR_API_KEY_HERE' with the key.
%env PROVIDER_API_KEY=YOUR_API_KEY_HERE
For more specific instructions for each model provider, refer to the model providers documentation.
Below is a simplified overview of the installation and usage process.
See our official documentation
for details on installing and using Jupyter AI.
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 you only want to install the Jupyter AI %%ai
magic, you can run:
$ pip install jupyter-ai-magics
As an alternative to using pip
, you can install jupyter-ai
using
Conda
from the conda-forge
channel, using one of the following two commands:
$ conda install -c conda-forge jupyter-ai # or,
$ conda install conda-forge::jupyter-ai
%%ai
magic commandThe %%ai
magic works anywhere the IPython kernel runs, including JupyterLab, Jupyter Notebook, Google Colab, and Visual Studio Code.
Once you have 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
The screenshots below are from notebooks in the examples/
directory of this package.
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 installed,
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.
No Description
YAML Python TSX TypeScript SVG other
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》