Browse Source

Added extra for auditnlg

Matthias Reso 1 year ago
parent
commit
6dd58b9b88
2 changed files with 7 additions and 1 deletions
  1. 6 1
      README.md
  2. 1 0
      pyproject.toml

+ 6 - 1
README.md

@@ -36,7 +36,7 @@ pip install -U pip setuptools
 pip install --extra-index-url https://download.pytorch.org/whl/test/cu118 -e .
 ```
 ## Install with optional dependencies
-LLama-recipes offers the installation of optional packages. There are two optional dependenciy groups.
+LLama-recipes offers the installation of optional packages. There are three optional dependenciy groups.
 To run the unit tests we can install the required dependencies with:
 ```
 pip install --extra-index-url https://download.pytorch.org/whl/test/cu118 llama-recipes[tests]
@@ -45,6 +45,11 @@ For the vllm example we need additional requirements that can be installed with:
 ```
 pip install --extra-index-url https://download.pytorch.org/whl/test/cu118 llama-recipes[vllm]
 ```
+To use the sensitive topics safety checker install with:
+```
+pip install --extra-index-url https://download.pytorch.org/whl/test/cu118 llama-recipes[auditnlg]
+```
+Optional dependencies can also be combines with [option1,option2].
 
 ⚠️ **Note** ⚠️  Some features (especially fine-tuning with FSDP + PEFT) currently require PyTorch nightlies to be installed. Please make sure to install the nightlies if you're using these features following [this guide](https://pytorch.org/get-started/locally/).
 

+ 1 - 0
pyproject.toml

@@ -23,6 +23,7 @@ dynamic = ["dependencies"]
 [project.optional-dependencies]
 vllm = ["vllm"]
 tests = ["pytest-mock"]
+auditnlg = ["auditnlg"]
 
 [project.urls]
 "Homepage" = "https://github.com/facebookresearch/llama-recipes/"