Skip to content

Commit bc3bb2b

Browse files
author
Jacob Pennington
committed
Reverted default cluster_downsampling to 20
1 parent 9a1e157 commit bc3bb2b

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

kilosort/parameters.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@
395395

396396
'cluster_downsampling': {
397397
'gui_name': 'cluster downsampling', 'type': int, 'min': 1, 'max': np.inf,
398-
'exclude': [], 'default': 1, 'step': 'clustering',
398+
'exclude': [], 'default': 20, 'step': 'clustering',
399399
'description':
400400
"""
401401
Inverse fraction of spikes used as landmarks during clustering. By
@@ -404,6 +404,12 @@
404404
405405
The old default behavior (version < 4.1.0) is
406406
equivalent to `max_cluster_subset=None, cluster_downsampling=20`.
407+
Versions 4.1.0 through 4.1.2 defaulted to
408+
`max_cluster_subset=25000, cluster_downsampling=1`.
409+
410+
The default value was reverted to 20 in version 4.1.3 because many
411+
users reported memory issues with the new default. We have found
412+
that values betwen 5-20 also work well in most cases.
407413
"""
408414
},
409415

@@ -421,8 +427,12 @@
421427
is not necessary and causes performance bottlenecks.
422428
423429
Use `max_cluster_subset = None` if you do not want a limit on
424-
the subset size. The old default behavior (version < 4.1.0) is
430+
the subset size.
431+
432+
The old default behavior (version < 4.1.0) is
425433
equivalent to `max_cluster_subset=None, cluster_downsampling=20`.
434+
Versions 4.1.0 through 4.1.2 defaulted to
435+
`max_cluster_subset=25000, cluster_downsampling=1`.
426436
427437
Note: In practice, the actual number of spikes used may increase or
428438
decrease slightly while staying under the maximum. This happens

0 commit comments

Comments
 (0)