docs updates [skip ci] (1155)

dev/.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: 0cac47fd877076e8c4aeb672fe427ab6
+config: 9fcad6e70abecfbb1759696793bdd0b6
 tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/_modules/index.html

@@ -435,7 +435,7 @@ <h1>All modules for which code is available</h1>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/_lib/sklearn/ensemble/_forest.html

@@ -4019,7 +4019,7 @@ <h1>Source code for sktree._lib.sklearn.ensemble._forest</h1><div class="highlig
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/ensemble/_honest_forest.html

@@ -1048,7 +1048,7 @@ <h1>Source code for sktree.ensemble._honest_forest</h1><div class="highlight"><p
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/ensemble/_supervised_forest.html

@@ -1746,7 +1746,7 @@ <h1>Source code for sktree.ensemble._supervised_forest</h1><div class="highlight
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/ensemble/_unsupervised_forest.html

@@ -1274,7 +1274,7 @@ <h1>Source code for sktree.ensemble._unsupervised_forest</h1><div class="highlig
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/experimental/mutual_info.html

@@ -887,7 +887,7 @@ <h1>Source code for sktree.experimental.mutual_info</h1><div class="highlight"><
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/experimental/simulate.html

@@ -660,7 +660,7 @@ <h1>Source code for sktree.experimental.simulate</h1><div class="highlight"><pre
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/neighbors.html

@@ -647,7 +647,7 @@ <h1>Source code for sktree.neighbors</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/tree/_classes.html

@@ -2675,7 +2675,7 @@ <h1>Source code for sktree.tree._classes</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/tree/_honest_tree.html

@@ -1185,7 +1185,7 @@ <h1>Source code for sktree.tree._honest_tree</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/_modules/sktree/tree/_neighbors.html

@@ -497,7 +497,7 @@ <h1>Source code for sktree.tree._neighbors</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/api.html

@@ -705,7 +705,7 @@ <h2>Experimental Functionality<a class="headerlink" href="#experimental-function
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/auto_examples/index.html

@@ -455,7 +455,7 @@ <h1>Examples<a class="headerlink" href="#examples" title="Link to this heading">
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/auto_examples/plot_iris_dtc.html

@@ -555,7 +555,7 @@
 <li><img src="../_images/sphx_glr_plot_iris_dtc_003.png" srcset="../_images/sphx_glr_plot_iris_dtc_003.png" alt="Axis-aligned decision tree trained on all the iris features" class = "sphx-glr-multi-img"/></li>
 <li><img src="../_images/sphx_glr_plot_iris_dtc_004.png" srcset="../_images/sphx_glr_plot_iris_dtc_004.png" alt="Oblique decision tree trained on all the iris features" class = "sphx-glr-multi-img"/></li>
 </ul>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 3.908 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 3.768 seconds)</p>
 <p><strong>Estimated memory usage:</strong>  14 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-iris-dtc-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">
@@ -629,7 +629,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/auto_examples/plot_oblique_axis_aligned_forests_sparse_parity.html

@@ -420,7 +420,7 @@
 of the sum of data <code class="docutils literal notranslate"><span class="pre">X</span></code> across first <code class="docutils literal notranslate"><span class="pre">p*</span></code> features that are greater than 0,
 otherwise the label is defined as 0. The simulation is further detailed
 in this [publication](<a class="reference external" href="https://epubs.siam.org/doi/epdf/10.1137/1.9781611974973.56">https://epubs.siam.org/doi/epdf/10.1137/1.9781611974973.56</a>).</p>
-<img src="../_images/sphx_glr_plot_oblique_axis_aligned_forests_sparse_parity_001.png" srcset="../_images/sphx_glr_plot_oblique_axis_aligned_forests_sparse_parity_001.png" alt="Sparse Parity" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>It took 12 seconds to run the script
+<img src="../_images/sphx_glr_plot_oblique_axis_aligned_forests_sparse_parity_001.png" srcset="../_images/sphx_glr_plot_oblique_axis_aligned_forests_sparse_parity_001.png" alt="Sparse Parity" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>It took 11 seconds to run the script
 /home/circleci/.pyenv/versions/3.9.18/lib/python3.9/site-packages/seaborn/_oldcore.py:1498: FutureWarning: is_categorical_dtype is deprecated and will be removed in a future version. Use isinstance(dtype, CategoricalDtype) instead
   if pd.api.types.is_categorical_dtype(vector):
 /home/circleci/.pyenv/versions/3.9.18/lib/python3.9/site-packages/seaborn/_oldcore.py:1498: FutureWarning: is_categorical_dtype is deprecated and will be removed in a future version. Use isinstance(dtype, CategoricalDtype) instead
@@ -531,7 +531,7 @@
 <a href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 12.645 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 12.362 seconds)</p>
 <p><strong>Estimated memory usage:</strong>  10 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-oblique-axis-aligned-forests-sparse-parity-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">
@@ -605,7 +605,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/auto_examples/plot_oblique_random_forest.html

@@ -423,7 +423,7 @@
 <img src="../_images/sphx_glr_plot_oblique_random_forest_001.png" srcset="../_images/sphx_glr_plot_oblique_random_forest_001.png" alt="PhishingWebsites, wdbc, cnae-9" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>Loading [PhishingWebsites] dataset..
 Loading [wdbc] dataset..
 Loading [cnae-9] dataset..
-It took 23 seconds to run the script
+It took 37 seconds to run the script
 /home/circleci/.pyenv/versions/3.9.18/lib/python3.9/site-packages/seaborn/_oldcore.py:1498: FutureWarning: is_categorical_dtype is deprecated and will be removed in a future version. Use isinstance(dtype, CategoricalDtype) instead
   if pd.api.types.is_categorical_dtype(vector):
 /home/circleci/.pyenv/versions/3.9.18/lib/python3.9/site-packages/seaborn/_oldcore.py:1498: FutureWarning: is_categorical_dtype is deprecated and will be removed in a future version. Use isinstance(dtype, CategoricalDtype) instead
@@ -609,8 +609,8 @@
     <a href="https://numpy.org/devdocs/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">ax</span></a><span class="p">[</span><a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">i</span></a><span class="p">]</span><span class="o">.</span><span class="n">set_xlabel</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 25.002 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  321 MB</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 39.028 seconds)</p>
+<p><strong>Estimated memory usage:</strong>  320 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-oblique-random-forest-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/31e055577373b3e8c688c3fcf1304e84/plot_oblique_random_forest.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_oblique_random_forest.py</span></code></a></p>
@@ -683,7 +683,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/auto_examples/plot_overlapping_gaussians.html

@@ -599,8 +599,8 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
 <span class="c1"># curve, compared to RF which is shown below.</span>
 </pre></div>
 </div>
-<img src="../_images/sphx_glr_plot_overlapping_gaussians_001.png" srcset="../_images/sphx_glr_plot_overlapping_gaussians_001.png" alt="plot overlapping gaussians" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 20.338 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  75 MB</p>
+<img src="../_images/sphx_glr_plot_overlapping_gaussians_001.png" srcset="../_images/sphx_glr_plot_overlapping_gaussians_001.png" alt="plot overlapping gaussians" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 21.519 seconds)</p>
+<p><strong>Estimated memory usage:</strong>  73 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-overlapping-gaussians-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/ed8294c8526ffbb9799792531e2f729f/plot_overlapping_gaussians.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_overlapping_gaussians.py</span></code></a></p>
@@ -688,7 +688,7 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/auto_examples/plot_projection_matrices.html

@@ -720,8 +720,8 @@ <h2>Discontiguous Patches<a class="headerlink" href="#discontiguous-patches" tit
 <a href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function"><span class="n">plt</span><span class="o">.</span><span class="n">show</span></a><span class="p">()</span>
 </pre></div>
 </div>
-<img src="../_images/sphx_glr_plot_projection_matrices_005.png" srcset="../_images/sphx_glr_plot_projection_matrices_005.png" alt="2D Discontiguous In All Dims Patch Visualization, Patch 0, Patch 1, Patch 2, Patch 3, Patch 4, Patch 5, Patch 6, Patch 7, Patch 8" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 4.841 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  12 MB</p>
+<img src="../_images/sphx_glr_plot_projection_matrices_005.png" srcset="../_images/sphx_glr_plot_projection_matrices_005.png" alt="2D Discontiguous In All Dims Patch Visualization, Patch 0, Patch 1, Patch 2, Patch 3, Patch 4, Patch 5, Patch 6, Patch 7, Patch 8" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 4.803 seconds)</p>
+<p><strong>Estimated memory usage:</strong>  11 MB</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-projection-matrices-py">
 <div class="sphx-glr-download sphx-glr-download-python docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/0a65e88a0e06f6c9a3b9c7f9b8a19554/plot_projection_matrices.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_projection_matrices.py</span></code></a></p>
@@ -804,7 +804,7 @@ <h2>Discontiguous Patches<a class="headerlink" href="#discontiguous-patches" tit
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/auto_examples/sg_execution_times.html

@@ -383,28 +383,28 @@
 
   <section id="computation-times">
 <span id="sphx-glr-auto-examples-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">#</a></h1>
-<p><strong>01:06.734</strong> total execution time for <strong>auto_examples</strong> files:</p>
+<p><strong>01:21.480</strong> total execution time for <strong>auto_examples</strong> files:</p>
 <table class="table">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_oblique_random_forest.html#sphx-glr-auto-examples-plot-oblique-random-forest-py"><span class="std std-ref">Plot oblique forest and axis-aligned random forest predictions on cc18 datasets</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_oblique_random_forest.py</span></code>)</p></td>
-<td><p>00:25.002</p></td>
-<td><p>320.6 MB</p></td>
+<td><p>00:39.028</p></td>
+<td><p>320.4 MB</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="plot_overlapping_gaussians.html#sphx-glr-auto-examples-plot-overlapping-gaussians-py"><span class="std std-ref">Plot honest forest calibrations on overlapping gaussian simulations</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_overlapping_gaussians.py</span></code>)</p></td>
-<td><p>00:20.338</p></td>
-<td><p>74.6 MB</p></td>
+<td><p>00:21.519</p></td>
+<td><p>73.2 MB</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_oblique_axis_aligned_forests_sparse_parity.html#sphx-glr-auto-examples-plot-oblique-axis-aligned-forests-sparse-parity-py"><span class="std std-ref">Plot oblique forest and axis-aligned random forest predictions on sparse parity simulation</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_oblique_axis_aligned_forests_sparse_parity.py</span></code>)</p></td>
-<td><p>00:12.645</p></td>
-<td><p>9.6 MB</p></td>
+<td><p>00:12.362</p></td>
+<td><p>9.5 MB</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="plot_projection_matrices.html#sphx-glr-auto-examples-plot-projection-matrices-py"><span class="std std-ref">Plot the projection matrices of an oblique tree</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_projection_matrices.py</span></code>)</p></td>
-<td><p>00:04.841</p></td>
-<td><p>11.7 MB</p></td>
+<td><p>00:04.803</p></td>
+<td><p>11.5 MB</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="plot_iris_dtc.html#sphx-glr-auto-examples-plot-iris-dtc-py"><span class="std std-ref">Plot the decision surface of decision trees trained on the iris dataset</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_iris_dtc.py</span></code>)</p></td>
-<td><p>00:03.908</p></td>
-<td><p>14.4 MB</p></td>
+<td><p>00:03.768</p></td>
+<td><p>14.2 MB</p></td>
 </tr>
 </tbody>
 </table>
@@ -453,7 +453,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/generated/sktree.ExtraTreesClassifier.html

@@ -1375,7 +1375,7 @@ <h1><a class="reference internal" href="../api.html#module-sktree" title="sktree
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/generated/sktree.ExtraTreesRegressor.html

@@ -1227,7 +1227,7 @@ <h1><a class="reference internal" href="../api.html#module-sktree" title="sktree
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>

dev/generated/sktree.HonestForestClassifier.html

@@ -1348,7 +1348,7 @@ <h2>Examples using <code class="docutils literal notranslate"><span class="pre">
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-06.
+      © Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-09-08.
       <br/>
 
   </p>