Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

enhance documentation of caching, continuation of #914 #918

Merged
merged 2 commits into from
Apr 2, 2024
Merged

enhance documentation of caching, continuation of #914 #918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
887c429
enhance documentation of caching
SophieHerbst Apr 2, 2024
4b65f92
Update mne_bids_pipeline/_config.py
SophieHerbst Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/v1.9.md.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

- We removed the `Execution` section from configuration options documentation and
replaced it with new, more explicit sections (namely, Caching, Parallelization,
Logging, and Error handling). (#914 by @hoechenberger)
Logging, and Error handling), and enhanced documentation. (#914 by @hoechenberger, #916 by @SophieHerbst)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Logging, and Error handling), and enhanced documentation. (#914 by @hoechenberger, #916 by @SophieHerbst)
Logging, and Error handling), and enhanced documentation. (#914, #916 by @hoechenberger and @SophieHerbst)


### :bug: Bug fixes

Expand Down
8 changes: 6 additions & 2 deletions mne_bids_pipeline/_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2174,8 +2174,12 @@ def noise_cov(bids_path):
# %%
# # Caching
#
# These settings control if and how pipeline output is being cached to avoid unnecessary
# computations on a re-run.
# Per default, the pipeline output is cached (temporarily stored),
# to avoid unnecessary reruns of previously computed steps.
# Yet, for consistency, changes in configuration parameters trigger
# automatic reruns of previous steps.
# !!! info
# To force rerunning a given step, run the pipeline with the option: `--no-cache`.

memory_location: PathLike | bool | None = True
"""
Expand Down
Loading