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

Confusing doc for ivadomed_automate_training #1250

Open
jcohenadad opened this issue Dec 23, 2022 · 0 comments
Open

Confusing doc for ivadomed_automate_training #1250

jcohenadad opened this issue Dec 23, 2022 · 0 comments
Labels
documentation category: readthedocs or user doc

Comments

@jcohenadad
Copy link
Member

Motivation for the feature

I find this section on https://ivadomed.org/tutorials/automate_training.html#default a bit confusing.

Here is the text:

If neither all-combin nor multi-params is selected, then the hyperparameters will be combined as follows into a config_list.
I am not showing the actual config_list here as it would take up too much space. The options listed below are incorporated into the base config file in config.json.

What exactly is this config_list? Something the user has to provide?

And the note (which, BTW should not be written in the first person) is also confusing. What does it mean that the "options [...] are incorporated into the base config file in config.json."? I thought that the hyperparams from the config_hyper.json file actually overwrites that from the config.json?

@jcohenadad jcohenadad changed the title Confusing section for Confusing section for ivadomed_automate_training Dec 23, 2022
@jcohenadad jcohenadad changed the title Confusing section for ivadomed_automate_training Confusing doc for ivadomed_automate_training Dec 23, 2022
@jcohenadad jcohenadad added the documentation category: readthedocs or user doc label Dec 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation category: readthedocs or user doc
Projects
None yet
Development

No branches or pull requests

1 participant