Add report user guide notebook (#589)

* Add report user guide notebook * add report user guide to documents * Add formatting fixes * Add examples and figures * Fix images * Rephrase introduction * fix formatting * Fix * Remove gifs * Remove gifs * fix ruff error * Fix typo * Add figure for slicing * Fix idna version to address vulnerability * Move images to wiki assets, improve user guide text * Fix user guide text --------- Co-authored-by: Amrit Krishnan <amrit110@gmail.com> Co-authored-by: Amrit K <amritk@vectorinstitute.ai>
VectorInstitute · Apr 25, 2024 · 47cff2a · 47cff2a
1 parent 13e1b71
commit 47cff2a
Show file tree

Hide file tree

Showing 5 changed files with 1,053 additions and 5 deletions.
diff --git a/docs/source/evaluation.rst b/docs/source/evaluation.rst
@@ -1,13 +1,21 @@
 Evaluation
 ==========
 
-The Evaluation API equips you with a rich toolbox to assess your models across key dimensions. Dive into detailed performance metrics, unveil potential fairness concerns, and gain granular insights through data slicing.
+The Evaluation API equips you with a rich toolbox to assess your models across key
+dimensions. Dive into detailed performance metrics, unveil potential fairness
+concerns, and gain granular insights through data slicing.
 
 Key capabilities:
 
-    * Performance: Employ a robust selection of common metrics to evaluate your model's effectiveness and identify areas for improvement.
-    * Fairness: Uncover and analyze potential biases within your model to ensure responsible and equitable outcomes.
-    * Data slicing: Isolate the model's behavior on specific subsets of your data, revealing performance nuances across demographics, features, or other important characteristics.
+    * Performance: Employ a robust selection of common metrics to evaluate your
+      model's effectiveness and identify areas for improvement.
+    * Fairness: Uncover and analyze potential biases within your model to ensure
+      responsible and equitable outcomes.
+    * Data slicing: Isolate the model's behavior on specific subsets of your
+      data, revealing performance nuances across demographics, features, or other
+      important characteristics.
+
+    .. image:: https://github.com/VectorInstitute/cyclops/assets/8986523/416170db-1265-42a3-a3c1-d34558b72b65
 
 Follow the example below for the instructions: