vak
vak copied to clipboard
DOC/ENH: Add info about evaluation + learncurve in the vak documentation
It would be very useful to add to vak's how-to doc information about the evaluation setting (and maybe also learncurve)
In particular, I think it would be good to extend the following section with an evaluation step (and learncurve): https://vak.readthedocs.io/en/latest/get_started/autoannotate.html#autoannotate
For easier access it could also help to link some example configuration files on the config file information page: https://vak.readthedocs.io/en/latest/reference/config.html
Thank you @vivinastase -- you are completely right, as you suggested on #135
https://github.com/NickleDave/vak/issues/135#issuecomment-1063048286
Because you asked how you could make the process better -- it would be good to have the evaluation part included and described in the vak doc, like the prep and training are, and maybe link some examples of the config files in the doc (https://vak.readthedocs.io/en/latest/reference/config.html#config)
We will make sure to add this. Really appreciate your feedback
Hi @vivinastase I added some initial info on how to run eval just now in #715 (a year and a half later :sob:) -- leaving this open because I know we need to add more detail, and we still need to say more about the learning curve functionality.
Thank you again for this suggestion
@all-contributors please add @vivinastase for ideas