From d6e93f7d2d42aaf160600484148c245bad2240cb Mon Sep 17 00:00:00 2001 From: GitHub actions Date: Thu, 20 Feb 2025 09:23:56 +0000 Subject: [PATCH] Update documentation --- .../plot_variable_importance_classif.zip | Bin 22104 -> 22104 bytes .../auto_examples_python.zip | Bin 54255 -> 54284 bytes .../plot_dcrt_example.zip | Bin 6608 -> 6608 bytes .../plot_knockoff_aggregation.zip | Bin 10079 -> 10079 bytes .../plot_fmri_data_example.zip | Bin 30907 -> 30965 bytes .../auto_examples_jupyter.zip | Bin 67099 -> 67128 bytes ...t_diabetes_variable_importance_example.zip | Bin 21186 -> 21186 bytes .../plot_fmri_data_example.py | 2 +- .../plot_fmri_data_example.ipynb | 2 +- .../plot_2D_simulation_example.zip | Bin 30558 -> 30558 bytes docs/_sources/api.rst.txt | 1 - docs/_sources/auto_examples/index.rst.txt | 18 +- .../plot_2D_simulation_example.rst.txt | 2 +- .../auto_examples/plot_dcrt_example.rst.txt | 2 +- ...abetes_variable_importance_example.rst.txt | 2 +- .../plot_fmri_data_example.rst.txt | 26 ++- .../plot_knockoff_aggregation.rst.txt | 4 +- .../plot_variable_importance_classif.rst.txt | 15 +- .../auto_examples/sg_execution_times.rst.txt | 26 +-- .../generated/hidimstat.ada_svr.rst.txt | 6 - docs/_sources/sg_execution_times.rst.txt | 26 +-- docs/_static/documentation_options.js | 2 +- docs/_static/searchtools.js | 13 +- docs/api.html | 43 ++-- docs/auto_examples/index.html | 13 +- .../plot_2D_simulation_example.html | 8 +- docs/auto_examples/plot_dcrt_example.html | 8 +- ..._diabetes_variable_importance_example.html | 8 +- .../auto_examples/plot_fmri_data_example.html | 42 ++-- .../plot_knockoff_aggregation.html | 10 +- .../plot_variable_importance_classif.html | 18 +- docs/auto_examples/sg_execution_times.html | 32 +-- docs/generated/hidimstat.CPI.html | 8 +- docs/generated/hidimstat.LOCO.html | 8 +- .../hidimstat.PermutationImportance.html | 8 +- docs/generated/hidimstat.ada_svr.html | 184 ------------------ .../hidimstat.aggregate_quantiles.html | 10 +- .../hidimstat.clustered_inference.html | 6 +- docs/generated/hidimstat.data_simulation.html | 6 +- .../hidimstat.desparsified_lasso.html | 6 +- ...idimstat.ensemble_clustered_inference.html | 6 +- docs/generated/hidimstat.group_reid.html | 6 +- docs/generated/hidimstat.hd_inference.html | 6 +- .../hidimstat.knockoff_aggregation.html | 6 +- .../generated/hidimstat.model_x_knockoff.html | 6 +- .../hidimstat.multivariate_1D_simulation.html | 6 +- .../generated/hidimstat.permutation_test.html | 6 +- .../hidimstat.permutation_test_pval.html | 6 +- docs/generated/hidimstat.reid.html | 6 +- .../generated/hidimstat.standardized_svr.html | 6 +- .../generated/hidimstat.zscore_from_pval.html | 6 +- docs/genindex.html | 10 +- docs/index.html | 6 +- docs/objects.inv | Bin 1541 -> 1522 bytes docs/py-modindex.html | 6 +- docs/search.html | 6 +- docs/searchindex.js | 2 +- docs/sg_execution_times.html | 32 +-- 58 files changed, 258 insertions(+), 435 deletions(-) delete mode 100644 docs/_sources/generated/hidimstat.ada_svr.rst.txt delete mode 100644 docs/generated/hidimstat.ada_svr.html diff --git a/docs/_downloads/06bb0f682e15138dfd659b791a14e9c6/plot_variable_importance_classif.zip b/docs/_downloads/06bb0f682e15138dfd659b791a14e9c6/plot_variable_importance_classif.zip index a29ba151ed7ec0bef436f309705eba4040eb1a50..c6c28aa3d2747574075d98b75935fbfb3ec55cac 100644 GIT binary patch delta 48 ycmcbyhVjN4M&1B#W)=|!5LoFIvXS?L8uKo%kWK0<^_YSD$!kLWK>W#nL!$w8*ATk^ delta 48 ycmcbyhVjN4M&1B#W)=|!5V-0Qw2}9N8uJ^EpiSy4^_YSD$!kLWK>W#nL!$wLgAr!{ diff --git a/docs/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/docs/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip index f17e32fc34d5ecfcc579090e440b7ac713348a69..791cda9f7aa418b7bc77b6253b723eea5376dbff 100644 GIT binary patch delta 201 zcmaFAoVjNOGjD)5Gm8iV2(0u9*~t4*jmaxylX|rZ?=G*9sOnvbcix&XFudK|;k}bf zv7jWeB(p3vz96+Iw-m(A&x>6gP#eBvyWOHjnuORbkAVYLg z6c^CQ&4qJTn=%8fm@I$EAIP6va48(sipf_lS%I`p7Q8IYICZk_Wo?lD$g4jv cDj-dBFH18u&Y9dWM}G3n%K~h=mq6|Y0I`@&1poj5 delta 204 zcmeBK!Tf$XGjD)5Gm8iV2we3D+Q|D+jmaZulX|rZ?@EuLsG7rWcP^MPFkIN&;k}cK zCBC?lRHC28`Bxw&4nA{@i0{{_L3-tg1 diff --git a/docs/_downloads/1a99dc8cb1c22f91072d67cf26fce26c/plot_knockoff_aggregation.zip b/docs/_downloads/1a99dc8cb1c22f91072d67cf26fce26c/plot_knockoff_aggregation.zip index 84ad1c1e00b37f41cb6a509253df850329670ad4..6adfd9fe186619e9b29355a2a581af8dff2c3847 100644 GIT binary patch delta 45 wcmccbci)dUz?+#xgaHK3c!q4`?Gt433fVkYP*Ic_$e(;r%>&4v%&i^*04Qt?0ssI2 delta 45 wcmccbci)dUz?+#xgaHJ+-Gesr_6ah11Z|!xs3^(|>q`@y=Tl1_lt8oNQkqv(bDemtsLlVo7FMYJ5Rz zQEn-Sou3z9l2MdeoROcC5+58EwD}5`trqWlpaH$f?~Ok=F))1CEN6O$n+To%9F)v? mQLLV`$K(~VdAnYTF7JDf3QX^1VT?kxWBL~sMmss6t(w0U<~;>E3WVjsZi5g@8oj3n zurlg_44&S|$|%j4JAE!IqdG{ByIJywqYexVAglmU4knj0x=eq>%4p2y&cX;3001D1 BO9=n~ delta 196 zcmdnd!!o;vg*U*PnMH&F1m1WAZRA~{$K(;TdAnYTF7H*3peTm-s_QO0F)&=-Y!P#Z zn&5L1QeLQiiI%>)tKpm ztc-RbsX$gnX-2*2xvY$OATy@V1Mvf +
.. only:: html - .. image:: /auto_examples/images/thumb/sphx_glr_plot_fmri_data_example_thumb.png + .. image:: /auto_examples/images/thumb/sphx_glr_plot_variable_importance_classif_thumb.png :alt: - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` + :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` .. raw:: html -
Support recovery on fMRI data
+
Measuring variable importance in classification
.. raw:: html -
+
.. only:: html - .. image:: /auto_examples/images/thumb/sphx_glr_plot_variable_importance_classif_thumb.png + .. image:: /auto_examples/images/thumb/sphx_glr_plot_fmri_data_example_thumb.png :alt: - :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` + :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` .. raw:: html -
Measuring variable importance in classification
+
Support recovery on fMRI data
@@ -133,8 +133,8 @@ Examples Gallery /auto_examples/plot_knockoff_aggregation /auto_examples/plot_diabetes_variable_importance_example /auto_examples/plot_2D_simulation_example - /auto_examples/plot_fmri_data_example /auto_examples/plot_variable_importance_classif + /auto_examples/plot_fmri_data_example .. only:: html diff --git a/docs/_sources/auto_examples/plot_2D_simulation_example.rst.txt b/docs/_sources/auto_examples/plot_2D_simulation_example.rst.txt index 9ee5c5e6..da7571b2 100644 --- a/docs/_sources/auto_examples/plot_2D_simulation_example.rst.txt +++ b/docs/_sources/auto_examples/plot_2D_simulation_example.rst.txt @@ -554,7 +554,7 @@ randomization. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (1 minutes 5.593 seconds) + **Total running time of the script:** (1 minutes 5.804 seconds) **Estimated memory usage:** 722 MB diff --git a/docs/_sources/auto_examples/plot_dcrt_example.rst.txt b/docs/_sources/auto_examples/plot_dcrt_example.rst.txt index 8b44d8cc..ef00f2ff 100644 --- a/docs/_sources/auto_examples/plot_dcrt_example.rst.txt +++ b/docs/_sources/auto_examples/plot_dcrt_example.rst.txt @@ -162,7 +162,7 @@ Plotting the comparison .. rst-class:: sphx-glr-timing - **Total running time of the script:** (1 minutes 2.729 seconds) + **Total running time of the script:** (1 minutes 2.893 seconds) **Estimated memory usage:** 658 MB diff --git a/docs/_sources/auto_examples/plot_diabetes_variable_importance_example.rst.txt b/docs/_sources/auto_examples/plot_diabetes_variable_importance_example.rst.txt index b615aede..1cccd4b7 100644 --- a/docs/_sources/auto_examples/plot_diabetes_variable_importance_example.rst.txt +++ b/docs/_sources/auto_examples/plot_diabetes_variable_importance_example.rst.txt @@ -491,7 +491,7 @@ Analyze the results .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 8.186 seconds) + **Total running time of the script:** (0 minutes 8.329 seconds) **Estimated memory usage:** 643 MB diff --git a/docs/_sources/auto_examples/plot_fmri_data_example.rst.txt b/docs/_sources/auto_examples/plot_fmri_data_example.rst.txt index d4919215..1868a609 100644 --- a/docs/_sources/auto_examples/plot_fmri_data_example.rst.txt +++ b/docs/_sources/auto_examples/plot_fmri_data_example.rst.txt @@ -79,7 +79,7 @@ Imports needed for this script from sklearn.svm import LinearSVR from sklearn.utils import Bunch - from hidimstat.ada_svr import ada_svr + from hidimstat.adaptative_permutation_threshold_SVR import ada_svr from hidimstat.clustered_inference import clustered_inference from hidimstat.ensemble_clustered_inference import ensemble_clustered_inference from hidimstat.permutation_test import permutation_test, permutation_test_pval @@ -179,15 +179,25 @@ 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 94011392 of 291168628 bytes (32.3%%, 2.1s remaining) - [_chunk_report_] Downloaded 212819968 of 291168628 bytes (73.1%%, 0.7s remaining) - [fetch_single_file] ...done. (3 seconds, 0 min) + [_chunk_report_] Downloaded 15261696 of 291168628 bytes (5.2%%, 18.2s remaining) + [_chunk_report_] Downloaded 53190656 of 291168628 bytes (18.3%%, 9.1s remaining) + [_chunk_report_] Downloaded 91701248 of 291168628 bytes (31.5%%, 6.6s remaining) + [_chunk_report_] Downloaded 129933312 of 291168628 bytes (44.6%%, 5.0s remaining) + [_chunk_report_] Downloaded 156491776 of 291168628 bytes (53.7%%, 4.4s remaining) + [_chunk_report_] Downloaded 178135040 of 291168628 bytes (61.2%%, 3.9s remaining) + [_chunk_report_] Downloaded 196550656 of 291168628 bytes (67.5%%, 3.4s remaining) + [_chunk_report_] Downloaded 213925888 of 291168628 bytes (73.5%%, 2.9s remaining) + [_chunk_report_] Downloaded 232153088 of 291168628 bytes (79.7%%, 2.3s remaining) + [_chunk_report_] Downloaded 250953728 of 291168628 bytes (86.2%%, 1.6s remaining) + [_chunk_report_] Downloaded 270131200 of 291168628 bytes (92.8%%, 0.9s remaining) + [_chunk_report_] Downloaded 289538048 of 291168628 bytes (99.4%%, 0.1s remaining) + [fetch_single_file] ...done. (12 seconds, 0 min) [uncompress_file] Extracting data from /home/runner/nilearn_data/haxby2001/9cabe068089e791ef0c5fe930fc20e30/subj2-2010.01.14.tar.gz... [uncompress_file] .. done. @@ -375,7 +385,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.0s finished + [Parallel(n_jobs=2)]: Done 5 out of 5 | elapsed: 34.1s finished @@ -620,9 +630,9 @@ spurious discoveries. .. rst-class:: sphx-glr-timing - **Total running time of the script:** (1 minutes 23.795 seconds) + **Total running time of the script:** (1 minutes 37.697 seconds) -**Estimated memory usage:** 3287 MB +**Estimated memory usage:** 3398 MB .. _sphx_glr_download_auto_examples_plot_fmri_data_example.py: diff --git a/docs/_sources/auto_examples/plot_knockoff_aggregation.rst.txt b/docs/_sources/auto_examples/plot_knockoff_aggregation.rst.txt index 2304b1e7..ba70f418 100644 --- a/docs/_sources/auto_examples/plot_knockoff_aggregation.rst.txt +++ b/docs/_sources/auto_examples/plot_knockoff_aggregation.rst.txt @@ -205,9 +205,9 @@ Imports needed for this script .. rst-class:: sphx-glr-timing - **Total running time of the script:** (5 minutes 40.613 seconds) + **Total running time of the script:** (5 minutes 39.238 seconds) -**Estimated memory usage:** 841 MB +**Estimated memory usage:** 793 MB .. _sphx_glr_download_auto_examples_plot_knockoff_aggregation.py: diff --git a/docs/_sources/auto_examples/plot_variable_importance_classif.rst.txt b/docs/_sources/auto_examples/plot_variable_importance_classif.rst.txt index 438937e9..13946bd7 100644 --- a/docs/_sources/auto_examples/plot_variable_importance_classif.rst.txt +++ b/docs/_sources/auto_examples/plot_variable_importance_classif.rst.txt @@ -176,7 +176,7 @@ Visualize the data .. code-block:: none - [, , , , , , , , , ] + [, , , , , , , , , ] @@ -283,13 +283,6 @@ estimate the importance of the features. -.. rst-class:: sphx-glr-script-out - - .. code-block:: none - - /opt/hostedtoolcache/Python/3.12.9/x64/lib/python3.12/site-packages/joblib/externals/loky/process_executor.py:752: UserWarning: A worker stopped while some jobs were given to the executor. This can be caused by a too short worker timeout or by a memory leak. - warnings.warn( - @@ -422,16 +415,16 @@ the features. .. code-block:: none - + .. rst-class:: sphx-glr-timing - **Total running time of the script:** (0 minutes 42.709 seconds) + **Total running time of the script:** (0 minutes 33.797 seconds) -**Estimated memory usage:** 639 MB +**Estimated memory usage:** 640 MB .. _sphx_glr_download_auto_examples_plot_variable_importance_classif.py: diff --git a/docs/_sources/auto_examples/sg_execution_times.rst.txt b/docs/_sources/auto_examples/sg_execution_times.rst.txt index 5fc9fcbf..4c68deb5 100644 --- 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 ================= -**10:03.624** total execution time for 6 files **from auto_examples**: +**10:07.758** total execution time for 6 files **from auto_examples**: .. container:: @@ -33,20 +33,20 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_auto_examples_plot_knockoff_aggregation.py` (``plot_knockoff_aggregation.py``) - - 05:40.613 - - 841.3 + - 05:39.238 + - 793.3 * - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``plot_fmri_data_example.py``) - - 01:23.795 - - 3287.3 + - 01:37.697 + - 3398.5 * - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``plot_2D_simulation_example.py``) - - 01:05.593 - - 722.1 + - 01:05.804 + - 722.0 * - :ref:`sphx_glr_auto_examples_plot_dcrt_example.py` (``plot_dcrt_example.py``) - - 01:02.729 - - 658.2 + - 01:02.893 + - 657.6 * - :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` (``plot_variable_importance_classif.py``) - - 00:42.709 - - 639.3 + - 00:33.797 + - 639.7 * - :ref:`sphx_glr_auto_examples_plot_diabetes_variable_importance_example.py` (``plot_diabetes_variable_importance_example.py``) - - 00:08.186 - - 643.0 + - 00:08.329 + - 642.8 diff --git a/docs/_sources/generated/hidimstat.ada_svr.rst.txt b/docs/_sources/generated/hidimstat.ada_svr.rst.txt deleted file mode 100644 index ed3dccff..00000000 --- a/docs/_sources/generated/hidimstat.ada_svr.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -hidimstat.ada\_svr -================== - -.. currentmodule:: hidimstat - -.. autofunction:: ada_svr \ No newline at end of file diff --git a/docs/_sources/sg_execution_times.rst.txt b/docs/_sources/sg_execution_times.rst.txt index 9122dec7..ecdc2076 100644 --- a/docs/_sources/sg_execution_times.rst.txt +++ b/docs/_sources/sg_execution_times.rst.txt @@ -6,7 +6,7 @@ Computation times ================= -**10:03.624** total execution time for 6 files **from all galleries**: +**10:07.758** total execution time for 6 files **from all galleries**: .. container:: @@ -33,20 +33,20 @@ Computation times - Time - Mem (MB) * - :ref:`sphx_glr_auto_examples_plot_knockoff_aggregation.py` (``../examples/plot_knockoff_aggregation.py``) - - 05:40.613 - - 841.3 + - 05:39.238 + - 793.3 * - :ref:`sphx_glr_auto_examples_plot_fmri_data_example.py` (``../examples/plot_fmri_data_example.py``) - - 01:23.795 - - 3287.3 + - 01:37.697 + - 3398.5 * - :ref:`sphx_glr_auto_examples_plot_2D_simulation_example.py` (``../examples/plot_2D_simulation_example.py``) - - 01:05.593 - - 722.1 + - 01:05.804 + - 722.0 * - :ref:`sphx_glr_auto_examples_plot_dcrt_example.py` (``../examples/plot_dcrt_example.py``) - - 01:02.729 - - 658.2 + - 01:02.893 + - 657.6 * - :ref:`sphx_glr_auto_examples_plot_variable_importance_classif.py` (``../examples/plot_variable_importance_classif.py``) - - 00:42.709 - - 639.3 + - 00:33.797 + - 639.7 * - :ref:`sphx_glr_auto_examples_plot_diabetes_variable_importance_example.py` (``../examples/plot_diabetes_variable_importance_example.py``) - - 00:08.186 - - 643.0 + - 00:08.329 + - 642.8 diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index fafe80e6..28b680e5 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.1.dev1+g349ade8', + VERSION: '0.1.dev1+g635d003', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 2c774d17..91f4be57 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -513,9 +513,11 @@ const Search = { // perform the search on the required terms searchTerms.forEach((word) => { const files = []; + // find documents, if any, containing the query word in their text/title term indices + // use Object.hasOwnProperty to avoid mismatching against prototype properties const arr = [ - { files: terms[word], score: Scorer.term }, - { files: titleTerms[word], score: Scorer.title }, + { files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term }, + { files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title }, ]; // add support for partial matches if (word.length > 2) { @@ -547,8 +549,9 @@ const Search = { // set score for the word in each file recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, {}); - scoreMap.get(file)[word] = record.score; + if (!scoreMap.has(file)) scoreMap.set(file, new Map()); + const fileScores = scoreMap.get(file); + fileScores.set(word, record.score); }); }); @@ -587,7 +590,7 @@ const Search = { break; // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w))); // add result to the result list results.push([ docNames[file], diff --git a/docs/api.html b/docs/api.html index a521dac1..6cbccd20 100644 --- a/docs/api.html +++ b/docs/api.html @@ -5,7 +5,7 @@ - API Documentation — HiDimStat 0.1.dev1+g349ade8 documentation + API Documentation — HiDimStat 0.1.dev1+g635d003 documentation @@ -13,12 +13,12 @@ - + - + @@ -105,7 +105,7 @@
  • - +