|
395 | 395 |
|
396 | 396 | 'cluster_downsampling': { |
397 | 397 | 'gui_name': 'cluster downsampling', 'type': int, 'min': 1, 'max': np.inf, |
398 | | - 'exclude': [], 'default': 1, 'step': 'clustering', |
| 398 | + 'exclude': [], 'default': 20, 'step': 'clustering', |
399 | 399 | 'description': |
400 | 400 | """ |
401 | 401 | Inverse fraction of spikes used as landmarks during clustering. By |
|
404 | 404 |
|
405 | 405 | The old default behavior (version < 4.1.0) is |
406 | 406 | 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. |
407 | 413 | """ |
408 | 414 | }, |
409 | 415 |
|
|
421 | 427 | is not necessary and causes performance bottlenecks. |
422 | 428 |
|
423 | 429 | 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 |
425 | 433 | 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`. |
426 | 436 |
|
427 | 437 | Note: In practice, the actual number of spikes used may increase or |
428 | 438 | decrease slightly while staying under the maximum. This happens |
|
0 commit comments