Skip to content

Commit

Permalink
docs updates [skip ci] (1466)
Browse files Browse the repository at this point in the history
  • Loading branch information
Circle Ci committed Oct 11, 2023
1 parent 1eaa5fd commit 1e55b87
Show file tree
Hide file tree
Showing 88 changed files with 147 additions and 139 deletions.
2 changes: 1 addition & 1 deletion dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: f5142c8f45335a4b1ea842ad3915ea36
config: 10a269ad9fc0b46596793a05ea331049
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file modified dev/_images/sphx_glr_plot_extra_oblique_random_forest_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_extra_oblique_random_forest_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_extra_orf_sample_size_001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/sphx_glr_plot_extra_orf_sample_size_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion dev/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/_lib/sklearn/ensemble/_forest.html
Original file line number Diff line number Diff line change
Expand Up @@ -4065,7 +4065,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/_lib/sklearn/tree/_classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -2881,7 +2881,7 @@ <h1>Source code for sktree._lib.sklearn.tree._classes</h1><div class="highlight"
<div class="footer-item">
<p class="copyright">

© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/ensemble/_eiforest.html
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ <h1>Source code for sktree.ensemble._eiforest</h1><div class="highlight"><pre>
<div class="footer-item">
<p class="copyright">

© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/ensemble/_honest_forest.html
Original file line number Diff line number Diff line change
Expand Up @@ -1097,7 +1097,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/ensemble/_supervised_forest.html
Original file line number Diff line number Diff line change
Expand Up @@ -2434,7 +2434,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/ensemble/_unsupervised_forest.html
Original file line number Diff line number Diff line change
Expand Up @@ -1319,7 +1319,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/experimental/mutual_info.html
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/experimental/simulate.html
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/neighbors.html
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
8 changes: 6 additions & 2 deletions dev/_modules/sktree/stats/forestht.html
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,8 @@ <h1>Source code for sktree.stats.forestht</h1><div class="highlight"><pre>
<span class="sd"> y : ArrayLike of shape (n_samples, n_outputs)</span>
<span class="sd"> The target matrix.</span>
<span class="sd"> covariate_index : ArrayLike, optional of shape (n_covariates,)</span>
<span class="sd"> The index array of covariates to shuffle, by default None.</span>
<span class="sd"> The index array of covariates to shuffle, will shuffle all columns by</span>
<span class="sd"> default (corresponding to None).</span>
<span class="sd"> metric : str, optional</span>
<span class="sd"> The metric to compute, by default &quot;mse&quot;.</span>
<span class="sd"> n_repeats : int, optional</span>
Expand Down Expand Up @@ -901,6 +902,9 @@ <h1>Source code for sktree.stats.forestht</h1><div class="highlight"><pre>
<span class="n">observe_stat</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">observe_stat_</span>

<span class="c1"># next permute the data</span>
<span class="k">if</span> <span class="n">covariate_index</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">covariate_index</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">int</span><span class="p">)</span>

<span class="n">permute_stat</span><span class="p">,</span> <span class="n">permute_posteriors</span><span class="p">,</span> <span class="n">permute_samples</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">statistic</span><span class="p">(</span>
<span class="n">X</span><span class="p">,</span>
<span class="n">y</span><span class="p">,</span>
Expand Down Expand Up @@ -1503,7 +1507,7 @@ <h1>Source code for sktree.stats.forestht</h1><div class="highlight"><pre>
<div class="footer-item">
<p class="copyright">

© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/stats/permutationforest.html
Original file line number Diff line number Diff line change
Expand Up @@ -917,7 +917,7 @@ <h1>Source code for sktree.stats.permutationforest</h1><div class="highlight"><p
<div class="footer-item">
<p class="copyright">

© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/tree/_classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -3616,7 +3616,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/tree/_honest_tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -1257,7 +1257,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/sktree/tree/_neighbors.html
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -821,7 +821,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
2 changes: 1 addition & 1 deletion dev/auto_examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -613,8 +613,8 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
</aside>
</aside>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 26.489 seconds)</p>
<p><strong>Estimated memory usage:</strong> 514 MB</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 24.983 seconds)</p>
<p><strong>Estimated memory usage:</strong> 723 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-mi-gigantic-hypothesis-testing-forest-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../_downloads/00cfceae2563f06768ed2afc5560087c/plot_MI_gigantic_hypothesis_testing_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_MI_gigantic_hypothesis_testing_forest.py</span></code></a></p>
Expand Down Expand Up @@ -700,7 +700,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
4 changes: 2 additions & 2 deletions dev/auto_examples/plot_extended_isolation_forest.html
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,7 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
</aside>
</aside>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 12.102 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 9.880 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-extended-isolation-forest-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
Expand Down Expand Up @@ -795,7 +795,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
26 changes: 13 additions & 13 deletions dev/auto_examples/plot_extra_oblique_random_forest.html
Original file line number Diff line number Diff line change
Expand Up @@ -562,16 +562,16 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
n_repeats 1
time_taken
dataset dimension model
PhishingWebsites (2000, 30) EORF 0.948630
ORF 0.973339
cnae-9 (864, 856) EORF 1.625716
ORF 1.880641
har (2000, 561) EORF 1.558208
ORF 2.978476
lsvt (100, 310) EORF 0.872325
ORF 0.939973
wdbc (455, 30) EORF 0.701185
ORF 0.827429
PhishingWebsites (2000, 30) EORF 0.905290
ORF 0.905242
cnae-9 (864, 856) EORF 1.628485
ORF 1.831246
har (2000, 561) EORF 1.441133
ORF 2.861679
lsvt (100, 310) EORF 0.829824
ORF 0.898730
wdbc (455, 30) EORF 0.680727
ORF 0.778347
</pre></div>
</div>
<div class="line-block">
Expand Down Expand Up @@ -703,8 +703,8 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
<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 30.023 seconds)</p>
<p><strong>Estimated memory usage:</strong> 167 MB</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 37.482 seconds)</p>
<p><strong>Estimated memory usage:</strong> 98 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-extra-oblique-random-forest-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../_downloads/fe83a26431a514151ddfc59a4b25896a/plot_extra_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_extra_oblique_random_forest.py</span></code></a></p>
Expand Down Expand Up @@ -789,7 +789,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
4 changes: 2 additions & 2 deletions dev/auto_examples/plot_extra_orf_sample_size.html
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
<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> (2 minutes 8.070 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (2 minutes 5.191 seconds)</p>
<p><strong>Estimated memory usage:</strong> 9 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-extra-orf-sample-size-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
Expand Down Expand Up @@ -703,7 +703,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-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
4 changes: 2 additions & 2 deletions dev/auto_examples/plot_iris_dtc.html
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,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 5.204 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 4.388 seconds)</p>
<p><strong>Estimated memory usage:</strong> 9 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">
Expand Down Expand Up @@ -661,7 +661,7 @@
<div class="footer-item">
<p class="copyright">

© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
6 changes: 3 additions & 3 deletions dev/auto_examples/plot_might_auc.html
Original file line number Diff line number Diff line change
Expand Up @@ -595,8 +595,8 @@ <h2>All posteriors are saved within the model<a class="headerlink" href="#all-po
Observed Samples: <code class="docutils literal notranslate"><span class="pre">est.observe_samples_</span></code>
Tree Posteriors for the positive class: <code class="docutils literal notranslate"><span class="pre">est.observe_posteriors_</span></code> (n_trees, n_samples_test, 1)
True Labels: <code class="docutils literal notranslate"><span class="pre">est.y_true_final_</span></code></p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 6.110 seconds)</p>
<p><strong>Estimated memory usage:</strong> 285 MB</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 5.191 seconds)</p>
<p><strong>Estimated memory usage:</strong> 235 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-might-auc-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../_downloads/71f52ddc897be17d747e41dffb3b0762/plot_might_auc.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_might_auc.py</span></code></a></p>
Expand Down Expand Up @@ -683,7 +683,7 @@ <h2>All posteriors are saved within the model<a class="headerlink" href="#all-po
<div class="footer-item">
<p class="copyright">

© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,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 9.025 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 8.160 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">
Expand Down Expand Up @@ -633,7 +633,7 @@
<div class="footer-item">
<p class="copyright">

© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-09.
© Copyright 2022-2023, scikit-tree Developers. Last updated on 2023-10-11.
<br/>

</p>
Expand Down
Loading

0 comments on commit 1e55b87

Please sign in to comment.