Skip to content

Commit

Permalink
Docs: installation guide improvement.
Browse files Browse the repository at this point in the history
  • Loading branch information
drazvan committed Nov 29, 2023
1 parent b27301b commit 16fb505
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/getting_started/installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,20 @@ For each feature or LLM example, check the readme files associated with it.

## Extra dependencies

The following extra dependencies are defined:
The `nemoguardrails` package also defines the following extra dependencies:

- `dev`: packages required by some extra Guardrails features for developers (e.g. autoreload feature).
- `eval`: packages used for the Guardrails [evaluation tools](../../nemoguardrails/eval/README.md).
- `openai`: installs the latest `openai` package supported by NeMo Guardrails.
- `sdd`: packages used by the [sensitive data detector](../user_guides/guardrails-library.md#sensitive-data-detection) integrated in NeMo Guardrails.
- `all`: installs all extra packages.

To keep the footprint of `nemoguardrails` as small as possible, these are not installed by default. To install any of the extra dependency you can use `pip` as well. For example, to install the `dev` extra dependencies, run the following command:

```bash
> pip install nemoguardrails[dev]
```

## What's next?

* Check out the [Getting Started Guide](../getting_started) and start with the ["Hello World" example](../getting_started/1_hello_world).
Expand Down

0 comments on commit 16fb505

Please sign in to comment.