-
Notifications
You must be signed in to change notification settings - Fork 222
Alter how quality metrics check extension dependencies #4080
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
chrishalcrow
wants to merge
14
commits into
SpikeInterface:main
Choose a base branch
from
chrishalcrow:remove-noiselevels-qms
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Alter how quality metrics check extension dependencies #4080
chrishalcrow
wants to merge
14
commits into
SpikeInterface:main
from
chrishalcrow:remove-noiselevels-qms
Conversation
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
That's good for me! For the |
zm711
reviewed
Jul 28, 2025
noise_levels
and templates
from quality metric deps…row/spikeinterface into remove-noiselevels-qms
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR changes how quality metrics are handled when an extension they depend on is missing.
The new behaviour is
si.compute_snr
oranalyzer.compute('quality_metrics', metric_names=['snr']
) and don't have the extension computed, this will error.analyzer.compute('quality_metrics')
), this will compute all metrics it can. It will also gather all the metrics you can't compute, and why, and return a single warning.The warning is e.g.
Technically, we do this by doing a dependency check when we're figuring out which metrics to compute (done in
_set_params
of theComputeQualityMetrics
class). Then we don't include any metrics we don't have the extensions for.If you call e.g.
compute_snrs
, it calls_has_required_extensions
which does a check of the dependencies for a single metric, and raises the error message.A nice consequence: now, the quality metrics extension has no dependencies, and will compute some spike-train related metrics if you give it an extension-less analyzer.
Made quite a big edit to the quality metrics modules docs page. Been meaning to do this for a while: https://spikeinterface--4080.org.readthedocs.build/en/4080/modules/qualitymetrics.html
We had discussed introducing a
UnitMetric
class or something. I think this is simpler for now!