Update stable dir

cleanlab · Mar 19, 2024 · 510aa5d · 510aa5d
1 parent b01d0f8
commit 510aa5d
Show file tree

Hide file tree

Showing 197 changed files with 6,612 additions and 5,386 deletions.
diff --git a/stable/_modules/cleanlab/benchmarking/noise_generation.html b/stable/_modules/cleanlab/benchmarking/noise_generation.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();

diff --git a/stable/_modules/cleanlab/classification.html b/stable/_modules/cleanlab/classification.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();

diff --git a/stable/_modules/cleanlab/count.html b/stable/_modules/cleanlab/count.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();

diff --git a/stable/_modules/cleanlab/datalab/datalab.html b/stable/_modules/cleanlab/datalab/datalab.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();
@@ -659,9 +668,11 @@ <h1>Source code for cleanlab.datalab.datalab</h1><div class="highlight"><pre>
 <span class="sd">        The name of the label column in the dataset.</span>
 
 <span class="sd">    image_key : str, optional</span>
-<span class="sd">        Optional key that can be specified for image datasets to point to the field containing the actual images themselves.</span>
-<span class="sd">        If specified, additional image-specific issue types can be detected in the dataset.</span>
-<span class="sd">        See the CleanVision package `documentation &lt;https://cleanvision.readthedocs.io/en/latest/&gt;`_ for descriptions of these image-specific issue types.</span>
+<span class="sd">        Optional key that can be specified for image datasets to point to the field (column) containing the actual images themselves (as PIL objects).</span>
+<span class="sd">        If specified, additional image-specific issue types will be checked for in the dataset.</span>
+<span class="sd">        See the `CleanVision package &lt;https://github.com/cleanlab/cleanvision?tab=readme-ov-file#clean-your-data-for-better-computer-vision&gt;`_ for descriptions of these image-specific issue types.</span>
+<span class="sd">        Currently, this argument is only supported for data formatted as a Hugging Face ``datasets.Dataset`` object.</span>
+
 
 <span class="sd">    verbosity : int, optional</span>
 <span class="sd">        The higher the verbosity level, the more information</span>

diff --git a/stable/_modules/cleanlab/datalab/internal/data.html b/stable/_modules/cleanlab/datalab/internal/data.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();

diff --git a/stable/_modules/cleanlab/datalab/internal/data_issues.html b/stable/_modules/cleanlab/datalab/internal/data_issues.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();

diff --git a/stable/_modules/cleanlab/datalab/internal/issue_finder.html b/stable/_modules/cleanlab/datalab/internal/issue_finder.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();

diff --git a/stable/_modules/cleanlab/datalab/internal/issue_manager/data_valuation.html b/stable/_modules/cleanlab/datalab/internal/issue_manager/data_valuation.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();

diff --git a/stable/_modules/cleanlab/datalab/internal/issue_manager/duplicate.html b/stable/_modules/cleanlab/datalab/internal/issue_manager/duplicate.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();
@@ -666,7 +675,7 @@ <h1>Source code for cleanlab.datalab.internal.issue_manager.duplicate</h1><div c
         <span class="n">N</span> <span class="o">=</span> <span class="n">knn_graph</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
         <span class="n">nn_distances</span> <span class="o">=</span> <span class="n">knn_graph</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">N</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">)[:,</span> <span class="mi">0</span><span class="p">]</span>
         <span class="n">median_nn_distance</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span>
-            <span class="n">np</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">nn_distances</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">finfo</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float_</span><span class="p">)</span><span class="o">.</span><span class="n">eps</span>
+            <span class="n">np</span><span class="o">.</span><span class="n">median</span><span class="p">(</span><span class="n">nn_distances</span><span class="p">),</span> <span class="mi">100</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">finfo</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float_</span><span class="p">)</span><span class="o">.</span><span class="n">eps</span>
         <span class="p">)</span>  <span class="c1"># avoid threshold = 0</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">near_duplicate_sets</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_neighbors_within_radius</span><span class="p">(</span>
             <span class="n">knn_graph</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">threshold</span><span class="p">,</span> <span class="n">median_nn_distance</span>
@@ -842,6 +851,11 @@ <h1>Source code for cleanlab.datalab.internal.issue_manager.duplicate</h1><div c
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Temperature must be greater than 0.&quot;</span><span class="p">)</span>
 
     <span class="n">scores</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">np</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="n">temperature</span> <span class="o">*</span> <span class="n">nn_distances</span><span class="p">)</span>
+
+    <span class="c1"># Ensure that for nn_distances approximately equal to 0, the score is set to 0</span>
+    <span class="n">inds</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">isclose</span><span class="p">(</span><span class="n">nn_distances</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
+    <span class="n">scores</span><span class="p">[</span><span class="n">inds</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
+
     <span class="k">return</span> <span class="n">scores</span>
 </pre></div> 
         </article>

diff --git a/stable/_modules/cleanlab/datalab/internal/issue_manager/imbalance.html b/stable/_modules/cleanlab/datalab/internal/issue_manager/imbalance.html
@@ -363,6 +363,15 @@
             >
         </li>
 
+        <li class="toctree-l1">
+            <a
+                id="v2.6.3"
+                class="reference internal"
+                href="/v2.6.3/"
+                >v2.6.3</a
+            >
+        </li>
+
         <li class="toctree-l1">
             <a
                 id="v2.6.2"
@@ -554,7 +563,7 @@
             document.getElementById("doc_ver_warning").innerHTML =
             `<div class="admonition warning">
             <p class="admonition-title">Warning</p>
-            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.2</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
+            <p>This documentation is for an old version (<code class="docutils literal notranslate"><span class="pre">v2.6.3</span></code>) of <code class="docutils literal notranslate"><span class="pre">cleanlab</span></code>. To see the documentation for the latest stable version (<code class="docutils literal notranslate"><span class="pre">` + version_number + `</span></code>), click <a href="/">here</a>.</p>
             </div>`;
         } else {
             document.getElementById("doc_ver_warning").remove();