Documentation

Author: eustomaqua

docs/posts/configuration.rst

@@ -9,7 +9,7 @@ Set up the environment
 ..   :linenos:
 
 
-We developed `ApproxBias <https://github.com/eustomaqua/ApproxBias>`_, `FairML <https://github.com/eustomaqua/FairML>`_, and `PyFairness <https://github.com/eustomaqua/PyFairness>`_ with ``Python 3.8`` and released the code to help you reproduce our work. Note that the experimental parts must be run on the ``Ubuntu`` operating system due to FairGBM (one baseline method that we used for comparison).
+We developed `ApproxBias <https://github.com/eustomaqua/ApproxBias>`_, `FairML <https://github.com/eustomaqua/FairML>`_, `PyFairness <https://github.com/eustomaqua/PyFairness>`_, and `AssessBias <https://github.com/eustomaqua/AssessBias>`_ with ``Python 3.8`` and released the code to help you reproduce our work. Note that the experimental parts must be run on the ``Ubuntu`` operating system due to FairGBM (one baseline method that we used for comparison).
 
 
 Initialization
@@ -68,6 +68,7 @@ Configuration via Docker
 .. code-block:: console
 
   $ exit
+  $
   $ docker ps -a                  # docker container ps|list
   $ docker rm <container-id>
   $ docker image rm <image-name>  # docker rmi <image-id>

docs/posts/quickstart.rst

@@ -39,7 +39,7 @@ If you would like to install `PyFairness <https://github.com/eustomaqua/PyFairne
   $ # Two ways to install (& uninstall) PyFairness
   $ git clone git@github.com:eustomaqua/PyFairness.git
   $
-  $ pip install -r PyFairness/reqs_py311.txt
+  $ # pip install -r PyFairness/reqs_py311.txt
   $ pip install -e ./PyFairness
   $ # pip uninstall pyfair
   $

requirements.txt

@@ -10,5 +10,5 @@ seaborn==0.13.2
 openpyxl==3.1.5
 lightgbm==4.6.0
 fairgbm==0.9.14
-torch==2.3.1
+torch==2.4.1
 carbontracker==2.3.1