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

DOC: Add error message + note/tip about re-running vak prep if splits fail #608

Open
2 tasks
NickleDave opened this issue Dec 28, 2022 · 0 comments
Open
2 tasks
Labels
DOC: documentation documentation
Projects

Comments

@NickleDave
Copy link
Collaborator

NickleDave commented Dec 28, 2022

Is your feature request related to a problem? Please describe.
Sometimes vak prep can fail to find dataset splits as described here
https://forum.vocalpy.org/t/solving-valueerror-could-not-find-subsets-of-sufficient-duration-in-less-than-5000-iterations/52/9

Because of the current algorithm this can just be luck of the draw, and simply re-running can solve the problem. But this is not obvious.

Describe the solution you'd like

  • add note to error message saying "try re-running"
  • add tip/hint to docs that better explains this

We should for now add a tip/hint to try re-running vak prep when this happens. Should be in

  • edit: in the howto/howto_prep_annot page!
    • (formerly: a detailed vak prep vignette)
  • troubleshooting
  • linked to from FAQs
  • elsewhere?

Describe alternatives you've considered
better split algorithm! as in #299

Additional context
Might be worth providing concrete examples like similar to those Mizuki provided

@NickleDave NickleDave added the DOC: documentation documentation label Dec 28, 2022
@NickleDave NickleDave added this to To do in DOC Dec 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC: documentation documentation
Projects
DOC
To do
Development

No branches or pull requests

1 participant