Add release notes

doc/releases/0.100.2.rst

@@ -0,0 +1,11 @@
+.. _release0.100.2:
+
+SpikeInterface 0.100.2 release notes
+------------------------------------
+
+19th March 2024
+
+Minor release with fix for running Kilosort4 with GPU support in container
+
+* Use GPU in Kilosort4Sorter (#2577)
+* Add batch size to KS4 wrapper (#2592)

doc/releases/0.100.3.rst

@@ -0,0 +1,12 @@
+.. _release0.100.3:
+
+SpikeInterface 0.100.3 release notes
+------------------------------------
+
+28th March 2024
+
+Minor release with bug fixes for Zarr compressor and NWB in container
+
+* Remove lazy typing in nwb (#2635)
+* Add extra_requirements for nwb extractors (#2637)
+* Fix compressor propagation to Zarr save function (#2639)

doc/whatisnew.rst

@@ -8,6 +8,8 @@ Release notes
 .. toctree::
   :maxdepth: 1
 
+  releases/0.100.3.rst
+  releases/0.100.2.rst
   releases/0.100.1.rst
   releases/0.100.0.rst
   releases/0.99.1.rst
@@ -35,6 +37,18 @@ Release notes
   releases/0.9.1.rst
 
 
+Version 0.100.3
+==============
+
+* Minor release with bug fixes for Zarr compressor and NWB in container
+
+
+Version 0.100.2
+==============
+
+* Minor release with fix for running Kilosort4 with GPU support in container
+
+
 Version 0.100.1
 ==============
 

src/spikeinterface/postprocessing/template_similarity.py

@@ -112,7 +112,9 @@ def compute_template_similarity(
         similarity = tmc.get_data()
         return similarity
     else:
-        return _compute_template_similarity(waveform_extractor, waveform_extractor_other, method)
+        return _compute_template_similarity(
+            waveform_extractor=waveform_extractor, waveform_extractor_other=waveform_extractor_other, method=method
+        )
 
 
 def check_equal_template_with_distribution_overlap(

src/spikeinterface/postprocessing/tests/test_template_similarity.py

@@ -4,6 +4,12 @@
 
 from spikeinterface.postprocessing.tests.common_extension_tests import WaveformExtensionCommonTestSuite
 
+from spikeinterface.core import extract_waveforms
+from spikeinterface.extractors import toy_example
+from spikeinterface.comparison import compare_templates
+
+import numpy as np
+
 
 class SimilarityExtensionTest(WaveformExtensionCommonTestSuite, unittest.TestCase):
     extension_class = TemplateSimilarityCalculator
@@ -21,8 +27,31 @@ def test_check_equal_template_with_distribution_overlap(self):
                 check_equal_template_with_distribution_overlap(waveforms0, waveforms1)
 
 
+def test_compare_multiple_templates_different_units():
+
+    duration = 5
+    num_channels = 4
+
+    num_units_1 = 5
+    num_units_2 = 10
+
+    rec1, sort1 = toy_example(duration=duration, num_segments=1, num_channels=num_channels, num_units=num_units_1)
+
+    rec2, sort2 = toy_example(duration=duration, num_segments=1, num_channels=num_channels, num_units=num_units_2)
+
+    # compute waveforms
+    we1 = extract_waveforms(rec1, sort1, n_jobs=1, mode="memory")
+    we2 = extract_waveforms(rec2, sort2, n_jobs=1, mode="memory")
+
+    # paired comparison
+    temp_cmp = compare_templates(we1, we2)
+
+    assert np.shape(temp_cmp.agreement_scores) == (num_units_1, num_units_2)
+
+
 if __name__ == "__main__":
     test = SimilarityExtensionTest()
     test.setUp()
     test.test_extension()
     test.test_check_equal_template_with_distribution_overlap()
+    test_compare_multiple_templates_different_units()

src/spikeinterface/sorters/external/kilosort4.py

@@ -18,6 +18,7 @@ class Kilosort4Sorter(BaseSorter):
     gpu_capability = "nvidia-optional"
 
     _default_params = {
+        "batch_size": 60000,
         "nblocks": 1,
         "Th_universal": 9,
         "Th_learned": 8,
@@ -53,6 +54,7 @@ class Kilosort4Sorter(BaseSorter):
     }
 
     _params_description = {
+        "batch_size": "Number of samples per batch. Default value: 60000.",
         "nblocks": "Number of non-overlapping blocks for drift correction (additional nblocks-1 blocks are created in the overlaps). Default value: 1.",
         "Th_universal": "Spike detection threshold for universal templates. Th(1) in previous versions of Kilosort. Default value: 9.",
         "Th_learned": "Spike detection threshold for learned templates. Th(2) in previous versions of Kilosort. Default value: 8.",