Skip to content

Commit 117b1a7

Browse files
committed
DOC add running time warning in banded ridge example
1 parent 0151910 commit 117b1a7

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

tutorials/movies_3T/04_plot_banded_ridge_model.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@
66
In this example, we model the fMRI responses with a `banded ridge regression`,
77
with two different feature spaces: motion energy, and wordnet categories.
88
9-
Since the relative scaling of both feature spaces is unknown, we use two
10-
regularization hyperparameters (one per feature space) in a model called banded
11-
ridge regression [1]_. Just like with ridge regression, we optimize the
12-
hyperparameters over cross-validation. An efficient implementation of this
13-
model is available in the `himalaya <https://github.com/gallantlab/himalaya>`_
14-
package.
9+
*Banded ridge regression:* Since the relative scaling of both feature spaces is
10+
unknown, we use two regularization hyperparameters (one per feature space) in a
11+
model called banded ridge regression [1]_. Just like with ridge regression, we
12+
optimize the hyperparameters over cross-validation. An efficient implementation
13+
of this model is available in the `himalaya
14+
<https://github.com/gallantlab/himalaya>`_ package.
15+
16+
*Running time:* This example is more computationally intensive than previous
17+
examples. With a GPU backend, the fitting of this model takes around 6 minutes.
18+
With a CPU backend, it can last 10 times more.
1519
"""
1620
# sphinx_gallery_thumbnail_number = 2
1721
###############################################################################

tutorials/notebooks/movies_3T/04_plot_banded_ridge_model.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"cell_type": "markdown",
1616
"metadata": {},
1717
"source": [
18-
"\n# Fit a banded ridge model with both wordnet and motion energy features\n\n\nIn this example, we model the fMRI responses with a `banded ridge regression`,\nwith two different feature spaces: motion energy, and wordnet categories.\n\nSince the relative scaling of both feature spaces is unknown, we use two\nregularization hyperparameters (one per feature space) in a model called banded\nridge regression [1]_. Just like with ridge regression, we optimize the\nhyperparameters over cross-validation. An efficient implementation of this\nmodel is available in the `himalaya <https://github.com/gallantlab/himalaya>`_\npackage.\n"
18+
"\n# Fit a banded ridge model with both wordnet and motion energy features\n\n\nIn this example, we model the fMRI responses with a `banded ridge regression`,\nwith two different feature spaces: motion energy, and wordnet categories.\n\n*Banded ridge regression:* Since the relative scaling of both feature spaces is\nunknown, we use two regularization hyperparameters (one per feature space) in a\nmodel called banded ridge regression [1]_. Just like with ridge regression, we\noptimize the hyperparameters over cross-validation. An efficient implementation\nof this model is available in the `himalaya\n<https://github.com/gallantlab/himalaya>`_ package.\n\n*Running time:* This example is more computationally intensive than previous\nexamples. With a GPU backend, the fitting of this model takes around 6 minutes.\nWith a CPU backend, it can last 10 times more.\n"
1919
]
2020
},
2121
{

0 commit comments

Comments
 (0)