Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 6, 2025
1 parent 85746e2 commit e710ea9
Show file tree
Hide file tree
Showing 51 changed files with 300 additions and 303 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,9 +554,9 @@ randomization.

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

**Total running time of the script:** (1 minutes 11.585 seconds)
**Total running time of the script:** (1 minutes 11.171 seconds)

**Estimated memory usage:** 747 MB
**Estimated memory usage:** 704 MB


.. _sphx_glr_download_auto_examples_plot_2D_simulation_example.py:
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 4.447 seconds)
**Total running time of the script:** (1 minutes 5.337 seconds)

**Estimated memory usage:** 645 MB
**Estimated memory usage:** 640 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 8.479 seconds)
**Total running time of the script:** (0 minutes 9.424 seconds)

**Estimated memory usage:** 629 MB
**Estimated memory usage:** 625 MB


.. _sphx_glr_download_auto_examples_plot_diabetes_variable_importance_example.py:
Expand Down
25 changes: 12 additions & 13 deletions docs/_sources/auto_examples/plot_fmri_data_example.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -176,20 +176,19 @@ You may choose a subject in [1, 2, 3, 4, 5, 6]. By default subject=2.
[_add_readme_to_default_data_locations] Added README.md to /home/runner/nilearn_data
[get_dataset_dir] Dataset created in /home/runner/nilearn_data/haxby2001
[fetch_single_file] Downloading data from https://www.nitrc.org/frs/download.php/7868/mask.nii.gz ...
[fetch_single_file] ...done. (0 seconds, 0 min)
[fetch_single_file] ...done. (1 seconds, 0 min)
[fetch_single_file] Downloading data from http://data.pymvpa.org/datasets/haxby2001/MD5SUMS ...
[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 21487616 of 291168628 bytes (7.4%%, 14.4s remaining)
[_chunk_report_] Downloaded 50061312 of 291168628 bytes (17.2%%, 10.4s remaining)
[_chunk_report_] Downloaded 92438528 of 291168628 bytes (31.7%%, 6.8s remaining)
[_chunk_report_] Downloaded 137986048 of 291168628 bytes (47.4%%, 4.7s remaining)
[_chunk_report_] Downloaded 189612032 of 291168628 bytes (65.1%%, 2.9s remaining)
[_chunk_report_] Downloaded 244645888 of 291168628 bytes (84.0%%, 1.2s remaining)
[_chunk_report_] Downloaded 282959872 of 291168628 bytes (97.2%%, 0.2s remaining)
[fetch_single_file] ...done. (8 seconds, 0 min)
[_chunk_report_] Downloaded 21749760 of 291168628 bytes (7.5%%, 12.7s remaining)
[_chunk_report_] Downloaded 67272704 of 291168628 bytes (23.1%%, 6.8s remaining)
[_chunk_report_] Downloaded 112746496 of 291168628 bytes (38.7%%, 4.8s remaining)
[_chunk_report_] Downloaded 156139520 of 291168628 bytes (53.6%%, 3.5s remaining)
[_chunk_report_] Downloaded 200409088 of 291168628 bytes (68.8%%, 2.3s remaining)
[_chunk_report_] Downloaded 245473280 of 291168628 bytes (84.3%%, 1.1s remaining)
[fetch_single_file] ...done. (7 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 @@ -294,7 +293,7 @@ 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.5s
[Parallel(n_jobs=1)]: Done 199 tasks | elapsed: 6.7s
Expand Down Expand Up @@ -375,7 +374,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: 33.6s finished
[Parallel(n_jobs=2)]: Done 5 out of 5 | elapsed: 36.0s finished
Expand Down Expand Up @@ -620,9 +619,9 @@ spurious discoveries.
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (1 minutes 31.701 seconds)
**Total running time of the script:** (1 minutes 35.950 seconds)

**Estimated memory usage:** 3210 MB
**Estimated memory usage:** 3251 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 31.729 seconds)
**Total running time of the script:** (5 minutes 51.290 seconds)

**Estimated memory usage:** 835 MB
**Estimated memory usage:** 785 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 0x7fc641d29f40>, <matplotlib.axis.YTick object at 0x7fc725661430>, <matplotlib.axis.YTick object at 0x7fc7255e0500>, <matplotlib.axis.YTick object at 0x7fc7255e2450>, <matplotlib.axis.YTick object at 0x7fc7255e37a0>, <matplotlib.axis.YTick object at 0x7fc7255e2840>, <matplotlib.axis.YTick object at 0x7fc7255e3a40>, <matplotlib.axis.YTick object at 0x7fc7255e0f20>, <matplotlib.axis.YTick object at 0x7fc725586360>, <matplotlib.axis.YTick object at 0x7fc7255e0ec0>]
[<matplotlib.axis.YTick object at 0x7fee88776120>, <matplotlib.axis.YTick object at 0x7fee887745c0>, <matplotlib.axis.YTick object at 0x7fee884de6f0>, <matplotlib.axis.YTick object at 0x7fee884dcc80>, <matplotlib.axis.YTick object at 0x7fee86056ff0>, <matplotlib.axis.YTick object at 0x7fee884dc680>, <matplotlib.axis.YTick object at 0x7fee884dd280>, <matplotlib.axis.YTick object at 0x7fee884dc4a0>, <matplotlib.axis.YTick object at 0x7fee8600fa70>, <matplotlib.axis.YTick object at 0x7fee884df770>]
Expand Down Expand Up @@ -422,16 +422,16 @@ the features.
.. code-block:: none
<matplotlib.legend.Legend object at 0x7fc72571a3c0>
<matplotlib.legend.Legend object at 0x7fee8600ff20>
.. rst-class:: sphx-glr-timing

**Total running time of the script:** (0 minutes 44.851 seconds)
**Total running time of the script:** (0 minutes 44.780 seconds)

**Estimated memory usage:** 625 MB
**Estimated memory usage:** 621 MB


.. _sphx_glr_download_auto_examples_plot_variable_importance_classif.py:
Expand Down
26 changes: 13 additions & 13 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:12.792** total execution time for 6 files **from auto_examples**:
**10:37.954** 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:31.729
- 835.3
- 05:51.290
- 785.0
* - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``plot_fmri_data_example.py``)
- 01:31.701
- 3209.9
- 01:35.950
- 3250.8
* - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``plot_2D_simulation_example.py``)
- 01:11.585
- 747.2
- 01:11.171
- 704.2
* - :ref:`sphx_glr_auto_examples_plot_dcrt_example.py` (``plot_dcrt_example.py``)
- 01:04.447
- 644.6
- 01:05.337
- 639.9
* - :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` (``plot_variable_importance_classif.py``)
- 00:44.851
- 625.0
- 00:44.780
- 621.0
* - :ref:`sphx_glr_auto_examples_plot_diabetes_variable_importance_example.py` (``plot_diabetes_variable_importance_example.py``)
- 00:08.479
- 629.1
- 00:09.424
- 625.3
26 changes: 13 additions & 13 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:12.792** total execution time for 6 files **from all galleries**:
**10:37.954** 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:31.729
- 835.3
- 05:51.290
- 785.0
* - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``../examples/plot_fmri_data_example.py``)
- 01:31.701
- 3209.9
- 01:35.950
- 3250.8
* - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``../examples/plot_2D_simulation_example.py``)
- 01:11.585
- 747.2
- 01:11.171
- 704.2
* - :ref:`sphx_glr_auto_examples_plot_dcrt_example.py` (``../examples/plot_dcrt_example.py``)
- 01:04.447
- 644.6
- 01:05.337
- 639.9
* - :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` (``../examples/plot_variable_importance_classif.py``)
- 00:44.851
- 625.0
- 00:44.780
- 621.0
* - :ref:`sphx_glr_auto_examples_plot_diabetes_variable_importance_example.py` (``../examples/plot_diabetes_variable_importance_example.py``)
- 00:08.479
- 629.1
- 00:09.424
- 625.3
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+g5805c7b',
VERSION: '0.1.dev1+g85746e2',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
66 changes: 33 additions & 33 deletions docs/_static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,70 +6,70 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .hll { background-color: #ffffcc }
.highlight { background: #eeffcc; }
.highlight .c { color: #408090; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .err { border: 1px solid #F00 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .o { color: #666 } /* Operator */
.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .cs { color: #408090; background-color: #FFF0F0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gr { color: #F00 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #333333 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .go { color: #333 } /* Generic.Output */
.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .gt { color: #04D } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #208050 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .s { color: #4070A0 } /* Literal.String */
.highlight .na { color: #4070A0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .nc { color: #0E84B5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60ADD5 } /* Name.Constant */
.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #D55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nf { color: #06287E } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nn { color: #0E84B5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .nv { color: #BB60D5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .w { color: #BBB } /* Text.Whitespace */
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
.highlight .mf { color: #208050 } /* Literal.Number.Float */
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sa { color: #4070A0 } /* Literal.String.Affix */
.highlight .sb { color: #4070A0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070A0 } /* Literal.String.Char */
.highlight .dl { color: #4070A0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070A0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070A0 } /* Literal.String.Double */
.highlight .se { color: #4070A0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070A0 } /* Literal.String.Heredoc */
.highlight .si { color: #70A0D0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #C65D09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .s1 { color: #4070A0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #06287e } /* Name.Function.Magic */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
.highlight .fm { color: #06287E } /* Name.Function.Magic */
.highlight .vc { color: #BB60D5 } /* Name.Variable.Class */
.highlight .vg { color: #BB60D5 } /* Name.Variable.Global */
.highlight .vi { color: #BB60D5 } /* Name.Variable.Instance */
.highlight .vm { color: #BB60D5 } /* Name.Variable.Magic */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
6 changes: 3 additions & 3 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+g5805c7b documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<title>API Documentation &#8212; HiDimStat 0.1.dev1+g85746e2 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=3f4c22f9"></script>
<script src="_static/documentation_options.js?v=2751c6d6"></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
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+g5805c7b documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<title>Examples Gallery &#8212; HiDimStat 0.1.dev1+g85746e2 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=3f4c22f9"></script>
<script src="../_static/documentation_options.js?v=2751c6d6"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
Expand Down
Loading

0 comments on commit e710ea9

Please sign in to comment.