You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently when we produce the finalized config file (comprised of the fibad default + external library default + user specific configs) all of the comments in the original config files are lost.
We should maintain these comments as much as possible. We currently use the toml package for parsing and outputting the config files, but it doesn't maintain the comments. A package like TOMLKit https://tomlkit.readthedocs.io/en/latest/ will maintain the comments and create a config dictionary that we can use without modifying the rest of fibad.
Aside from maintaining comments and making it easier for a user to understand the values in a finalized config, this would also open the door to allowing users in an interactive session to leave notes for why they chose specific values for a given run.
i.e. (api subject to change)
fibad_instance = Fibad(config_file='./my_config.toml')
fibad_instance.config['train']['epochs']=100
fibad_instance.config['train']['epochs'].note('Running for more to see if loss improves')
Additionally, we could over ride the repr methods such that toml tables and keys could be printed in an interactive session with a representation similar to a docstring.
i.e.
fibad_instance = Fibad(config_file='./my_config.toml')
fibad_instance.config['train']['epochs'].help()
train
epochs = 10
"The number of times the model will see of the training dataset samples."
fibad_instance.config['general'].help()
general
dev_mode = False
Whether to run in development mode....
log_destination = stderr
Destination of log messages.
data_dir = ./data/
Output location for downloaded data....
The text was updated successfully, but these errors were encountered:
Currently when we produce the finalized config file (comprised of the fibad default + external library default + user specific configs) all of the comments in the original config files are lost.
We should maintain these comments as much as possible. We currently use the
toml
package for parsing and outputting the config files, but it doesn't maintain the comments. A package like TOMLKit https://tomlkit.readthedocs.io/en/latest/ will maintain the comments and create a config dictionary that we can use without modifying the rest of fibad.Aside from maintaining comments and making it easier for a user to understand the values in a finalized config, this would also open the door to allowing users in an interactive session to leave notes for why they chose specific values for a given run.
i.e. (api subject to change)
Additionally, we could over ride the repr methods such that toml tables and keys could be printed in an interactive session with a representation similar to a docstring.
i.e.
The text was updated successfully, but these errors were encountered: