.. FairSeldonian Project documentation master file, created by
   sphinx-quickstart on Tue Nov 17 18:50:48 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to FairSeldonian Project!
=======================================

With the growing usage of machine learning and artificial intelligence in real lives, 
the need for incorporating the mitigation of unethical and unfair elements in machine 
learning models is rising at an alarming rate. 
This requires us to develop a tool to evaluate and mitigate unfairness in these models 
that would help data scientists in dealing with such problems in the models they develop.

Fair-Seldonian leverages Seldonian algorithm to tackles this problem where the responsibility 
of regulating the undesirable behavior of machine learning algorithms and making them `fair' 
is transferred from user to designer of the algorithm (i.e. at the creation step itself by ML 
researcher). 
This is implemented for fairness in machine learning for any generic constraint.
In addition, some extensions for optimizing the bounds and making it more efficient
are also present.

More details of Seldonian is present `here <https://aisafety.cs.umass.edu>`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   intro
   quickstart
   variants
   code