Docs: clarify MNE call sites in preprocessing and paradigm pipelines#1050
Open
zmunro wants to merge 2 commits intoNeuroTechX:developfrom
Open
Docs: clarify MNE call sites in preprocessing and paradigm pipelines#1050zmunro wants to merge 2 commits intoNeuroTechX:developfrom
zmunro wants to merge 2 commits intoNeuroTechX:developfrom
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
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
1 participant
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.