code-generator
code-generator copied to clipboard
Add comments for each parameter in config.yaml
Right now we can see the following in the config.yaml:
seed: 777
data_path: ./
train_batch_size: 32
eval_batch_size: 32
num_workers: 4
max_epochs: 20
use_amp: false
debug: false
filename_prefix: training
n_saved: 2
save_every_iters: 1000
patience: 3
output_dir: ./logs
log_every_iters: 10
lr: 0.0001
model: resnet18
and it is unclear what each parameter is responsible for.
The idea is to add comments for each parameter like below
seed: 777 # random seed
data_path: ./ # input data path
train_batch_size: 32
eval_batch_size: 32
num_workers: 4
max_epochs: 20
use_amp: false
debug: false
filename_prefix: training # training checkpoint filename prefix
n_saved: 2 # number of saved checkpoints
save_every_iters: 1000 # training checkpoint frequency
patience: 3 # early stopping patience parameter
output_dir: ./logs # output folder
log_every_iters: 10
lr: 0.0001
model: resnet18
@vfdev-5 @guptaaryan16 Will that be necessary to add comments for other yaml files from ci-configs like this?
No @puhuk ci-configs are for testing templates in the CI as you don't need to add them here