Skip to content

Commit

Permalink
Updates to favor hyphens in pip commands
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonWeill committed Feb 2, 2024
1 parent 5ee3541 commit 0c21920
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 19 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,20 @@ 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
$ 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
26 changes: 10 additions & 16 deletions docs/source/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,24 +62,24 @@ 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` or `conda` in a Conda environment (recommended)

Expand All @@ -97,13 +97,10 @@ and create an environment that uses Python 3.11:
Then, use either `pip` or `conda` to install JupyterLab and Jupyter AI in this
Conda environment.

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

Note that the `pip` package name is `jupyter_ai` with an underscore, and that
the `conda` package name is `jupyter-ai` with a hyphen.

When starting JupyterLab with Jupyter AI, make sure to activate the Conda
environment first:

Expand All @@ -116,11 +113,11 @@ jupyter lab

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

$ pip uninstall jupyter_ai
$ pip uninstall jupyter-ai

or

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

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

Expand All @@ -130,9 +127,6 @@ or

$ conda remove jupyter-ai-magics

Note that the `pip` package names use underscores, and the `conda` package
names use hyphens.

## Model providers

Jupyter AI supports a wide range of model providers and models. To use Jupyter AI with a particular provider, you must install its Python packages and set its API key (or other credentials) in your environment or in the chat interface.
Expand Down

0 comments on commit 0c21920

Please sign in to comment.