Merge pull request #100 from zeya30/docsite-update

Docsite update
cvs-health · Jan 13, 2025 · ac731db · ac731db
2 parents 74966e6 + a6be5ef
commit ac731db
Show file tree

Hide file tree

Showing 125 changed files with 222 additions and 55 deletions.
diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 259f0daeeb0c99778d9a9bb1e10c103a
+config: d0962c459949a91fb59466a018c3575f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/latest/.doctrees/_autosummary/langfair.auto.auto.AutoEval.doctree b/docs/latest/.doctrees/_autosummary/langfair.auto.auto.AutoEval.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.auto.auto.doctree b/docs/latest/.doctrees/_autosummary/langfair.auto.auto.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.auto.doctree b/docs/latest/.doctrees/_autosummary/langfair.auto.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.constants.doctree b/docs/latest/.doctrees/_autosummary/langfair.constants.doctree
diff --git a/.../.doctrees/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.doctree b/.../.doctrees/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.generator.counterfactual.doctree b/docs/latest/.doctrees/_autosummary/langfair.generator.counterfactual.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.generator.doctree b/docs/latest/.doctrees/_autosummary/langfair.generator.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.generator.generator.ResponseGenerator.doctree b/docs/latest/.doctrees/_autosummary/langfair.generator.generator.ResponseGenerator.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.generator.generator.doctree b/docs/latest/.doctrees/_autosummary/langfair.generator.generator.doctree
diff --git a/..._autosummary/langfair.metrics.classification.classification.ClassificationMetrics.doctree b/..._autosummary/langfair.metrics.classification.classification.ClassificationMetrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.classification.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.classification.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.metrics.baseclass.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.metrics.baseclass.doctree
diff --git a/...ees/_autosummary/langfair.metrics.classification.metrics.baseclass.metrics.Metric.doctree b/...ees/_autosummary/langfair.metrics.classification.metrics.baseclass.metrics.Metric.doctree
diff --git a/.../.doctrees/_autosummary/langfair.metrics.classification.metrics.baseclass.metrics.doctree b/.../.doctrees/_autosummary/langfair.metrics.classification.metrics.baseclass.metrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.metrics.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.classification.metrics.doctree
diff --git a/.../langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.doctree b/.../langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.doctree
diff --git a/...st/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_discovery.doctree b/...st/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_discovery.doctree
diff --git a/...ry/langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.doctree b/...ry/langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.doctree
diff --git a/...est/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_negative.doctree b/...est/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_negative.doctree
diff --git a/...ry/langfair.metrics.classification.metrics.false_omission.FalseOmissionRateParity.doctree b/...ry/langfair.metrics.classification.metrics.false_omission.FalseOmissionRateParity.doctree
diff --git a/...est/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_omission.doctree b/...est/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_omission.doctree
diff --git a/...ry/langfair.metrics.classification.metrics.false_positive.FalsePositiveRateParity.doctree b/...ry/langfair.metrics.classification.metrics.false_positive.FalsePositiveRateParity.doctree
diff --git a/...est/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_positive.doctree b/...est/.doctrees/_autosummary/langfair.metrics.classification.metrics.false_positive.doctree
diff --git a/...metrics.classification.metrics.predicted_prevalence.PredictedPrevalenceRateParity.doctree b/...metrics.classification.metrics.predicted_prevalence.PredictedPrevalenceRateParity.doctree
diff --git a/...octrees/_autosummary/langfair.metrics.classification.metrics.predicted_prevalence.doctree b/...octrees/_autosummary/langfair.metrics.classification.metrics.predicted_prevalence.doctree
diff --git a/..._autosummary/langfair.metrics.counterfactual.counterfactual.CounterfactualMetrics.doctree b/..._autosummary/langfair.metrics.counterfactual.counterfactual.CounterfactualMetrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.counterfactual.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.counterfactual.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.baseclass.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.baseclass.doctree
diff --git a/...ees/_autosummary/langfair.metrics.counterfactual.metrics.baseclass.metrics.Metric.doctree b/...ees/_autosummary/langfair.metrics.counterfactual.metrics.baseclass.metrics.Metric.doctree
diff --git a/.../.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.baseclass.metrics.doctree b/.../.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.baseclass.metrics.doctree
diff --git a/...doctrees/_autosummary/langfair.metrics.counterfactual.metrics.bleu.BleuSimilarity.doctree b/...doctrees/_autosummary/langfair.metrics.counterfactual.metrics.bleu.BleuSimilarity.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.bleu.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.bleu.doctree
diff --git a/...rees/_autosummary/langfair.metrics.counterfactual.metrics.cosine.CosineSimilarity.doctree b/...rees/_autosummary/langfair.metrics.counterfactual.metrics.cosine.CosineSimilarity.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.cosine.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.cosine.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.doctree
diff --git a/...rees/_autosummary/langfair.metrics.counterfactual.metrics.rougel.RougelSimilarity.doctree b/...rees/_autosummary/langfair.metrics.counterfactual.metrics.rougel.RougelSimilarity.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.rougel.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.rougel.doctree
diff --git a/.../_autosummary/langfair.metrics.counterfactual.metrics.sentimentbias.SentimentBias.doctree b/.../_autosummary/langfair.metrics.counterfactual.metrics.sentimentbias.SentimentBias.doctree
diff --git a/...test/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.sentimentbias.doctree b/...test/.doctrees/_autosummary/langfair.metrics.counterfactual.metrics.sentimentbias.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.baseclass.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.baseclass.doctree
diff --git a/...ees/_autosummary/langfair.metrics.recommendation.metrics.baseclass.metrics.Metric.doctree b/...ees/_autosummary/langfair.metrics.recommendation.metrics.baseclass.metrics.Metric.doctree
diff --git a/.../.doctrees/_autosummary/langfair.metrics.recommendation.metrics.baseclass.metrics.doctree b/.../.doctrees/_autosummary/langfair.metrics.recommendation.metrics.baseclass.metrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.doctree
diff --git a/...es/_autosummary/langfair.metrics.recommendation.metrics.jaccard.JaccardSimilarity.doctree b/...es/_autosummary/langfair.metrics.recommendation.metrics.jaccard.JaccardSimilarity.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.jaccard.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.jaccard.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.prag.PRAG.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.prag.PRAG.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.prag.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.prag.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.serp.SERP.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.serp.SERP.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.serp.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.metrics.serp.doctree
diff --git a/..._autosummary/langfair.metrics.recommendation.recommendation.RecommendationMetrics.doctree b/..._autosummary/langfair.metrics.recommendation.recommendation.RecommendationMetrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.recommendation.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.recommendation.recommendation.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.doctree
diff --git a/...ummary/langfair.metrics.stereotype.metrics.associations.StereotypicalAssociations.doctree b/...ummary/langfair.metrics.stereotype.metrics.associations.StereotypicalAssociations.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.associations.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.associations.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.baseclass.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.baseclass.doctree
diff --git a/...octrees/_autosummary/langfair.metrics.stereotype.metrics.baseclass.metrics.Metric.doctree b/...octrees/_autosummary/langfair.metrics.stereotype.metrics.baseclass.metrics.Metric.doctree
diff --git a/...test/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.baseclass.metrics.doctree b/...test/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.baseclass.metrics.doctree
diff --git a/.../_autosummary/langfair.metrics.stereotype.metrics.classifier.StereotypeClassifier.doctree b/.../_autosummary/langfair.metrics.stereotype.metrics.classifier.StereotypeClassifier.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.classifier.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.classifier.doctree
diff --git a/...tosummary/langfair.metrics.stereotype.metrics.cooccurrence.CooccurrenceBiasMetric.doctree b/...tosummary/langfair.metrics.stereotype.metrics.cooccurrence.CooccurrenceBiasMetric.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.cooccurrence.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.cooccurrence.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.metrics.doctree
diff --git a/...t/.doctrees/_autosummary/langfair.metrics.stereotype.stereotype.StereotypeMetrics.doctree b/...t/.doctrees/_autosummary/langfair.metrics.stereotype.stereotype.StereotypeMetrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.stereotype.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.stereotype.stereotype.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.toxicity.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.toxicity.doctree
diff --git a/.../latest/.doctrees/_autosummary/langfair.metrics.toxicity.toxicity.ToxicityMetrics.doctree b/.../latest/.doctrees/_autosummary/langfair.metrics.toxicity.toxicity.ToxicityMetrics.doctree
diff --git a/docs/latest/.doctrees/_autosummary/langfair.metrics.toxicity.toxicity.doctree b/docs/latest/.doctrees/_autosummary/langfair.metrics.toxicity.toxicity.doctree
diff --git a/docs/latest/.doctrees/api.doctree b/docs/latest/.doctrees/api.doctree
diff --git a/docs/latest/.doctrees/auto_examples/auto_eval_demo.doctree b/docs/latest/.doctrees/auto_examples/auto_eval_demo.doctree
diff --git a/docs/latest/.doctrees/auto_examples/counterfactual_metrics_demo.doctree b/docs/latest/.doctrees/auto_examples/counterfactual_metrics_demo.doctree
diff --git a/docs/latest/.doctrees/environment.pickle b/docs/latest/.doctrees/environment.pickle
diff --git a/docs/latest/.doctrees/guide.doctree b/docs/latest/.doctrees/guide.doctree
diff --git a/docs/latest/.doctrees/index.doctree b/docs/latest/.doctrees/index.doctree
diff --git a/docs/latest/.doctrees/usage.doctree b/docs/latest/.doctrees/usage.doctree
diff --git a/docs/latest/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.html b/docs/latest/_autosummary/langfair.generator.counterfactual.CounterfactualGenerator.html
@@ -704,18 +704,20 @@ <h1>langfair.generator.counterfactual.CounterfactualGenerator<a class="headerlin
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><p>A dictionary with two keys: ‘data’ and ‘metadata’.
-‘data’ : dict</p>
-<blockquote>
-<div><p>A dictionary containing the prompts and responses.</p>
-</div></blockquote>
+<dd class="field-even"><p><p>A dictionary with two keys: ‘data’ and ‘metadata’.</p>
 <dl>
-<dt>’metadata’<span class="classifier">dict</span></dt><dd><p>A dictionary containing metadata about the generation process.
-‘non_completion_rate’ : float</p>
-<blockquote>
-<div><p>The rate at which the generation process did not complete.</p>
-</div></blockquote>
+<dt>’data’<span class="classifier">dict</span></dt><dd><p>A dictionary containing the prompts and responses.</p>
+<dl class="simple">
+<dt>’prompt’<span class="classifier">list</span></dt><dd><p>A list of prompts.</p>
+</dd>
+<dt>’response’<span class="classifier">list</span></dt><dd><p>A list of responses corresponding to the prompts.</p>
+</dd>
+</dl>
+</dd>
+<dt>’metadata’<span class="classifier">dict</span></dt><dd><p>A dictionary containing metadata about the generation process.</p>
 <dl class="simple">
+<dt>’non_completion_rate’<span class="classifier">float</span></dt><dd><p>The rate at which the generation process did not complete.</p>
+</dd>
 <dt>’temperature’<span class="classifier">float</span></dt><dd><p>The temperature parameter used in the generation process.</p>
 </dd>
 <dt>’count’<span class="classifier">int</span></dt><dd><p>The count of prompts used in the generation process.</p>

diff --git a/docs/latest/_autosummary/langfair.generator.generator.ResponseGenerator.html b/docs/latest/_autosummary/langfair.generator.generator.ResponseGenerator.html
@@ -622,26 +622,20 @@ <h1>langfair.generator.generator.ResponseGenerator<a class="headerlink" href="#l
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><p>A dictionary with two keys: ‘data’ and ‘metadata’.
-‘data’ : dict</p>
-<blockquote>
-<div><p>A dictionary containing the prompts and responses.
-‘prompt’ : list</p>
-<blockquote>
-<div><p>A list of prompts.</p>
-</div></blockquote>
+<dd class="field-even"><p><p>A dictionary with two keys: ‘data’ and ‘metadata’.</p>
+<dl>
+<dt>’data’<span class="classifier">dict</span></dt><dd><p>A dictionary containing the prompts and responses.</p>
 <dl class="simple">
+<dt>’prompt’<span class="classifier">list</span></dt><dd><p>A list of prompts.</p>
+</dd>
 <dt>’response’<span class="classifier">list</span></dt><dd><p>A list of responses corresponding to the prompts.</p>
 </dd>
 </dl>
-</div></blockquote>
-<dl>
-<dt>’metadata’<span class="classifier">dict</span></dt><dd><p>A dictionary containing metadata about the generation process.
-‘non_completion_rate’ : float</p>
-<blockquote>
-<div><p>The rate at which the generation process did not complete.</p>
-</div></blockquote>
+</dd>
+<dt>’metadata’<span class="classifier">dict</span></dt><dd><p>A dictionary containing metadata about the generation process.</p>
 <dl class="simple">
+<dt>’non_completion_rate’<span class="classifier">float</span></dt><dd><p>The rate at which the generation process did not complete.</p>
+</dd>
 <dt>’temperature’<span class="classifier">float</span></dt><dd><p>The temperature parameter used in the generation process.</p>
 </dd>
 <dt>’count’<span class="classifier">int</span></dt><dd><p>The count of prompts used in the generation process.</p>

diff --git a/...latest/_autosummary/langfair.metrics.classification.metrics.baseclass.metrics.Metric.html b/...latest/_autosummary/langfair.metrics.classification.metrics.baseclass.metrics.Metric.html
@@ -569,15 +569,35 @@ <h1>langfair.metrics.classification.metrics.baseclass.metrics.Metric<a class="he
 <tr class="row-odd"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.__init__" title="langfair.metrics.classification.metrics.baseclass.metrics.Metric.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>()</p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary_confusion_matrix</span></code>(y_true, y_pred)</p></td>
-<td><p></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.binary_confusion_matrix" title="langfair.metrics.classification.metrics.baseclass.metrics.Metric.binary_confusion_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary_confusion_matrix</span></code></a>(y_true, y_pred)</p></td>
+<td><p>Method for computing binary confusion matrix</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.evaluate" title="langfair.metrics.classification.metrics.baseclass.metrics.Metric.evaluate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">evaluate</span></code></a>(groups, y_pred[, y_true, ratio])</p></td>
 <td><p>Abstract method that needs to be implemented by the user when creating a new metric function.</p></td>
 </tr>
 </tbody>
 </table>
 </div>
+<dl class="py method">
+<dt class="sig sig-object py" id="langfair.metrics.classification.metrics.baseclass.metrics.Metric.binary_confusion_matrix">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">binary_confusion_matrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y_true</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.binary_confusion_matrix" title="Link to this definition">#</a></dt>
+<dd><p>Method for computing binary confusion matrix</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>y_true</strong> (<em>Array-like</em>) – Binary labels (ground truth values)</p></li>
+<li><p><strong>y_pred</strong> (<em>Array-like</em>) – Binary model predictions</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>2x2 confusion matrix</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>List[List[float]]</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="langfair.metrics.classification.metrics.baseclass.metrics.Metric.evaluate">
 <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_true</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.evaluate" title="Link to this definition">#</a></dt>
@@ -642,6 +662,7 @@ <h1>langfair.metrics.classification.metrics.baseclass.metrics.Metric<a class="he
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric"><code class="docutils literal notranslate"><span class="pre">Metric</span></code></a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.__init__"><code class="docutils literal notranslate"><span class="pre">Metric.__init__()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.binary_confusion_matrix"><code class="docutils literal notranslate"><span class="pre">Metric.binary_confusion_matrix()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.baseclass.metrics.Metric.evaluate"><code class="docutils literal notranslate"><span class="pre">Metric.evaluate()</span></code></a></li>
 </ul>
 </li>

diff --git a/...ary/langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.html b/...ary/langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.html
@@ -567,15 +567,35 @@ <h1>langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRatePa
 <tr class="row-odd"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.__init__" title="langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>()</p></td>
 <td><p>This class computes false negative rate parity.</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary_confusion_matrix</span></code>(y_true, y_pred)</p></td>
-<td><p></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.binary_confusion_matrix" title="langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.binary_confusion_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary_confusion_matrix</span></code></a>(y_true, y_pred)</p></td>
+<td><p>Method for computing binary confusion matrix</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.evaluate" title="langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.evaluate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">evaluate</span></code></a>(groups, y_pred, y_true[, ratio])</p></td>
 <td><p>This method computes disparity in false negative rates between two groups.</p></td>
 </tr>
 </tbody>
 </table>
 </div>
+<dl class="py method">
+<dt class="sig sig-object py" id="langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.binary_confusion_matrix">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">binary_confusion_matrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y_true</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.binary_confusion_matrix" title="Link to this definition">#</a></dt>
+<dd><p>Method for computing binary confusion matrix</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>y_true</strong> (<em>Array-like</em>) – Binary labels (ground truth values)</p></li>
+<li><p><strong>y_pred</strong> (<em>Array-like</em>) – Binary model predictions</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>2x2 confusion matrix</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>List[List[float]]</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.evaluate">
 <span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_true</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.evaluate" title="Link to this definition">#</a></dt>
@@ -664,6 +684,7 @@ <h1>langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRatePa
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity"><code class="docutils literal notranslate"><span class="pre">FalseDiscoveryRateParity</span></code></a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.__init__"><code class="docutils literal notranslate"><span class="pre">FalseDiscoveryRateParity.__init__()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.binary_confusion_matrix"><code class="docutils literal notranslate"><span class="pre">FalseDiscoveryRateParity.binary_confusion_matrix()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_discovery.FalseDiscoveryRateParity.evaluate"><code class="docutils literal notranslate"><span class="pre">FalseDiscoveryRateParity.evaluate()</span></code></a></li>
 </ul>
 </li>

diff --git a/...mmary/langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.html b/...mmary/langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.html
@@ -567,15 +567,35 @@ <h1>langfair.metrics.classification.metrics.false_negative.FalseNegativeRatePari
 <tr class="row-odd"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.__init__" title="langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>()</p></td>
 <td><p>This class computes false negative rate parity.</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary_confusion_matrix</span></code>(y_true, y_pred)</p></td>
-<td><p></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.binary_confusion_matrix" title="langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.binary_confusion_matrix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binary_confusion_matrix</span></code></a>(y_true, y_pred)</p></td>
+<td><p>Method for computing binary confusion matrix</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.evaluate" title="langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.evaluate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">evaluate</span></code></a>(groups, y_pred, y_true[, ratio])</p></td>
 <td><p>This method computes disparity in false negative rates between two groups.</p></td>
 </tr>
 </tbody>
 </table>
 </div>
+<dl class="py method">
+<dt class="sig sig-object py" id="langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.binary_confusion_matrix">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">binary_confusion_matrix</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y_true</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.binary_confusion_matrix" title="Link to this definition">#</a></dt>
+<dd><p>Method for computing binary confusion matrix</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>y_true</strong> (<em>Array-like</em>) – Binary labels (ground truth values)</p></li>
+<li><p><strong>y_pred</strong> (<em>Array-like</em>) – Binary model predictions</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>2x2 confusion matrix</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>List[List[float]]</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.evaluate">
 <span class="sig-name descname"><span class="pre">evaluate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">groups</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_pred</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_true</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.evaluate" title="Link to this definition">#</a></dt>
@@ -664,6 +684,7 @@ <h1>langfair.metrics.classification.metrics.false_negative.FalseNegativeRatePari
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity"><code class="docutils literal notranslate"><span class="pre">FalseNegativeRateParity</span></code></a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.__init__"><code class="docutils literal notranslate"><span class="pre">FalseNegativeRateParity.__init__()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.binary_confusion_matrix"><code class="docutils literal notranslate"><span class="pre">FalseNegativeRateParity.binary_confusion_matrix()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#langfair.metrics.classification.metrics.false_negative.FalseNegativeRateParity.evaluate"><code class="docutils literal notranslate"><span class="pre">FalseNegativeRateParity.evaluate()</span></code></a></li>
 </ul>
 </li>