Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jul 9, 2024
1 parent d8541ff commit 1a7b8b0
Show file tree
Hide file tree
Showing 32 changed files with 97 additions and 92 deletions.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_images/sphx_glr_plot_fmri_data_example_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 docs/_images/sphx_glr_plot_fmri_data_example_thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ randomization.

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

**Total running time of the script:** (1 minutes 3.609 seconds)
**Total running time of the script:** (1 minutes 5.968 seconds)

**Estimated memory usage:** 98 MB

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,9 +194,9 @@ Plotting the comparison

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

**Total running time of the script:** (0 minutes 46.945 seconds)
**Total running time of the script:** (0 minutes 47.652 seconds)

**Estimated memory usage:** 29 MB
**Estimated memory usage:** 28 MB


.. _sphx_glr_download_auto_examples_plot_diabetesFeatures_importance_example.py:
Expand Down
12 changes: 6 additions & 6 deletions docs/_sources/auto_examples/plot_fmri_data_example.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ You may choose a subject in [1, 2, 3, 4, 5, 6]. By default subject=2.
Downloading data from http://data.pymvpa.org/datasets/haxby2001/MD5SUMS ...
...done. (0 seconds, 0 min)
Downloading data from http://data.pymvpa.org/datasets/haxby2001/subj2-2010.01.14.tar.gz ...
Downloaded 110764032 of 291168628 bytes (38.0%, 1.6s remaining) Downloaded 243146752 of 291168628 bytes (83.5%, 0.4s remaining) ...done. (3 seconds, 0 min)
Downloaded 18956288 of 291168628 bytes (6.5%, 14.6s remaining) Downloaded 58302464 of 291168628 bytes (20.0%, 8.2s remaining) Downloaded 97599488 of 291168628 bytes (33.5%, 6.1s remaining) Downloaded 136847360 of 291168628 bytes (47.0%, 4.6s remaining) Downloaded 176349184 of 291168628 bytes (60.6%, 3.3s remaining) Downloaded 215433216 of 291168628 bytes (74.0%, 2.2s remaining) Downloaded 253992960 of 291168628 bytes (87.2%, 1.0s remaining) ...done. (8 seconds, 0 min)
Extracting data from /home/runner/nilearn_data/haxby2001/def37a305edfda829916fa14c9ea08f8/subj2-2010.01.14.tar.gz..... done.


Expand Down Expand Up @@ -281,8 +281,8 @@ Now, we compute p-values thanks to permutation tests applied to

.. code-block:: none
[Parallel(n_jobs=1)]: Done 49 tasks | elapsed: 1.7s
[Parallel(n_jobs=1)]: Done 199 tasks | elapsed: 6.4s
[Parallel(n_jobs=1)]: Done 49 tasks | elapsed: 1.6s
[Parallel(n_jobs=1)]: Done 199 tasks | elapsed: 6.6s
Expand Down Expand Up @@ -361,7 +361,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: 31.7s finished
[Parallel(n_jobs=2)]: Done 5 out of 5 | elapsed: 33.4s finished
Expand Down Expand Up @@ -599,9 +599,9 @@ spurious discoveries.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 24.013 seconds)
**Total running time of the script:** (1 minutes 31.208 seconds)

**Estimated memory usage:** 2694 MB
**Estimated memory usage:** 2583 MB


.. _sphx_glr_download_auto_examples_plot_fmri_data_example.py:
Expand Down
14 changes: 7 additions & 7 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
=================
**03:14.567** total execution time for 3 files **from auto_examples**:
**03:24.827** total execution time for 3 files **from auto_examples**:

.. container::

Expand All @@ -33,11 +33,11 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``plot_fmri_data_example.py``)
- 01:24.013
- 2693.7
- 01:31.208
- 2583.5
* - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``plot_2D_simulation_example.py``)
- 01:03.609
- 98.0
- 01:05.968
- 98.4
* - :ref:`sphx_glr_auto_examples_plot_diabetesFeatures_importance_example.py` (``plot_diabetesFeatures_importance_example.py``)
- 00:46.945
- 29.1
- 00:47.652
- 28.3
14 changes: 7 additions & 7 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
=================
**03:14.567** total execution time for 3 files **from all galleries**:
**03:24.827** total execution time for 3 files **from all galleries**:

.. container::

Expand All @@ -33,11 +33,11 @@ Computation times
- Time
- Mem (MB)
* - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``../examples/plot_fmri_data_example.py``)
- 01:24.013
- 2693.7
- 01:31.208
- 2583.5
* - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``../examples/plot_2D_simulation_example.py``)
- 01:03.609
- 98.0
- 01:05.968
- 98.4
* - :ref:`sphx_glr_auto_examples_plot_diabetesFeatures_importance_example.py` (``../examples/plot_diabetesFeatures_importance_example.py``)
- 00:46.945
- 29.1
- 00:47.652
- 28.3
4 changes: 2 additions & 2 deletions docs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

<li><a href="auto_examples/index.html">Examples</a></li>
<li><a href="#">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -184,7 +184,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/auto_examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

<li><a href="#">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -144,7 +144,7 @@

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/auto_examples/plot_2D_simulation_example.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

<li><a href="index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -473,7 +473,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 3.609 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 5.968 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-2d-simulation-example-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
Expand All @@ -499,7 +499,7 @@ <h2>Analysis of the results<a class="headerlink" href="#analysis-of-the-results"

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

<li><a href="index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -227,8 +227,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_diabetesFeatures_importance_example_001.png" srcset="../_images/sphx_glr_plot_diabetesFeatures_importance_example_001.png" alt="plot diabetesFeatures importance example" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 46.945 seconds)</p>
<p><strong>Estimated memory usage:</strong> 29 MB</p>
<img src="../_images/sphx_glr_plot_diabetesFeatures_importance_example_001.png" srcset="../_images/sphx_glr_plot_diabetesFeatures_importance_example_001.png" alt="plot diabetesFeatures importance example" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 47.652 seconds)</p>
<p><strong>Estimated memory usage:</strong> 28 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-diabetesfeatures-importance-example-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/6352d1acfa60f2083a9b7a62b5203e91/plot_diabetesFeatures_importance_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_diabetesFeatures_importance_example.ipynb</span></code></a></p>
Expand All @@ -253,7 +253,7 @@ <h2>Plotting the comparison<a class="headerlink" href="#plotting-the-comparison"

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
23 changes: 14 additions & 9 deletions docs/auto_examples/plot_fmri_data_example.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

<li><a href="index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -252,8 +252,13 @@ <h2>Gathering and preprocessing Haxby dataset for a given subject<a class="heade
...done. (0 seconds, 0 min)
Downloading data from http://data.pymvpa.org/datasets/haxby2001/subj2-2010.01.14.tar.gz ...

Downloaded 110764032 of 291168628 bytes (38.0%, 1.6s remaining)
Downloaded 243146752 of 291168628 bytes (83.5%, 0.4s remaining) ...done. (3 seconds, 0 min)
Downloaded 18956288 of 291168628 bytes (6.5%, 14.6s remaining)
Downloaded 58302464 of 291168628 bytes (20.0%, 8.2s remaining)
Downloaded 97599488 of 291168628 bytes (33.5%, 6.1s remaining)
Downloaded 136847360 of 291168628 bytes (47.0%, 4.6s remaining)
Downloaded 176349184 of 291168628 bytes (60.6%, 3.3s remaining)
Downloaded 215433216 of 291168628 bytes (74.0%, 2.2s remaining)
Downloaded 253992960 of 291168628 bytes (87.2%, 1.0s remaining) ...done. (8 seconds, 0 min)
Extracting data from /home/runner/nilearn_data/haxby2001/def37a305edfda829916fa14c9ea08f8/subj2-2010.01.14.tar.gz..... done.
</pre></div>
</div>
Expand Down Expand Up @@ -304,8 +309,8 @@ <h2>Making the inference with several algorithms<a class="headerlink" href="#mak
<span class="p">)</span>
</pre></div>
</div>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[Parallel(n_jobs=1)]: Done 49 tasks | elapsed: 1.7s
[Parallel(n_jobs=1)]: Done 199 tasks | elapsed: 6.4s
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[Parallel(n_jobs=1)]: Done 49 tasks | elapsed: 1.6s
[Parallel(n_jobs=1)]: Done 199 tasks | elapsed: 6.6s
</pre></div>
</div>
<p>Now, let us run the algorithm introduced by Gaonkar et al. (c.f. References).
Expand Down Expand Up @@ -339,7 +344,7 @@ <h2>Making the inference with several algorithms<a class="headerlink" href="#mak
</pre></div>
</div>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[Parallel(n_jobs=2)]: Using backend LokyBackend with 2 concurrent workers.
[Parallel(n_jobs=2)]: Done 5 out of 5 | elapsed: 31.7s finished
[Parallel(n_jobs=2)]: Done 5 out of 5 | elapsed: 33.4s finished
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -458,8 +463,8 @@ <h2>Analysis of the results<a class="headerlink" href="#analysis-of-the-results"
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 24.013 seconds)</p>
<p><strong>Estimated memory usage:</strong> 2694 MB</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 31.208 seconds)</p>
<p><strong>Estimated memory usage:</strong> 2583 MB</p>
<div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-fmri-data-example-py">
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
<p><a class="reference download internal" download="" href="../_downloads/931385a6992917f918857d6a3ee9f780/plot_fmri_data_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_fmri_data_example.ipynb</span></code></a></p>
Expand All @@ -484,7 +489,7 @@ <h2>Analysis of the results<a class="headerlink" href="#analysis-of-the-results"

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
18 changes: 9 additions & 9 deletions docs/auto_examples/sg_execution_times.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

<li><a href="index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -110,7 +110,7 @@

<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>03:14.567</strong> total execution time for 3 files <strong>from auto_examples</strong>:</p>
<p><strong>03:24.827</strong> total execution time for 3 files <strong>from auto_examples</strong>:</p>
<div class="docutils container">
<style scoped>
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
Expand All @@ -132,16 +132,16 @@
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="plot_fmri_data_example.html#sphx-glr-auto-examples-plot-fmri-data-example-py"><span class="std std-ref">Support recovery on fMRI data</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_fmri_data_example.py</span></code>)</p></td>
<td><p>01:24.013</p></td>
<td><p>2693.7</p></td>
<td><p>01:31.208</p></td>
<td><p>2583.5</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot_2D_simulation_example.html#sphx-glr-auto-examples-plot-2d-simulation-example-py"><span class="std std-ref">Support recovery on simulated data (2D)</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_2D_simulation_example.py</span></code>)</p></td>
<td><p>01:03.609</p></td>
<td><p>98.0</p></td>
<td><p>01:05.968</p></td>
<td><p>98.4</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot_diabetesFeatures_importance_example.html#sphx-glr-auto-examples-plot-diabetesfeatures-importance-example-py"><span class="std std-ref">Variable Importance on diabetes dataset</span></a> (<code class="docutils literal notranslate"><span class="pre">plot_diabetesFeatures_importance_example.py</span></code>)</p></td>
<td><p>00:46.945</p></td>
<td><p>29.1</p></td>
<td><p>00:47.652</p></td>
<td><p>28.3</p></td>
</tr>
</tbody>
</table>
Expand All @@ -160,7 +160,7 @@

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/hidimstat.ada_svr.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

<li><a href="../auto_examples/index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -175,7 +175,7 @@ <h1>hidimstat.ada_svr<a class="headerlink" href="#hidimstat-ada-svr" title="Link

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/hidimstat.aggregate_quantiles.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

<li><a href="../auto_examples/index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -169,7 +169,7 @@ <h1>hidimstat.aggregate_quantiles<a class="headerlink" href="#hidimstat-aggregat

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/hidimstat.clustered_inference.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

<li><a href="../auto_examples/index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -208,7 +208,7 @@ <h1>hidimstat.clustered_inference<a class="headerlink" href="#hidimstat-clustere

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/hidimstat.desparsified_lasso.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

<li><a href="../auto_examples/index.html">Examples</a></li>
<li><a href="../api.html">API</a></li>
<li><a href="https://github.com/Parietal-INRIA/hidimstat">GitHub</a></li>
<li><a href="https://github.com/mind-inria/hidimstat">GitHub</a></li>


<li class="dropdown globaltoc-container">
Expand Down Expand Up @@ -234,7 +234,7 @@ <h1>hidimstat.desparsified_lasso<a class="headerlink" href="#hidimstat-desparsif

</p>
<p>
&copy; Copyright 2024, Parietal-INRIA.<br/>
&copy; Copyright 2024, Mind-Inria.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
Expand Down
Loading

0 comments on commit 1a7b8b0

Please sign in to comment.