Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Feb 24, 2025
1 parent 52d640d commit fbfd68f
Show file tree
Hide file tree
Showing 51 changed files with 178 additions and 201 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ randomization.

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 6.937 seconds)
**Total running time of the script:** (1 minutes 6.067 seconds)

**Estimated memory usage:** 722 MB

Expand Down
4 changes: 2 additions & 2 deletions docs/_sources/auto_examples/plot_dcrt_example.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ Plotting the comparison

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 2.862 seconds)
**Total running time of the script:** (1 minutes 2.848 seconds)

**Estimated memory usage:** 657 MB
**Estimated memory usage:** 658 MB


.. _sphx_glr_download_auto_examples_plot_dcrt_example.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,9 +491,9 @@ Analyze the results
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 9.310 seconds)
**Total running time of the script:** (0 minutes 9.200 seconds)

**Estimated memory usage:** 643 MB
**Estimated memory usage:** 641 MB


.. _sphx_glr_download_auto_examples_plot_diabetes_variable_importance_example.py:
Expand Down
15 changes: 5 additions & 10 deletions docs/_sources/auto_examples/plot_fmri_data_example.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -185,13 +185,8 @@ You may choose a subject in [1, 2, 3, 4, 5, 6]. By default subject=2.
[fetch_single_file] ...done. (0 seconds, 0 min)
[fetch_single_file] Downloading data from http://data.pymvpa.org/datasets/haxby2001/subj2-2010.01.14.tar.gz ...
[_chunk_report_] Downloaded 25632768 of 291168628 bytes (8.8%%, 10.6s remaining)
[_chunk_report_] Downloaded 78495744 of 291168628 bytes (27.0%%, 5.5s remaining)
[_chunk_report_] Downloaded 130367488 of 291168628 bytes (44.8%%, 3.8s remaining)
[_chunk_report_] Downloaded 182558720 of 291168628 bytes (62.7%%, 2.4s remaining)
[_chunk_report_] Downloaded 235618304 of 291168628 bytes (80.9%%, 1.2s remaining)
[_chunk_report_] Downloaded 288915456 of 291168628 bytes (99.2%%, 0.0s remaining)
[fetch_single_file] ...done. (6 seconds, 0 min)
[_chunk_report_] Downloaded 141983744 of 291168628 bytes (48.8%%, 1.1s remaining)
[fetch_single_file] ...done. (2 seconds, 0 min)
[uncompress_file] Extracting data from /home/runner/nilearn_data/haxby2001/9cabe068089e791ef0c5fe930fc20e30/subj2-2010.01.14.tar.gz...
[uncompress_file] .. done.
Expand Down Expand Up @@ -380,7 +375,7 @@ However you might benefit from clustering randomization taking
.. code-block:: none
[Parallel(n_jobs=2)]: Using backend LokyBackend with 2 concurrent workers.
[Parallel(n_jobs=2)]: Done 5 out of 5 | elapsed: 34.5s finished
[Parallel(n_jobs=2)]: Done 5 out of 5 | elapsed: 34.2s finished
Expand Down Expand Up @@ -625,9 +620,9 @@ spurious discoveries.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 26.829 seconds)
**Total running time of the script:** (1 minutes 21.342 seconds)

**Estimated memory usage:** 3222 MB
**Estimated memory usage:** 3181 MB


.. _sphx_glr_download_auto_examples_plot_fmri_data_example.py:
Expand Down
4 changes: 2 additions & 2 deletions docs/_sources/auto_examples/plot_knockoff_aggregation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -205,9 +205,9 @@ Imports needed for this script

.. rst-class:: sphx-glr-timing

**Total running time of the script:** (5 minutes 36.139 seconds)
**Total running time of the script:** (5 minutes 37.576 seconds)

**Estimated memory usage:** 821 MB
**Estimated memory usage:** 809 MB


.. _sphx_glr_download_auto_examples_plot_knockoff_aggregation.py:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Visualize the data
.. code-block:: none
[<matplotlib.axis.YTick object at 0x7f2bdbe04680>, <matplotlib.axis.YTick object at 0x7f2bdbe05bb0>, <matplotlib.axis.YTick object at 0x7f2bdc59c2c0>, <matplotlib.axis.YTick object at 0x7f2bdc59e2a0>, <matplotlib.axis.YTick object at 0x7f2cb3f9faa0>, <matplotlib.axis.YTick object at 0x7f2bdc59fe90>, <matplotlib.axis.YTick object at 0x7f2bdc59c140>, <matplotlib.axis.YTick object at 0x7f2cb2ab6e70>, <matplotlib.axis.YTick object at 0x7f2cb2ab5100>, <matplotlib.axis.YTick object at 0x7f2bdc59d2b0>]
[<matplotlib.axis.YTick object at 0x7f0fe25f0e00>, <matplotlib.axis.YTick object at 0x7f0fe25f2630>, <matplotlib.axis.YTick object at 0x7f0fe3d736b0>, <matplotlib.axis.YTick object at 0x7f0fe3d70e00>, <matplotlib.axis.YTick object at 0x7f0fe3d484d0>, <matplotlib.axis.YTick object at 0x7f0fe3d71580>, <matplotlib.axis.YTick object at 0x7f0fe3d705c0>, <matplotlib.axis.YTick object at 0x7f0fe3d73ce0>, <matplotlib.axis.YTick object at 0x7f0fe331e840>, <matplotlib.axis.YTick object at 0x7f0fe3d72240>]
Expand Down Expand Up @@ -422,14 +422,14 @@ the features.
.. code-block:: none
<matplotlib.legend.Legend object at 0x7f2bd3f187d0>
<matplotlib.legend.Legend object at 0x7f0fe1ee86b0>
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 44.470 seconds)
**Total running time of the script:** (0 minutes 44.197 seconds)

**Estimated memory usage:** 639 MB

Expand Down
24 changes: 12 additions & 12 deletions docs/_sources/auto_examples/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**10:06.547** total execution time for 6 files **from auto_examples**:
**10:01.230** total execution time for 6 files **from auto_examples**:

.. container::

Expand All @@ -33,20 +33,20 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_plot_knockoff_aggregation.py` (``plot_knockoff_aggregation.py``)
- 05:36.139
- 821.2
- 05:37.576
- 809.4
* - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``plot_fmri_data_example.py``)
- 01:26.829
- 3222.1
- 01:21.342
- 3181.3
* - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``plot_2D_simulation_example.py``)
- 01:06.937
- 722.2
- 01:06.067
- 722.1
* - :ref:`sphx_glr_auto_examples_plot_dcrt_example.py` (``plot_dcrt_example.py``)
- 01:02.862
- 657.4
- 01:02.848
- 657.8
* - :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` (``plot_variable_importance_classif.py``)
- 00:44.470
- 00:44.197
- 638.9
* - :ref:`sphx_glr_auto_examples_plot_diabetes_variable_importance_example.py` (``plot_diabetes_variable_importance_example.py``)
- 00:09.310
- 642.8
- 00:09.200
- 640.5
24 changes: 12 additions & 12 deletions docs/_sources/sg_execution_times.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Computation times
=================
**10:06.547** total execution time for 6 files **from all galleries**:
**10:01.230** total execution time for 6 files **from all galleries**:

.. container::

Expand All @@ -33,20 +33,20 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_plot_knockoff_aggregation.py` (``../examples/plot_knockoff_aggregation.py``)
- 05:36.139
- 821.2
- 05:37.576
- 809.4
* - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``../examples/plot_fmri_data_example.py``)
- 01:26.829
- 3222.1
- 01:21.342
- 3181.3
* - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``../examples/plot_2D_simulation_example.py``)
- 01:06.937
- 722.2
- 01:06.067
- 722.1
* - :ref:`sphx_glr_auto_examples_plot_dcrt_example.py` (``../examples/plot_dcrt_example.py``)
- 01:02.862
- 657.4
- 01:02.848
- 657.8
* - :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` (``../examples/plot_variable_importance_classif.py``)
- 00:44.470
- 00:44.197
- 638.9
* - :ref:`sphx_glr_auto_examples_plot_diabetes_variable_importance_example.py` (``../examples/plot_diabetes_variable_importance_example.py``)
- 00:09.310
- 642.8
- 00:09.200
- 640.5
8 changes: 0 additions & 8 deletions docs/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -741,14 +741,6 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.1.dev1+g27d08d9',
VERSION: '0.1.dev1+g52d640d',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
8 changes: 4 additions & 4 deletions docs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>API Documentation &#8212; HiDimStat 0.1.dev1+g27d08d9 documentation</title>
<title>API Documentation &#8212; HiDimStat 0.1.dev1+g52d640d documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=284a2d1d" />
<link rel="stylesheet" type="text/css" href="_static/style.css?v=fbda0898" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<script src="_static/documentation_options.js?v=7e6ea95f"></script>
<script src="_static/documentation_options.js?v=dc065f63"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
Expand Down Expand Up @@ -147,7 +147,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
<tr class="row-odd"><td><p><a class="reference internal" href="generated/hidimstat.ensemble_clustered_inference.html#hidimstat.ensemble_clustered_inference" title="hidimstat.ensemble_clustered_inference"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ensemble_clustered_inference</span></code></a>(X_init, y, ...)</p></td>
<td><p>Ensemble clustered inference algorithm</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/hidimstat.group_reid.html#hidimstat.group_reid" title="hidimstat.group_reid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">group_reid</span></code></a>(X, Y[, fit_Y, stationary, ...])</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="generated/hidimstat.group_reid.html#hidimstat.group_reid" title="hidimstat.group_reid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">group_reid</span></code></a>(X, Y[, stationary, method, ...])</p></td>
<td><p>Estimation of the covariance matrix using group Reid procedure</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/hidimstat.hd_inference.html#hidimstat.hd_inference" title="hidimstat.hd_inference"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hd_inference</span></code></a>(X, y, method[, n_jobs, memory, ...])</p></td>
Expand Down Expand Up @@ -211,7 +211,7 @@ <h2>Classes<a class="headerlink" href="#classes" title="Link to this heading">¶
</p>
<p>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.0.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.1.<br/>
</p>
</div>
</footer>
Expand Down
6 changes: 3 additions & 3 deletions docs/auto_examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Examples Gallery &#8212; HiDimStat 0.1.dev1+g27d08d9 documentation</title>
<title>Examples Gallery &#8212; HiDimStat 0.1.dev1+g52d640d documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=284a2d1d" />
<link rel="stylesheet" type="text/css" href="../_static/style.css?v=fbda0898" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<script src="../_static/documentation_options.js?v=7e6ea95f"></script>
<script src="../_static/documentation_options.js?v=dc065f63"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand Down Expand Up @@ -154,7 +154,7 @@
</p>
<p>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.0.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.1.<br/>
</p>
</div>
</footer>
Expand Down
8 changes: 4 additions & 4 deletions docs/auto_examples/plot_2D_simulation_example.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Support recovery on simulated data (2D) &#8212; HiDimStat 0.1.dev1+g27d08d9 documentation</title>
<title>Support recovery on simulated data (2D) &#8212; HiDimStat 0.1.dev1+g52d640d documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=284a2d1d" />
<link rel="stylesheet" type="text/css" href="../_static/style.css?v=fbda0898" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<script src="../_static/documentation_options.js?v=7e6ea95f"></script>
<script src="../_static/documentation_options.js?v=dc065f63"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand Down Expand Up @@ -475,7 +475,7 @@ <h2>Analysis of the results<a class="headerlink" href="#analysis-of-the-results"
conservative. In practice, Type-1 Error guarantees seem to hold
for a lower spatial tolerance. This is an additional benefit of clustering
randomization.</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 6.937 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 6.067 seconds)</p>
<p><strong>Estimated memory usage:</strong> 722 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-2d-simulation-example-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
Expand Down Expand Up @@ -505,7 +505,7 @@ <h2>Analysis of the results<a class="headerlink" href="#analysis-of-the-results"
</p>
<p>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.0.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.1.<br/>
</p>
</div>
</footer>
Expand Down
10 changes: 5 additions & 5 deletions docs/auto_examples/plot_dcrt_example.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Distilled Conditional Randomization Test (dCRT) using Lasso vs Random Forest learners &#8212; HiDimStat 0.1.dev1+g27d08d9 documentation</title>
<title>Distilled Conditional Randomization Test (dCRT) using Lasso vs Random Forest learners &#8212; HiDimStat 0.1.dev1+g52d640d documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=284a2d1d" />
<link rel="stylesheet" type="text/css" href="../_static/style.css?v=fbda0898" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<script src="../_static/documentation_options.js?v=7e6ea95f"></script>
<script src="../_static/documentation_options.js?v=dc065f63"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
Expand Down Expand Up @@ -210,8 +210,8 @@ <h2>Plotting the comparison<a class="headerlink" href="#plotting-the-comparison"
<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_dcrt_example_001.png" srcset="../_images/sphx_glr_plot_dcrt_example_001.png" alt="Type-I Error, Power" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 2.862 seconds)</p>
<p><strong>Estimated memory usage:</strong> 657 MB</p>
<img src="../_images/sphx_glr_plot_dcrt_example_001.png" srcset="../_images/sphx_glr_plot_dcrt_example_001.png" alt="Type-I Error, Power" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 2.848 seconds)</p>
<p><strong>Estimated memory usage:</strong> 658 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-dcrt-example-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/642b61154cca48af8e3feb505b920e16/plot_dcrt_example.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">plot_dcrt_example.ipynb</span></code></a></p>
Expand Down Expand Up @@ -240,7 +240,7 @@ <h2>Plotting the comparison<a class="headerlink" href="#plotting-the-comparison"
</p>
<p>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.0.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.2.1.<br/>
</p>
</div>
</footer>
Expand Down
Loading

0 comments on commit fbfd68f

Please sign in to comment.