Repository navigation
Fix manual split example in process_by_channel_group docs - #4846
Merged
Merged
Conversation
The "Option 2: Manual splitting" loop passed the whole dict of split recordings to run_sorter instead of the per-group sub_recording. That sorts every group on each iteration and returns a dict, not a sorting.
alejoe91
reviewed
Oct 9, 2026
alejoe91
approved these changes
Oct 9, 2026
alejoe91
added a commit
to alejoe91/spikeinterface
that referenced
this pull request
Oct 9, 2026
…face#4846) Co-authored-by: guptaishaan <guptaishaan@users.noreply.github.com> Co-authored-by: Alessio Buccino <alejoe9187@gmail.com>
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.
Fixes #4843
The "Option 2: Manual splitting" example in
doc/how_to/process_by_channel_group.rstpassedrecording=split_preprocessed_recording(the dict) torun_sorterinside the loop.run_sortersorts all groups when given a dict, so each iteration sorted every group and returned a dict. It should passsub_recording.Thanks to @elduvelle for spotting this.
Verified with the
simplesorter on an 8-channel recording split into 2 groups, on a CPU-only Linux node. Before: each iteration returned a dict with keys[0, 1]. After: each iteration returns one sorting for its own group.Not verified: the sphinx docs build, and Kilosort2 itself (same
run_sorterdict dispatch applies). No test added since this is an rst code block.