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

docs(installation): update optional dependencies install #853

Merged
merged 2 commits into from
Nov 12, 2024
Merged

docs(installation): update optional dependencies install #853

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4a1a34
docs(installation): update optional dependencies install
Pouyanpi Nov 12, 2024
3ed0629
fix(docs): update pip install instructions note
Pouyanpi Nov 12, 2024
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
15 changes: 4 additions & 11 deletions docs/getting_started/installation-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,21 +103,14 @@ To keep the footprint of `nemoguardrails` as small as possible, these are not in
```

## Optional dependencies
>

> [!IMPORTANT]
> pip fails to resolve dependencies for **v0.10.0** and **v0.10.1**. We recommend using a `constraints.txt` file to ensure compatible versions of dependencies. This only concerns you when you want to install the `[all]` extra dependencies.
>
> **Example `constraints.txt`**:
>
> ```
> pandas>=1.4.0,<3
> ```
> If pip fails to resolve dependencies when running `pip install nemoguardrails[all]`, you should specify additional constraints directly in the `pip install` command.
>
> **Installation Instructions**:
> To install the package with the specified constraints, use the following command:
> **Example Command**:
>
> ```sh
> pip install "nemoguardrails[all]" -c constraints.txt
> pip install "nemoguardrails[all]" "pandas>=1.4.0,<3"
> ```

To use OpenAI, just use the `openai` extra dependency that ensures that all required packages are installed.
Expand Down