SpikeInterface / SpikeInterface/spikeinterface

Unify slicing behavior in SpikeInterface

Open
#1,989 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

core discussion
Dominant language
Python
Stars
847
Forks
280
Avg merge
3d 9h
Merged PRs (30d)
29

Description

Related to #1881, #1886 and #1979 .

Let's discuss how we should handle the behavior of start_frame/end_frame/channel_ids in the get_traces().
Plus, let's discuss how to do add generalizing testing once we reach consensus.

Some proposals:

  1. Be restrictive:
  • end_frame > start_frame: passing start_frame == end_frame will raise an Exception
  • end_frame < num_samples
  1. Numpy-like

For the channel_ids is the behavior is already established, but we should consider adding tests for them when we add generalized testing.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion in issues #1881, #1886, and #1979, then compare the existing get_traces() behavior for start_frame, end_frame, and channel_ids. Resolve the slicing policy before designing generalized tests; done means consensus on the behavior and corresponding coverage for these parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.