Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport PR #611 on branch 1.x (Mentions conda install instructions in docs) #618

Merged
merged 1 commit into from
Feb 5, 2024
Merged

Backport PR #611 on branch 1.x (Mentions conda install instructions in docs) #618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,19 @@ Before you can use Jupyter AI, you will need to install any packages and set env

If you want to install both the `%%ai` magic and the JupyterLab extension, you can run:

$ pip install jupyter_ai
$ 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
$ pip install jupyter-ai-magics

### With conda

As an alternative to using `pip`, you can install `jupyter-ai` using
[Conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)
from the `conda-forge` channel:
from the `conda-forge` channel, using one of the following two commands:

$ conda install -c conda-force jupyter-ai # or,
$ conda install conda-forge::jupyter-ai

## The `%%ai` magic command
Expand Down
37 changes: 23 additions & 14 deletions docs/source/users/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,26 +62,26 @@ classes in their code.
To install the JupyterLab extension, you can run:

```
pip install jupyter_ai
pip install jupyter-ai
```

The latest major version of `jupyter_ai`, v2, only supports JupyterLab 4. If you
need support for JupyterLab 3, you should install `jupyter_ai` v1 instead:
The latest major version of `jupyter-ai`, v2, only supports JupyterLab 4. If you
need support for JupyterLab 3, you should install `jupyter-ai` v1 instead:

```
pip install jupyter_ai~=1.0
pip install jupyter-ai~=1.0
```

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
$ pip install jupyter-ai-magics
```

`jupyter_ai` depends on `jupyter_ai_magics`, so installing `jupyter_ai`
automatically installs `jupyter_ai_magics`.
`jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai`
automatically installs `jupyter-ai-magics`.

### Installation via `pip` within Conda environment (recommended)
### Installation via `pip` or `conda` in a Conda environment (recommended)

We highly recommend installing both JupyterLab and Jupyter AI within an isolated
Conda environment to avoid clobbering Python packages in your existing Python
Expand All @@ -93,10 +93,11 @@ and create an environment that uses Python 3.11:

$ conda create -n jupyter-ai python=3.11
$ conda activate jupyter-ai
$ pip install jupyter_ai

Then, follow the steps from "Requirements" and "Installation via `pip`" to
install JupyterLab and Jupyter AI in this Conda environment.
Then, use `conda` to install JupyterLab and Jupyter AI in this Conda environment.

$ conda install -c conda-forge jupyter-ai # or,
$ conda install conda-forge::jupyter-ai

When starting JupyterLab with Jupyter AI, make sure to activate the Conda
environment first:
Expand All @@ -108,13 +109,21 @@ jupyter lab

## Uninstallation

To remove the extension, run:
If you installed Jupyter AI using `pip`, to remove the extension, run:

$ pip uninstall jupyter-ai

or

$ pip uninstall jupyter-ai-magics

If you installed Jupyter AI using `conda`, you can remove it by running:

$ pip uninstall jupyter_ai
$ conda remove jupyter-ai

or

$ pip uninstall jupyter_ai_magics
$ conda remove jupyter-ai-magics

## Model providers

Expand Down
Loading