Update documentation to cover installation of all dependencies #961
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
krassowski
reviewed
Aug 19, 2024
…/jupyter-ai into installation_documentation
JasonWeill
reviewed
Aug 19, 2024
docs/source/users/index.md
Outdated
| @@ -87,6 +87,12 @@ To install the JupyterLab extension, you can run: | |||
| pip install jupyter-ai | |||
| ``` | |||
|
|
|||
| In some cases, third-party packages need to be installed, for example, because they are required by some model providers and some file formats. To ensure such cases are handled you can install every dependency which will give you access to all models currently supported by `jupyter-ai`. To install every dependency, run (and then restart JupyterLab): | |||
There was a problem hiding this comment.
Suggested change
| In some cases, third-party packages need to be installed, for example, because they are required by some model providers and some file formats. To ensure such cases are handled you can install every dependency which will give you access to all models currently supported by `jupyter-ai`. To install every dependency, run (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. 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: |
JasonWeill
approved these changes
Aug 19, 2024
Marchlak
pushed a commit
to Marchlak/jupyter-ai
that referenced
this pull request
Oct 28, 2024
…erlab#961) * Update documentation to cover installation of all dependencies * Update documentation * update documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue #958
Based also on https://discourse.jupyter.org/t/missing-some-providers-in-jupyter-ai/27600
Added documentation to direct users to install all dependencies, the updated install instruction section is as follows:
