updated documentation to include fairness loss function.

saist1993 · Sep 12, 2022 · cbaa4dd · cbaa4dd
1 parent 48e84f9
commit cbaa4dd
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -49,6 +49,10 @@ for inputs, labels, protected_attributes in train_iterator:
     optimizer.step()
 ```
 
+
+We highly recommend to **standardize features** by removing the mean and scaling to unit variance.
+This can be done using standard scalar module in sklearn.
+
 # Citation
 ```
 @article{maheshwari2022fairgrad,

diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -51,6 +51,9 @@ Below is a simple example::
 
 For complete worked out example refer to example folder on github.
 
+We highly recommend to **standardize features** by removing the mean and scaling to unit variance.
+This can be done using standard scalar module in sklearn.
+
 Citation
 -------------
 

diff --git a/docs/source/reference.rst b/docs/source/reference.rst
@@ -7,3 +7,4 @@ Reference
 
    reference/fairness_function.rst
    reference/torch/cross_entropy.rst
+   reference/torch/fairness_loss.rst
diff --git a/docs/source/reference/torch/fairness_loss.rst b/docs/source/reference/torch/fairness_loss.rst
@@ -0,0 +1,4 @@
+fairgrad.torch.fairness_loss
+=============================
+.. automodule:: fairgrad.torch.fairness_loss
+    :members:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,4 @@ Reference

		reference/fairness_function.rst
		reference/torch/cross_entropy.rst
		reference/torch/fairness_loss.rst