SpikeInterface / SpikeInterface/spikeinterface
Add additional "check functions" for modules à la `available_sorters`
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 847
- Forks
- 280
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 29
Description
Hello, I'd quite like the user to be able to get a list of available preprocessing steps, like we have for sorters: https://github.com/SpikeInterface/spikeinterface/blob/d142fe41d7b6177aea2591d68196b7cf4b6354a3/src/spikeinterface/sorters/sorterlist.py#L56
So I'd like to expose a list, which is something like:
available_preprocessors = [foo.__name__ for foo in pp.preprocessor_dict.values()]
Originally posted by @chrishalcrow in https://github.com/SpikeInterface/spikeinterface/pull/3898#discussion_r2075021023
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the referenced sorterlist.py implementation and locate the preprocessing module's preprocessor_dict. Trace how the sorter list is exposed to users, then determine the corresponding public location for available preprocessing names. The work is done when users can retrieve that list consistently with the existing sorter availability check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data, developer-experience
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100