update docs

cvs-health · Dec 20, 2024 · b5850be · b5850be
1 parent d05ce4f
commit b5850be
Show file tree

Hide file tree

Showing 102 changed files with 12,371 additions and 5,175 deletions.
diff --git a/docs/latest/_autosummary/langfair.auto.auto.AutoEval.html b/docs/latest/_autosummary/langfair.auto.auto.AutoEval.html
@@ -49,9 +49,11 @@
     <link rel="icon" href="../_static/langfair-logo-only.png"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="langfair.constants" href="langfair.constants.html" />
+    <link rel="prev" title="langfair.auto.auto" href="langfair.auto.auto.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="0.3.0a0" />
+  <meta name="docsearch:version" content="0.3.0" />
   </head>
 
 
@@ -133,6 +135,40 @@
 <nav>
   <ul class="bd-navbar-elements navbar-nav">
 
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../usage.html">
+    Get Started
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../choosing_metrics.html">
+    Choosing Metrics
+  </a>
+</li>
+
+
+<li class="nav-item current active">
+  <a class="nav-link nav-internal" href="../api.html">
+    API
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../auto_examples/index.html">
+    Example Notebooks
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../guide.html">
+    Contributor Guide
+  </a>
+</li>
+
   </ul>
 </nav></div>
 
@@ -222,6 +258,40 @@
 <nav>
   <ul class="bd-navbar-elements navbar-nav">
 
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../usage.html">
+    Get Started
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../choosing_metrics.html">
+    Choosing Metrics
+  </a>
+</li>
+
+
+<li class="nav-item current active">
+  <a class="nav-link nav-internal" href="../api.html">
+    API
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../auto_examples/index.html">
+    Example Notebooks
+  </a>
+</li>
+
+
+<li class="nav-item ">
+  <a class="nav-link nav-internal" href="../guide.html">
+    Contributor Guide
+  </a>
+</li>
+
   </ul>
 </nav></div>
 
@@ -266,8 +336,96 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
-<li class="toctree-l1 current active has-children"><a class="reference internal" href="langfair.auto.auto.html">langfair.auto.auto</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
-<li class="toctree-l2 current active"><a class="current reference internal" href="#">langfair.auto.auto.AutoEval</a></li>
+<li class="toctree-l1 current active has-children"><a class="reference internal" href="langfair.auto.html">langfair.auto</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l2 current active has-children"><a class="reference internal" href="langfair.auto.auto.html">langfair.auto.auto</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
+<li class="toctree-l3 current active"><a class="current reference internal" href="#">langfair.auto.auto.AutoEval</a></li>
+</ul>
+</details></li>
+</ul>
+</details></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="langfair.constants.html">langfair.constants</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2"><a class="reference internal" href="langfair.constants.cost_data.html">langfair.constants.cost_data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="langfair.constants.word_lists.html">langfair.constants.word_lists</a></li>
+</ul>
+</details></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="langfair.generator.html">langfair.generator</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="langfair.generator.counterfactual.html">langfair.generator.counterfactual</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3"><a class="reference internal" href="langfair.generator.counterfactual.CounterfactualGenerator.html">langfair.generator.counterfactual.CounterfactualGenerator</a></li>
+</ul>
+</details></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="langfair.generator.generator.html">langfair.generator.generator</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3"><a class="reference internal" href="langfair.generator.generator.ResponseGenerator.html">langfair.generator.generator.ResponseGenerator</a></li>
+</ul>
+</details></li>
+</ul>
+</details></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="langfair.metrics.html">langfair.metrics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="langfair.metrics.classification.html">langfair.metrics.classification</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.classification.classification.html">langfair.metrics.classification.classification</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.classification.classification.ClassificationMetrics.html">langfair.metrics.classification.classification.ClassificationMetrics</a></li>
+</ul>
+</details></li>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.classification.metrics.html">langfair.metrics.classification.metrics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.classification.metrics.baseclass.html">langfair.metrics.classification.metrics.baseclass</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.classification.metrics.false_discovery.html">langfair.metrics.classification.metrics.false_discovery</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.classification.metrics.false_negative.html">langfair.metrics.classification.metrics.false_negative</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.classification.metrics.false_omission.html">langfair.metrics.classification.metrics.false_omission</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.classification.metrics.false_positive.html">langfair.metrics.classification.metrics.false_positive</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.classification.metrics.predicted_prevalence.html">langfair.metrics.classification.metrics.predicted_prevalence</a></li>
+</ul>
+</details></li>
+</ul>
+</details></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="langfair.metrics.counterfactual.html">langfair.metrics.counterfactual</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.counterfactual.counterfactual.html">langfair.metrics.counterfactual.counterfactual</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.counterfactual.counterfactual.CounterfactualMetrics.html">langfair.metrics.counterfactual.counterfactual.CounterfactualMetrics</a></li>
+</ul>
+</details></li>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.counterfactual.metrics.html">langfair.metrics.counterfactual.metrics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.counterfactual.metrics.baseclass.html">langfair.metrics.counterfactual.metrics.baseclass</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.counterfactual.metrics.bleu.html">langfair.metrics.counterfactual.metrics.bleu</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.counterfactual.metrics.cosine.html">langfair.metrics.counterfactual.metrics.cosine</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.counterfactual.metrics.rougel.html">langfair.metrics.counterfactual.metrics.rougel</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.counterfactual.metrics.sentimentbias.html">langfair.metrics.counterfactual.metrics.sentimentbias</a></li>
+</ul>
+</details></li>
+</ul>
+</details></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="langfair.metrics.recommendation.html">langfair.metrics.recommendation</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.recommendation.metrics.html">langfair.metrics.recommendation.metrics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.recommendation.metrics.baseclass.html">langfair.metrics.recommendation.metrics.baseclass</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.recommendation.metrics.jaccard.html">langfair.metrics.recommendation.metrics.jaccard</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.recommendation.metrics.prag.html">langfair.metrics.recommendation.metrics.prag</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.recommendation.metrics.serp.html">langfair.metrics.recommendation.metrics.serp</a></li>
+</ul>
+</details></li>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.recommendation.recommendation.html">langfair.metrics.recommendation.recommendation</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.recommendation.recommendation.RecommendationMetrics.html">langfair.metrics.recommendation.recommendation.RecommendationMetrics</a></li>
+</ul>
+</details></li>
+</ul>
+</details></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="langfair.metrics.stereotype.html">langfair.metrics.stereotype</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.stereotype.metrics.html">langfair.metrics.stereotype.metrics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.stereotype.metrics.associations.html">langfair.metrics.stereotype.metrics.associations</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.stereotype.metrics.baseclass.html">langfair.metrics.stereotype.metrics.baseclass</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.stereotype.metrics.classifier.html">langfair.metrics.stereotype.metrics.classifier</a></li>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.stereotype.metrics.cooccurrence.html">langfair.metrics.stereotype.metrics.cooccurrence</a></li>
+</ul>
+</details></li>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.stereotype.stereotype.html">langfair.metrics.stereotype.stereotype</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.stereotype.stereotype.StereotypeMetrics.html">langfair.metrics.stereotype.stereotype.StereotypeMetrics</a></li>
+</ul>
+</details></li>
+</ul>
+</details></li>
+<li class="toctree-l2 has-children"><a class="reference internal" href="langfair.metrics.toxicity.html">langfair.metrics.toxicity</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l3 has-children"><a class="reference internal" href="langfair.metrics.toxicity.toxicity.html">langfair.metrics.toxicity.toxicity</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
+<li class="toctree-l4"><a class="reference internal" href="langfair.metrics.toxicity.toxicity.ToxicityMetrics.html">langfair.metrics.toxicity.toxicity.ToxicityMetrics</a></li>
+</ul>
+</details></li>
+</ul>
+</details></li>
 </ul>
 </details></li>
 </ul>
@@ -310,6 +468,15 @@
         <i class="fa-solid fa-home"></i>
       </a>
     </li>
+
+    <li class="breadcrumb-item"><a href="../api.html" class="nav-link">API</a></li>
+
+
+    <li class="breadcrumb-item"><a href="langfair.auto.html" class="nav-link">langfair.auto</a></li>
+
+
+    <li class="breadcrumb-item"><a href="langfair.auto.auto.html" class="nav-link">langfair.auto.auto</a></li>
+
     <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">langfair.auto.auto.AutoEval</span></li>
   </ul>
 </nav>
@@ -447,6 +614,24 @@ <h1>langfair.auto.auto.AutoEval<a class="headerlink" href="#langfair-auto-auto-a
                 <footer class="prev-next-footer d-print-none">
 
 <div class="prev-next-area">
+    <a class="left-prev"
+       href="langfair.auto.auto.html"
+       title="previous page">
+      <i class="fa-solid fa-angle-left"></i>
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">previous</p>
+        <p class="prev-next-title">langfair.auto.auto</p>
+      </div>
+    </a>
+    <a class="right-next"
+       href="langfair.constants.html"
+       title="next page">
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">next</p>
+        <p class="prev-next-title">langfair.constants</p>
+      </div>
+      <i class="fa-solid fa-angle-right"></i>
+    </a>
 </div>
                 </footer>