Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update compas_demo.html #133

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update compas_demo.html #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/examples/compas_demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1544,8 +1544,8 @@ <h2><em>Aequitas Bias() Class</em><a class="headerlink" href="#Aequitas-Bias()-C
</div><p>Below, we use <strong>``get_disparity_predefined_groups()``</strong> which allows us to choose reference groups that clarify the output for the practitioner.</p>
<p>The Aequitas <code class="docutils literal notranslate"><span class="pre">Bias()</span></code> class includes two additional get disparity functions: <strong>``get_disparity_major_group()``</strong> and <strong>``get_disparity_min_metric()``</strong>, which automate base group selection based on sample majority (across each attribute) and minimum value for each calculated bias metric, respectively.</p>
<p>The <strong>``get_disparity_predefined_groups()``</strong> allows user to define a base group for each attribute, as illustrated below.</p>
<div class="section" id="Disparities-Calculated-Calcuated:">
<h3>Disparities Calculated Calcuated:<a class="headerlink" href="#Disparities-Calculated-Calcuated:" title="Permalink to this headline">¶</a></h3>
<div class="section" id="Disparities-Calculated:">
<h3>Disparities Calculated:<a class="headerlink" href="#Disparities-Calculated:" title="Permalink to this headline">¶</a></h3>
<table class="docutils align-center">
<colgroup>
<col style="width: 66%" />
Expand All @@ -1560,22 +1560,22 @@ <h3>Disparities Calculated Calcuated:<a class="headerlink" href="#Disparities-Ca
<tr class="row-even"><td><p>True Positive Rate Disparity</p></td>
<td><p>‘tpr_disprity’</p></td>
</tr>
<tr class="row-odd"><td><p>True Negative Rate</p></td>
<tr class="row-odd"><td><p>True Negative Rate Disparity</p></td>
<td><p>‘tnr_disparity’</p></td>
</tr>
<tr class="row-even"><td><p>False Omission Rate</p></td>
<tr class="row-even"><td><p>False Omission Rate Disparity</p></td>
<td><p>‘for_disparity’</p></td>
</tr>
<tr class="row-odd"><td><p>False Discovery Rate</p></td>
<tr class="row-odd"><td><p>False Discovery Rate Disparity</p></td>
<td><p>‘fdr_disparity’</p></td>
</tr>
<tr class="row-even"><td><p>False Positive Rate</p></td>
<tr class="row-even"><td><p>False Positive Rate Disparity</p></td>
<td><p>‘fpr_disparity’</p></td>
</tr>
<tr class="row-odd"><td><p>False NegativeRate</p></td>
<tr class="row-odd"><td><p>False NegativeRate Disparity</p></td>
<td><p>‘fnr_disparity’</p></td>
</tr>
<tr class="row-even"><td><p>Negative Predictive Value</p></td>
<tr class="row-even"><td><p>Negative Predictive Value Disparity</p></td>
<td><p>‘npv_disparity’</p></td>
</tr>
<tr class="row-odd"><td><p>Precision Disparity</p></td>
Expand Down Expand Up @@ -5620,4 +5620,4 @@ <h1>The Aequitas Effect<a class="headerlink" href="#The-Aequitas-Effect" title="


</body>
</html>
</html>