Merge pull request #40 from ruivieira/RHOAIENG-1861

RHOAIENG-1861: Add detoxification example notebook

Author: ruivieira

.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

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]`.

examples/Detoxify.ipynb

@@ -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