Getting started

Requirements

We may test the code on different environments, and in that case, please choose the corresponding Python packages.

$ # Install anaconda/miniconda if you didn't
$
$ # To create a virtual environment
$ conda create -n ensem python=3.8
$ conda env list
$ source activate ensem
$
$ # To install packages
$ pip list && cd ~/FairML
$ pip install -U pip
$ pip install -r requirements.txt
$ python -m pytest
$
$ # To delete the virtual environment
$ conda deactivate && cd ..
$ yes | rm -r FairML
$ conda remove -n ensem --all

If you would like to install PyFairness, please do the following.

$ # Two ways to install (& uninstall) PyFairness
$ git clone git@github.com:eustomaqua/PyFairness.git
$
$ # pip install -r PyFairness/reqs_py311.txt
$ pip install -e ./PyFairness
$ # pip uninstall pyfair
$
$ cp -r ./PyFairness/pyfair ./    # mv <folder> ./
$ yes | rm -r PyFairness
$ # rm -r pyfair