Docs: clarify MNE call sites in preprocessing and paradigm pipelines#1050
Merged
bruAristimunha merged 7 commits intoNeuroTechX:developfrom Apr 6, 2026
Merged
Conversation
- Add docstrings for get_filter/crop/resample_pipeline (BaseRaw.filter/crop/resample) - Clarify NamedFunctionTransformer role (methodcaller + MNE Raw methods) - Document SetRawAnnotations, RawToEvents, RawToEpochs, related transformers - Inline comments for Epochs.load_data / get_data steps in BaseProcessing Made-with: Cursor
Enable sklearn's built-in interactive HTML repr for all MOABB
preprocessing classes so pipelines render as clear diagrams in
Jupyter notebooks and sphinx-gallery docs.
- FixedPipeline: override named_steps, get_params, __repr__, and
_sk_visual_block_ to convert StepType enum keys to readable
strings and flatten single-step wrapper pipelines
- FixedTransformer: add _get_visual_name/_get_visual_details hooks
with _sk_visual_block_ using kind="single" (replaces broken
kind="parallel" with raw dict dump)
- ForkPipelines: label passthrough branches, clean None pipelines
- All transformer subclasses: add __repr__ and _get_visual_details
showing key parameters (events, interval, tmin/tmax, baseline)
- NamedFunctionTransformer: display_name shown in diagram labels
- base.py: replace bare FunctionTransformer with
NamedFunctionTransformer for get_data/scaling/load_data steps;
use explicit step names ("extract events", "create epochs")
- Tutorial: show filter bank as HTML diagram instead of print loop
bruAristimunha
approved these changes
Apr 6, 2026
Collaborator
|
Hey @zmunro, Many thanks for this PR! I took advantage of your PR and also corrected some details in the scikit-learn Pipeline visualization. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only change: make it obvious which MNE APIs are invoked behind sklearn
FunctionTransformer/methodcallerglue.Changes
get_filter_pipeline,get_crop_pipeline,get_resample_pipeline: docstrings pointing atmne.io.BaseRaw.filter/crop/resampleNamedFunctionTransformer: explains typical use with MNERawmethodsSetRawAnnotations,RawToEvents,RawToEventsP300,RawToFixedIntervalEvents,EpochsToEvents,EventsToLabels,RawToEpochs: short class docstrings tied to MNE where applicablemoabb/paradigms/base.py: inline comments forEpochs.load_data/get_datapipeline stepsNotes
--no-verifydue to a slow first-time pre-commit install in this environment; I can runpre-commit run --all-fileslocally aftergh auth loginif you want the hooks on record.