SpikeInterface / SpikeInterface/spikeinterface
Standardising parts of the API.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 847
- Forks
- 280
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 29
Description
Following a conversion in #2299, a number of instances where the API is inconsistent were highlighted. This issue is opened as a place to discuss and begin fixing these:
ZeroChannelPaddedRecordingsaves it's parent recording to aparent_recordingkwarg not arecordingkwarg that seems to be used elsewhere.ZeroSilencePeriodsstores the parent recording as a dict not a recording.CurationSortinguses aparent_sortingrather thansortingfoldervs.output_folderargument.
More genreally, I think SI is becomming a very mature and widely used package and freezing the API / defaults as much as possible between versions would really enhance user experience / avoid bugs. I wonder if at some stage a full review of the API could be performed (this would entail multiple people going through every SI function / class and making notes on function names and default arguments inconsistencies or room for improvement). Then these could be discussed, frozen, and only changed in future with a very good reason. I wonder what people think about this.
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 reviewing the API for ZeroChannelPaddedRecording, ZeroSilencePeriods, CurationSorting, and the folder/output_folder arguments, along with their current usages. Done would require an agreed, consistent naming and parent-object convention across these cases, plus a broader review and decision on which API and defaults should be frozen.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100