Merge pull request #3635 from alejoe91/fix-hybrid-example

alejoe91 · web-flow · commit 8a59f70455cc · 2025-01-22T17:11:09.000+01:00
Fix precision/recall in hybrid example
diff --git a/doc/how_to/benchmark_with_hybrid_recordings.rst b/doc/how_to/benchmark_with_hybrid_recordings.rst
@@ -2531,9 +2531,8 @@ Although non of the sorters find all units perfectly, ``Kilosort2.5``,
 ``Kilosort4``, and ``SpyKING CIRCUS 2`` all find around 10-12 hybrid
 units with accuracy greater than 80%. ``Kilosort4`` has a better overall
 curve, being able to find almost all units with an accuracy above 50%.
-``Kilosort2.5`` performs well when looking at precision (finding all
-spikes in a hybrid unit), at the cost of lower recall (finding spikes
-when it shouldn’t).
+``Kilosort2.5`` performs well when looking at precision (not finding spikes
+when it shouldn’t), but it has a lower recall (finding all spikes in the ground truth).
 
 In this example, we showed how to:
 
diff --git a/examples/how_to/benchmark_with_hybrid_recordings.py b/examples/how_to/benchmark_with_hybrid_recordings.py
@@ -276,7 +276,8 @@
 # From the performance plots, we can see that there is no clear "winner", but `Kilosort3` definitely performs worse than the other options.
 #
 # Although non of the sorters find all units perfectly, `Kilosort2.5`, `Kilosort4`, and `SpyKING CIRCUS 2` all find around 10-12 hybrid units with accuracy greater than 80%.
-# `Kilosort4` has a better overall curve, being able to find almost all units with an accuracy above 50%. `Kilosort2.5` performs well when looking at precision (finding all spikes in a hybrid unit), at the cost of lower recall (finding spikes when it shouldn't).
+# `Kilosort4` has a better overall curve, being able to find almost all units with an accuracy above 50%. `Kilosort2.5` performs well when looking at precision (not finding spikes
+# when it shouldn’t), but it has a lower recall (finding all spikes in the ground truth).
 #
 #
 # In this example, we showed how to:

Original file line number	Diff line number	Diff line change
`@@ -276,7 +276,8 @@`
`276`	`276`	# From the performance plots, we can see that there is no clear "winner", but `Kilosort3` definitely performs worse than the other options.
`277`	`277`	`#`
`278`	`278`	# Although non of the sorters find all units perfectly, `Kilosort2.5`, `Kilosort4`, and `SpyKING CIRCUS 2` all find around 10-12 hybrid units with accuracy greater than 80%.
`279`		-# `Kilosort4` has a better overall curve, being able to find almost all units with an accuracy above 50%. `Kilosort2.5` performs well when looking at precision (finding all spikes in a hybrid unit), at the cost of lower recall (finding spikes when it shouldn't).
	`279`	+# `Kilosort4` has a better overall curve, being able to find almost all units with an accuracy above 50%. `Kilosort2.5` performs well when looking at precision (not finding spikes
	`280`	`+# when it shouldn’t), but it has a lower recall (finding all spikes in the ground truth).`
`280`	`281`	`#`
`281`	`282`	`#`
`282`	`283`	`# In this example, we showed how to:`