Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about recommendation not to change batch size in Kilosort1-3 #2564

Merged
merged 2 commits into from
Mar 22, 2024

Conversation

zm711
Copy link
Collaborator

@zm711 zm711 commented Mar 11, 2024

Based on the KS readme here. It is not advised for users to change the batch size NT. This just adds a note saying that the SpikeInterface default is the KS recommended value as long as the user doesn't change the ntbuff either. Related to #2562.

@zm711 zm711 added the documentation Improvements or additions to documentation label Mar 11, 2024
@alejoe91
Copy link
Member

@zm711 this should be fixed in the new images, but I'm fine leaving the warning there :)

@zm711
Copy link
Collaborator Author

zm711 commented Mar 13, 2024

I think in the past for some issues people have suggested (here and on the KS repo) to change the batch size to help with something (maybe the eigenvector issue) so I think the warning serves the purpose of also saying that hacking solutions for that may introduce other bugs.

That being said warning or not is actually fine by me. :)

@alejoe91 alejoe91 merged commit b98241f into SpikeInterface:main Mar 22, 2024
11 checks passed
@zm711 zm711 deleted the ks-docs branch March 22, 2024 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants