Quality metrics "isolation_distance" and "l_ratio" not available

[chenziao]

The quality metrics "isolation_distance" and "l_ratio" are not available. But in the API, both have been replaced by the metric "mahalanobis". But the documentation is not updated yet.

---

ValueError Traceback (most recent call last)
Cell In[15], line 9
1 metric_names = [
2 'firing_rate', 'presence_ratio', 'snr',
3 'isi_violation', 'amplitude_cutoff',
4 "isolation_distance", "l_ratio", 'd_prime'
5 ]
7 # metrics = analyzer.compute("quality_metrics").get_data()
8 # equivalent to:
----> 9 metrics = si.compute_quality_metrics(analyzer, metric_names=metric_names)
10 metrics

ValueError: Metric isolation_distance not in available metrics ['num_spikes', 'firing_rate', 'presence_ratio', 'snr', 'isi_violation', 'rp_violation', 'sliding_rp_violation', 'synchrony', 'firing_range', 'amplitude_cv', 'amplitude_cutoff', 'noise_cutoff', 'amplitude_median', 'drift', 'sd_ratio', 'mahalanobis', 'd_prime', 'nearest_neighbor', 'silhouette', 'nn_advanced']

[chrishalcrow]

Hi @chenziao, thanks for posting. There is different documentation for every release version of spikeinterface since the API changes. By default, when you go to the docs webpage, it loads the documentation of the last release version. We do this because we think most people are using that version. If you're using the latest si from the main branch, you can "switch version" of the documentation using the little drop down menu at the top of the page:

When you do this, you'll see that they have been updated.

But your issues makes me think we should improve the error a bit. Maybe if a user enters the name of a metric from the previous version we should explain how to compute that metric in the new API.