Merge pull request #40 from ruivieira/RHOAIENG-1861

RHOAIENG-1861: Add detoxification example notebook
trustyai-explainability · Feb 2, 2024 · 4ebfb6a · 4ebfb6a
2 parents ab9ed19 + db56214
commit 4ebfb6a
Show file tree

Hide file tree

Showing 4 changed files with 513 additions and 4 deletions.
diff --git a/.github/workflows/notebooks.yml b/.github/workflows/notebooks.yml
@@ -32,7 +32,7 @@ jobs:
       run: pip install jupyter
 
     - name: Install TrustyAI
-      run: pip install trustyai trustyai[extras]
+      run: pip install trustyai trustyai[extras] trustyai[detoxify]
 
 
     - name: Install nbconvert

diff --git a/README.md b/README.md
@@ -24,6 +24,9 @@ Several example Jupyter notebooks are available.
   - Full examples
     - [Energy load forecasting](examples/EnergyLoadForecasting.ipynb)[^1]
     - [Engine fault detection](examples/EngineFaultDetection.ipynb)[^1]
+- Detoxification
+    - [LLM detoxification using TMaRCo](examples/Detoxify.ipynb)[^2]
+
 
 ### Metrics
 
@@ -33,4 +36,5 @@ Several example Jupyter notebooks are available.
   - [Language performance](examples/LanguageMetrics.ipynb)
 
 
-[^1]: These explainers require the extra dependencies, installed with `pip install trustyai[extras]`.
+[^1]: These explainers require the extra dependencies, installed with `pip install trustyai[extras]`.
+[^2]: Detoxification requires the optional dependencies, installed with `pip install trustyai[detoxify]`.
diff --git a/examples/Detoxify.ipynb b/examples/Detoxify.ipynb
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
-trustyai==0.4.0
-trustyai[extras]==0.4.0
+trustyai==0.5.0
+trustyai[extras]==0.5.0
 jupyterlab~=3.5.3