From 9f21a60d1556a93c899b5ba354147f1bed9bef3f Mon Sep 17 00:00:00 2001 From: Sanjiv Das Date: Mon, 4 Nov 2024 10:46:40 -0800 Subject: [PATCH 1/6] Updated documentation to include installation of provider packages --- README.md | 31 +++++++++++++++++++++++++++++++ docs/source/users/index.md | 31 ++++++++++++++++++++++++++++++- 2 files changed, 61 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e624d2a86..9391be5a6 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,31 @@ If you are not using JupyterLab and you only want to install the Jupyter AI `%%a $ pip install jupyter-ai-magics +You may need to install third-party packages, for example, to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run + +``` +pip install langchain-openai +``` + +To use models from Anthropic, install: + +``` +pip install langchain-anthropic +``` + +After these installs you should see the OpenAI and Anthropic models in the drop down list. If you are using Claude models on AWS Bedrock, you must also install + +``` +pip install langchain-aws +``` + +Similarly, install `langchain-` packages for other providers as well, listed [here](#model-providers). + +To handle all supported use cases, you can install every dependency, which will give you access to all models currently supported by `jupyter-ai`. To install every dependency, run the following command, and then restart JupyterLab: + +``` +pip install jupyter-ai[all] +``` ### With conda @@ -73,6 +98,12 @@ 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 +In addition, install third-party `langchain-` packages, to use some model providers. For example, if you are using OpenAI models: + +``` +conda install conda-forge::langchain-openai +``` + ## The `%%ai` magic command The `%%ai` magic works anywhere the IPython kernel runs, including JupyterLab, Jupyter Notebook, Google Colab, and Visual Studio Code. diff --git a/docs/source/users/index.md b/docs/source/users/index.md index fd805a076..f474c8039 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -87,7 +87,27 @@ To install the JupyterLab extension, you can run: pip install jupyter-ai ``` -You may need to install third-party packages, for example, to use some model providers and some file formats with Jupyter AI. To handle all supported use cases, you can install every dependency, which will give you access to all models currently supported by `jupyter-ai`. To install every dependency, run the following command, and then restart JupyterLab: +You may need to install third-party packages, for example, to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run + +``` +pip install langchain-openai +``` + +To use models from Anthropic, install: + +``` +pip install langchain-anthropic +``` + +After these installs you should see the OpenAI and Anthropic models in the drop down list. If you are using Claude models on AWS Bedrock, you must also install + +``` +pip install langchain-aws +``` + +Similarly, install `langchain-` packages for other providers as well, listed [here](#model-providers). + +To handle all supported use cases, you can install every dependency, which will give you access to all models currently supported by `jupyter-ai`. To install every dependency, run the following command, and then restart JupyterLab: ``` pip install jupyter-ai[all] @@ -135,6 +155,15 @@ conda activate jupyter-ai jupyter lab ``` +In addition, install third-party `langchain-` packages, to use some model providers. For example, if you are using OpenAI models: + +``` +conda install conda-forge::langchain-openai +``` + +The list of providers and related python packages is listed [here](#model-providers). + + ## Uninstallation If you installed Jupyter AI using `pip`, to remove the extension, run: From 7e884948fb6c35d588d4031bddd5d343b7735a58 Mon Sep 17 00:00:00 2001 From: Sanjiv Das Date: Mon, 4 Nov 2024 10:50:40 -0800 Subject: [PATCH 2/6] Fixed trailing whitespace in doc update --- README.md | 2 +- docs/source/users/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9391be5a6..0461d2b23 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ You may need to install third-party packages, for example, to use some model pro pip install langchain-openai ``` -To use models from Anthropic, install: +To use models from Anthropic, install: ``` pip install langchain-anthropic diff --git a/docs/source/users/index.md b/docs/source/users/index.md index f474c8039..925e17fd0 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -93,7 +93,7 @@ You may need to install third-party packages, for example, to use some model pro pip install langchain-openai ``` -To use models from Anthropic, install: +To use models from Anthropic, install: ``` pip install langchain-anthropic From 5de7c5a73f4c7bd556f0e9716f873f353181bdd4 Mon Sep 17 00:00:00 2001 From: Sanjiv Das Date: Mon, 4 Nov 2024 14:50:53 -0800 Subject: [PATCH 3/6] Updated README and User Docs for Installtion instructions --- README.md | 32 ++++++++++++++++++------- docs/source/users/index.md | 49 +++++++++++++++++++------------------- 2 files changed, 47 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 0461d2b23..257ed3689 100644 --- a/README.md +++ b/README.md @@ -53,17 +53,21 @@ Below is a simplified overview of the installation and usage process. See [our official documentation](https://jupyter-ai.readthedocs.io/en/latest/users/index.html) for details on installing and using Jupyter AI. -### With pip +### Quick installation via `pip` (recommended) If you want to install both the `%%ai` magic and the JupyterLab extension, you can run: - $ pip install jupyter-ai + $ pip install jupyter-ai[all] + +Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `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[all] + +`jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai` automatically installs `jupyter-ai-magics`. -You may need to install third-party packages, for example, to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run +If you do not run install with the `[all]` option, you may need to install third-party packages to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run ``` pip install langchain-openai @@ -81,12 +85,18 @@ After these installs you should see the OpenAI and Anthropic models in the drop pip install langchain-aws ``` -Similarly, install `langchain-` packages for other providers as well, listed [here](#model-providers). +Similarly, install `langchain-` packages for other providers as well. For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). + +### Minimal installation via `pip` (optional) + +Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These are called _provider dependencies_. Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be installed with or without any provider dependencies installed. -To handle all supported use cases, you can install every dependency, which will give you access to all models currently supported by `jupyter-ai`. To install every dependency, run the following command, and then restart JupyterLab: +If a provider requires a dependency that is not installed, its models are not listed in the user interface which allows you to select a language model. This offers a way for users to control which models are available in your Jupyter AI environment. + +For example, to install Jupyter AI with only added support for Anthropic models, run: ``` -pip install jupyter-ai[all] +pip install jupyter-ai langchain-anthropic ``` ### With conda @@ -98,12 +108,16 @@ 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 -In addition, install third-party `langchain-` packages, to use some model providers. For example, if you are using OpenAI models: +Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These provider dependencies are not installed by default when installing `jupyter-ai` from Conda Forge, and should be installed separately as needed. + +For example, to install Jupyter AI with support for OpenAI models, run: ``` -conda install conda-forge::langchain-openai +conda install conda-forge::jupyter-ai conda-forge::langchain-openai ``` +For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). + ## The `%%ai` magic command The `%%ai` magic works anywhere the IPython kernel runs, including JupyterLab, Jupyter Notebook, Google Colab, and Visual Studio Code. diff --git a/docs/source/users/index.md b/docs/source/users/index.md index 925e17fd0..ba0df3e4d 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -79,15 +79,22 @@ classes in their code. ## Installation -### Installation via `pip` +### Quick installation via `pip` (recommended) -To install the JupyterLab extension, you can run: +If you want to install both the `%%ai` magic and the JupyterLab extension, you can run: -``` -pip install jupyter-ai -``` + $ pip install jupyter-ai[all] + +Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `jupyter-ai`. + +If you are not using JupyterLab and you only want to install the Jupyter AI `%%ai` magic, you can run: -You may need to install third-party packages, for example, to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run + $ pip install jupyter-ai-magics[all] + +`jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai` +automatically installs `jupyter-ai-magics`. + +If you do not run install with the `[all]` option, you may need to install third-party packages to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run ``` pip install langchain-openai @@ -105,30 +112,20 @@ After these installs you should see the OpenAI and Anthropic models in the drop pip install langchain-aws ``` -Similarly, install `langchain-` packages for other providers as well, listed [here](#model-providers). +Similarly, install `langchain-` packages for other providers as well. For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). -To handle all supported use cases, you can install every dependency, which will give you access to all models currently supported by `jupyter-ai`. To install every dependency, run the following command, and then restart JupyterLab: +### Minimal installation via `pip` (optional) -``` -pip install jupyter-ai[all] -``` +Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These are called _provider dependencies_. Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be installed with or without any provider dependencies installed. -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: +If a provider requires a dependency that is not installed, its models are not listed in the user interface which allows you to select a language model. This offers a way for users to control which models are available in your Jupyter AI environment. -``` -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: +For example, to install Jupyter AI with only added support for Anthropic models, run: ``` -$ pip install jupyter-ai-magics +pip install jupyter-ai langchain-anthropic ``` -`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) We highly recommend installing both JupyterLab and Jupyter AI within an isolated @@ -155,13 +152,15 @@ conda activate jupyter-ai jupyter lab ``` -In addition, install third-party `langchain-` packages, to use some model providers. For example, if you are using OpenAI models: +Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These provider dependencies are not installed by default when installing `jupyter-ai` from Conda Forge, and should be installed separately as needed. + +For example, to install Jupyter AI with support for OpenAI models, run: ``` -conda install conda-forge::langchain-openai +conda install conda-forge::jupyter-ai conda-forge::langchain-openai ``` -The list of providers and related python packages is listed [here](#model-providers). +For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). ## Uninstallation From acbffe89cc476eda47dec5842fa91b5c57be9a95 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 4 Nov 2024 22:51:14 +0000 Subject: [PATCH 4/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 2 +- docs/source/users/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 257ed3689..03ea0de47 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ If you want to install both the `%%ai` magic and the JupyterLab extension, you c $ pip install jupyter-ai[all] -Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `jupyter-ai`. +Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `jupyter-ai`. If you are not using JupyterLab and you only want to install the Jupyter AI `%%ai` magic, you can run: diff --git a/docs/source/users/index.md b/docs/source/users/index.md index ba0df3e4d..e2ed6b6ab 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -85,7 +85,7 @@ If you want to install both the `%%ai` magic and the JupyterLab extension, you c $ pip install jupyter-ai[all] -Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `jupyter-ai`. +Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `jupyter-ai`. If you are not using JupyterLab and you only want to install the Jupyter AI `%%ai` magic, you can run: From a963fb60c8ba8c873856f83a83e795f0216b6be2 Mon Sep 17 00:00:00 2001 From: "David L. Qiu" Date: Tue, 5 Nov 2024 15:48:14 -0800 Subject: [PATCH 5/6] update documentation --- README.md | 65 ++++++++++++++----------- docs/source/users/index.md | 98 ++++++++++++++++++++------------------ 2 files changed, 89 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 03ea0de47..d238b5f7c 100644 --- a/README.md +++ b/README.md @@ -53,45 +53,48 @@ Below is a simplified overview of the installation and usage process. See [our official documentation](https://jupyter-ai.readthedocs.io/en/latest/users/index.html) for details on installing and using Jupyter AI. +We offer 3 different ways to install Jupyter AI. You can read through each +section to pick the installation method that works best for you. + +1. Quick installation via `pip` (recommended) +2. Minimal installation via `pip` +3. Minimal installation via `conda` + ### Quick installation via `pip` (recommended) If you want to install both the `%%ai` magic and the JupyterLab extension, you can run: $ pip install jupyter-ai[all] -Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `jupyter-ai`. +Then, restart JupyterLab. This will install every optional dependency, which +provides access to all models currently supported by `jupyter-ai`. -If you are not using JupyterLab and you only want to install the Jupyter AI `%%ai` magic, you can run: +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[all] -`jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai` automatically installs `jupyter-ai-magics`. - -If you do not run install with the `[all]` option, you may need to install third-party packages to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run - -``` -pip install langchain-openai -``` +`jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai` +automatically installs `jupyter-ai-magics`. -To use models from Anthropic, install: +### Minimal installation via `pip` -``` -pip install langchain-anthropic -``` +Most model providers in Jupyter AI require a specific dependency to be installed +before they are available for use. These are called _provider dependencies_. +Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be +installed with or without any provider dependencies installed. If a provider +requires a dependency that is not installed, its models are not listed in the +user interface which allows you to select a language model. -After these installs you should see the OpenAI and Anthropic models in the drop down list. If you are using Claude models on AWS Bedrock, you must also install +To perform a minimal installation via `pip` without any provider dependencies, +omit the `[all]` optional dependency group from the package name: ``` -pip install langchain-aws +pip install jupyter-ai ``` -Similarly, install `langchain-` packages for other providers as well. For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). - -### Minimal installation via `pip` (optional) - -Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These are called _provider dependencies_. Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be installed with or without any provider dependencies installed. - -If a provider requires a dependency that is not installed, its models are not listed in the user interface which allows you to select a language model. This offers a way for users to control which models are available in your Jupyter AI environment. +By selectively installing provider dependencies, you can control which models +are available in your Jupyter AI environment. For example, to install Jupyter AI with only added support for Anthropic models, run: @@ -99,24 +102,30 @@ For example, to install Jupyter AI with only added support for Anthropic models, pip install jupyter-ai langchain-anthropic ``` -### With conda +For more information on model providers and which dependencies they require, see +[the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). + +### Minimal installation via `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, using one of the following two commands: +from the `conda-forge` channel: - $ conda install -c conda-forge jupyter-ai # or, $ conda install conda-forge::jupyter-ai -Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These provider dependencies are not installed by default when installing `jupyter-ai` from Conda Forge, and should be installed separately as needed. +Most model providers in Jupyter AI require a specific _provider dependency_ to +be installed before they are available for use. Provider dependencies are +not installed when installing `jupyter-ai` from Conda Forge, and should be +installed separately as needed. -For example, to install Jupyter AI with support for OpenAI models, run: +For example, to install Jupyter AI with only added support for OpenAI models, run: ``` conda install conda-forge::jupyter-ai conda-forge::langchain-openai ``` -For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). +For more information on model providers and which dependencies they require, see +[the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). ## The `%%ai` magic command diff --git a/docs/source/users/index.md b/docs/source/users/index.md index e2ed6b6ab..f7a79e859 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -79,46 +79,64 @@ classes in their code. ## Installation +### Setup: creating a Jupyter AI environment (recommended) + +Before installing Jupyter AI, we highly recommend first creating a separate +Conda environment for Jupyter AI. This prevents the installation process from +clobbering Python packages in your existing Python environment. + +To do so, install +[conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) +and create an environment that uses Python 3.12 and the latest version of +JupyterLab: + + $ conda create -n jupyter-ai python=3.12 jupyterlab + $ conda activate jupyter-ai + +You can now choose how to install Jupyter AI. + +We offer 3 different ways to install Jupyter AI. You can read through each +section to pick the installation method that works best for you. + +1. Quick installation via `pip` (recommended) +2. Minimal installation via `pip` +3. Minimal installation via `conda` + ### Quick installation via `pip` (recommended) If you want to install both the `%%ai` magic and the JupyterLab extension, you can run: $ pip install jupyter-ai[all] -Then, restart JupyterLab. This will install every dependency, which will give you access to all models currently supported by `jupyter-ai`. +Then, restart JupyterLab. This will install every optional dependency, which +provides access to all models currently supported by `jupyter-ai`. -If you are not using JupyterLab and you only want to install the Jupyter AI `%%ai` magic, you can run: +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[all] `jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai` automatically installs `jupyter-ai-magics`. -If you do not run install with the `[all]` option, you may need to install third-party packages to use some model providers and some file formats with Jupyter AI. For example, to use OpenAI models, in addition to your current install also run +### Minimal installation via `pip` -``` -pip install langchain-openai -``` +Most model providers in Jupyter AI require a specific dependency to be installed +before they are available for use. These are called _provider dependencies_. +Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be +installed with or without any provider dependencies installed. If a provider +requires a dependency that is not installed, its models are not listed in the +user interface which allows you to select a language model. -To use models from Anthropic, install: +To perform a minimal installation via `pip` without any provider dependencies, +omit the `[all]` optional dependency group from the package name: ``` -pip install langchain-anthropic +pip install jupyter-ai ``` -After these installs you should see the OpenAI and Anthropic models in the drop down list. If you are using Claude models on AWS Bedrock, you must also install - -``` -pip install langchain-aws -``` - -Similarly, install `langchain-` packages for other providers as well. For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). - -### Minimal installation via `pip` (optional) - -Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These are called _provider dependencies_. Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be installed with or without any provider dependencies installed. - -If a provider requires a dependency that is not installed, its models are not listed in the user interface which allows you to select a language model. This offers a way for users to control which models are available in your Jupyter AI environment. +By selectively installing provider dependencies, you can control which models +are available in your Jupyter AI environment. For example, to install Jupyter AI with only added support for Anthropic models, run: @@ -126,42 +144,30 @@ For example, to install Jupyter AI with only added support for Anthropic models, pip install jupyter-ai langchain-anthropic ``` -### Installation via `pip` or `conda` in a Conda environment (recommended) +For more information on model providers and which dependencies they require, see +[the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). -We highly recommend installing both JupyterLab and Jupyter AI within an isolated -Conda environment to avoid clobbering Python packages in your existing Python -environment. +### Minimal installation via `conda` -First, install -[conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) -and create an environment that uses Python 3.12: - - $ conda create -n jupyter-ai python=3.12 - $ conda activate jupyter-ai +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: -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: - -``` -conda activate jupyter-ai -jupyter lab -``` - -Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These provider dependencies are not installed by default when installing `jupyter-ai` from Conda Forge, and should be installed separately as needed. +Most model providers in Jupyter AI require a specific _provider dependency_ to +be installed before they are available for use. Provider dependencies are +not installed when installing `jupyter-ai` from Conda Forge, and should be +installed separately as needed. -For example, to install Jupyter AI with support for OpenAI models, run: +For example, to install Jupyter AI with only added support for OpenAI models, run: ``` conda install conda-forge::jupyter-ai conda-forge::langchain-openai ``` -For more information on model providers and which dependencies they require, see [the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). - +For more information on model providers and which dependencies they require, see +[the model provider table](https://jupyter-ai.readthedocs.io/en/latest/users/index.html#model-providers). ## Uninstallation From 0ca80ad33dfd1f6d86852af371cfffb7450a4c2b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 5 Nov 2024 23:48:26 +0000 Subject: [PATCH 6/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 2 +- docs/source/users/index.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d238b5f7c..24351410e 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ before they are available for use. These are called _provider dependencies_. Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be installed with or without any provider dependencies installed. If a provider requires a dependency that is not installed, its models are not listed in the -user interface which allows you to select a language model. +user interface which allows you to select a language model. To perform a minimal installation via `pip` without any provider dependencies, omit the `[all]` optional dependency group from the package name: diff --git a/docs/source/users/index.md b/docs/source/users/index.md index f7a79e859..f4505805a 100644 --- a/docs/source/users/index.md +++ b/docs/source/users/index.md @@ -119,14 +119,14 @@ If you are not using JupyterLab and you only want to install the Jupyter AI `jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai` automatically installs `jupyter-ai-magics`. -### Minimal installation via `pip` +### Minimal installation via `pip` Most model providers in Jupyter AI require a specific dependency to be installed before they are available for use. These are called _provider dependencies_. Provider dependencies are optional to Jupyter AI, meaning that Jupyter AI can be installed with or without any provider dependencies installed. If a provider requires a dependency that is not installed, its models are not listed in the -user interface which allows you to select a language model. +user interface which allows you to select a language model. To perform a minimal installation via `pip` without any provider dependencies, omit the `[all]` optional dependency group from the package name: