Update documentation

mind-inria · Jul 9, 2024 · a4180f4 · a4180f4
1 parent a9cd413
commit a4180f4
Show file tree

Hide file tree

Showing 16 changed files with 50 additions and 51 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/docs/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/docs/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/docs/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/docs/_images/sphx_glr_plot_fmri_data_example_001.png b/docs/_images/sphx_glr_plot_fmri_data_example_001.png
diff --git a/docs/_images/sphx_glr_plot_fmri_data_example_thumb.png b/docs/_images/sphx_glr_plot_fmri_data_example_thumb.png
diff --git a/docs/_sources/auto_examples/plot_2D_simulation_example.rst.txt b/docs/_sources/auto_examples/plot_2D_simulation_example.rst.txt
@@ -542,9 +542,9 @@ randomization.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (1 minutes 12.610 seconds)
+   **Total running time of the script:** (1 minutes 3.609 seconds)
 
-**Estimated memory usage:**  109 MB
+**Estimated memory usage:**  98 MB
 
 
 .. _sphx_glr_download_auto_examples_plot_2D_simulation_example.py:

diff --git a/docs/_sources/auto_examples/plot_diabetesFeatures_importance_example.rst.txt b/docs/_sources/auto_examples/plot_diabetesFeatures_importance_example.rst.txt
@@ -194,9 +194,9 @@ Plotting the comparison
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 47.058 seconds)
+   **Total running time of the script:** (0 minutes 46.945 seconds)
 
-**Estimated memory usage:**  30 MB
+**Estimated memory usage:**  29 MB
 
 
 .. _sphx_glr_download_auto_examples_plot_diabetesFeatures_importance_example.py:

diff --git a/docs/_sources/auto_examples/plot_fmri_data_example.rst.txt b/docs/_sources/auto_examples/plot_fmri_data_example.rst.txt
@@ -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 80322560 of 291168628 bytes (27.6%,    2.6s remaining)    Downloaded 180297728 of 291168628 bytes (61.9%,    1.2s remaining)    Downloaded 280363008 of 291168628 bytes (96.3%,    0.1s remaining) ...done. (3 seconds, 0 min)
+    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)
     Extracting data from /home/runner/nilearn_data/haxby2001/def37a305edfda829916fa14c9ea08f8/subj2-2010.01.14.tar.gz..... done.
 
 
@@ -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.6s
-    [Parallel(n_jobs=1)]: Done 199 tasks      | elapsed:    6.3s
+    [Parallel(n_jobs=1)]: Done  49 tasks      | elapsed:    1.7s
+    [Parallel(n_jobs=1)]: Done 199 tasks      | elapsed:    6.4s
 
 
 
@@ -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:   32.5s finished
+    [Parallel(n_jobs=2)]: Done   5 out of   5 | elapsed:   31.7s finished
 
 
 
@@ -599,9 +599,9 @@ spurious discoveries.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (1 minutes 25.151 seconds)
+   **Total running time of the script:** (1 minutes 24.013 seconds)
 
-**Estimated memory usage:**  2695 MB
+**Estimated memory usage:**  2694 MB
 
 
 .. _sphx_glr_download_auto_examples_plot_fmri_data_example.py:

diff --git a/docs/_sources/auto_examples/sg_execution_times.rst.txt b/docs/_sources/auto_examples/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**03:24.819** total execution time for 3 files **from auto_examples**:
+**03:14.567** total execution time for 3 files **from auto_examples**:
 
 .. container::
 
@@ -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:25.151
-     - 2694.6
+     - 01:24.013
+     - 2693.7
    * - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``plot_2D_simulation_example.py``)
-     - 01:12.610
-     - 108.5
+     - 01:03.609
+     - 98.0
    * - :ref:`sphx_glr_auto_examples_plot_diabetesFeatures_importance_example.py` (``plot_diabetesFeatures_importance_example.py``)
-     - 00:47.058
-     - 29.5
+     - 00:46.945
+     - 29.1
diff --git a/docs/_sources/sg_execution_times.rst.txt b/docs/_sources/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**03:24.819** total execution time for 3 files **from all galleries**:
+**03:14.567** total execution time for 3 files **from all galleries**:
 
 .. container::
 
@@ -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:25.151
-     - 2694.6
+     - 01:24.013
+     - 2693.7
    * - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``../examples/plot_2D_simulation_example.py``)
-     - 01:12.610
-     - 108.5
+     - 01:03.609
+     - 98.0
    * - :ref:`sphx_glr_auto_examples_plot_diabetesFeatures_importance_example.py` (``../examples/plot_diabetesFeatures_importance_example.py``)
-     - 00:47.058
-     - 29.5
+     - 00:46.945
+     - 29.1
diff --git a/docs/auto_examples/plot_2D_simulation_example.html b/docs/auto_examples/plot_2D_simulation_example.html
@@ -473,8 +473,8 @@ <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 12.610 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  109 MB</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (1 minutes 3.609 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">
 <p><a class="reference download internal" download="" href="../_downloads/7d2770a07fbe419760c9ac177df4f69e/plot_2D_simulation_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_2D_simulation_example.ipynb</span></code></a></p>

diff --git a/docs/auto_examples/plot_diabetesFeatures_importance_example.html b/docs/auto_examples/plot_diabetesFeatures_importance_example.html
@@ -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 47.058 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  30 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 46.945 seconds)</p>
+<p><strong>Estimated memory usage:</strong>  29 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>

diff --git a/docs/auto_examples/plot_fmri_data_example.html b/docs/auto_examples/plot_fmri_data_example.html
@@ -252,9 +252,8 @@ <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 80322560 of 291168628 bytes (27.6%,    2.6s remaining)
-Downloaded 180297728 of 291168628 bytes (61.9%,    1.2s remaining)
-Downloaded 280363008 of 291168628 bytes (96.3%,    0.1s remaining) ...done. (3 seconds, 0 min)
+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)
 Extracting data from /home/runner/nilearn_data/haxby2001/def37a305edfda829916fa14c9ea08f8/subj2-2010.01.14.tar.gz..... done.
 </pre></div>
 </div>
@@ -305,8 +304,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.6s
-[Parallel(n_jobs=1)]: Done 199 tasks      | elapsed:    6.3s
+<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
 </pre></div>
 </div>
 <p>Now, let us run the algorithm introduced by Gaonkar et al. (c.f. References).
@@ -340,7 +339,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:   32.5s finished
+[Parallel(n_jobs=2)]: Done   5 out of   5 | elapsed:   31.7s finished
 </pre></div>
 </div>
 </section>
@@ -459,8 +458,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 25.151 seconds)</p>
-<p><strong>Estimated memory usage:</strong>  2695 MB</p>
+<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>
 <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>

diff --git a/docs/auto_examples/sg_execution_times.html b/docs/auto_examples/sg_execution_times.html
@@ -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:24.819</strong> total execution time for 3 files <strong>from auto_examples</strong>:</p>
+<p><strong>03:14.567</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" />
@@ -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:25.151</p></td>
-<td><p>2694.6</p></td>
+<td><p>01:24.013</p></td>
+<td><p>2693.7</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:12.610</p></td>
-<td><p>108.5</p></td>
+<td><p>01:03.609</p></td>
+<td><p>98.0</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:47.058</p></td>
-<td><p>29.5</p></td>
+<td><p>00:46.945</p></td>
+<td><p>29.1</p></td>
 </tr>
 </tbody>
 </table>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/sg_execution_times.html b/docs/sg_execution_times.html
@@ -110,7 +110,7 @@
 
   <section id="computation-times">
 <span id="sphx-glr-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">¶</a></h1>
-<p><strong>03:24.819</strong> total execution time for 3 files <strong>from all galleries</strong>:</p>
+<p><strong>03:14.567</strong> total execution time for 3 files <strong>from all galleries</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" />
@@ -132,16 +132,16 @@
 </thead>
 <tbody>
 <tr class="row-even"><td><p><a class="reference internal" href="auto_examples/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">../examples/plot_fmri_data_example.py</span></code>)</p></td>
-<td><p>01:25.151</p></td>
-<td><p>2694.6</p></td>
+<td><p>01:24.013</p></td>
+<td><p>2693.7</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="auto_examples/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">../examples/plot_2D_simulation_example.py</span></code>)</p></td>
-<td><p>01:12.610</p></td>
-<td><p>108.5</p></td>
+<td><p>01:03.609</p></td>
+<td><p>98.0</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="auto_examples/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">../examples/plot_diabetesFeatures_importance_example.py</span></code>)</p></td>
-<td><p>00:47.058</p></td>
-<td><p>29.5</p></td>
+<td><p>00:46.945</p></td>
+<td><p>29.1</p></td>
 </tr>
 </tbody>
 </table>