Updated documentation

DataResponsibly · Jan 29, 2024 · d605e6b · d605e6b
1 parent 4d5bf86
commit d605e6b
Show file tree

Hide file tree

Showing 22 changed files with 4,479 additions and 38 deletions.
diff --git a/docs/api/custom-classes/MetricsComposer.md b/docs/api/custom-classes/MetricsComposer.md
@@ -1,6 +1,6 @@
 # MetricsComposer
 
-Metric Composer class that combines different subgroup metrics to create disparity metrics  such as 'Disparate_Impact' or 'Accuracy_Parity'.
+Metric Composer class that combines different subgroup metrics to create disparity metrics  such as 'Disparate_Impact' or 'Accuracy_Difference'.
 
 Definitions of the disparity metrics could be observed in the __init__ method of the Metric Composer:  https://github.com/DataResponsibly/Virny/blob/main/virny/custom_classes/metrics_composer.py
 

diff --git a/docs/api/datasets/CreditCardDefaultDataset.md b/docs/api/datasets/CreditCardDefaultDataset.md
@@ -1,6 +1,6 @@
 # CreditCardDefaultDataset
 
-Dataset class for the Credit Card dataset that contains sensitive attributes among feature columns. Description: https://arxiv.org/pdf/2110.00530.pdf (Section 3.1.6)
+Dataset class for the Credit Card Default dataset that contains sensitive attributes among feature columns. Description: https://arxiv.org/pdf/2110.00530.pdf (Section 3.1.6)
 
 
 

diff --git a/docs/api/datasets/StudentPerformancePortugueseDataset.md b/docs/api/datasets/StudentPerformancePortugueseDataset.md
@@ -0,0 +1,19 @@
+# StudentPerformancePortugueseDataset
+
+Dataset class for the Student Performance Portuguese dataset that contains sensitive attributes among feature columns. Source: https://github.com/tailequy/fairness_dataset/blob/main/experiments/data/student_por_new.csv Description: https://arxiv.org/pdf/2110.00530.pdf (Section 3.4.1)
+
+
+
+## Parameters
+
+- **subsample_size** (*int*) – defaults to `None`
+
+    Subsample size to create based on the input dataset
+
+- **subsample_seed** (*int*) – defaults to `None`
+
+    Seed for sampling using the sample() method from pandas
+
+
+
+
diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -55,6 +55,7 @@ The purpose is to provide sample datasets for functionality testing and show exa
 - [DiabetesDataset](../datasets/DiabetesDataset)
 - [LawSchoolDataset](../datasets/LawSchoolDataset)
 - [RicciDataset](../datasets/RicciDataset)
+- [StudentPerformancePortugueseDataset](../datasets/StudentPerformancePortugueseDataset)
 
 ## metrics
 

diff --git a/docs/examples/.pages b/docs/examples/.pages
@@ -1,8 +1,9 @@
 title: Examples 🍱
 nav:
     - Multiple_Models_Interface_Use_Case.md
+    - Interactive_Web_App_Demo.md
     - Multiple_Models_Interface_With_DB_Writer.md
     - Multiple_Models_Interface_With_Error_Analysis.md
     - Multiple_Models_Interface_With_Multiple_Test_Sets.md
+    - Multiple_Models_Interface_With_Inprocessor.md
     - Multiple_Models_Interface_With_Postprocessor.md
-    - Interactive_Web_App_Demo.md