-
Notifications
You must be signed in to change notification settings - Fork 26
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
Fix missing parameter docstrings #609
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks this looks good. I still think an extended example as suggested in #573 would be a nice-to-have, but as far as doc strings go, all good. 👍
Thanks for this PR @nerkulec, I have one questin before merging. I just finished working on #613 , and was looking at this PR as well so as not to do the same work twice. I realized that the following docstrings in l1_regularization
l2_regularization
learning_rate_embedding
input_noise
batch_norm
dropout
use_compression
checkpoint_best_so_far
snapshots_per_epoch
training_log_interval If I am not mistaken, you added these parameters. Could you also add a docstring for these parameters? If I am mistaken and some of these are from older MALA changes, e.g., by Josh, let me know and I will take care of them. |
I added the missing docstrings in #613. |
I will merge this PR, and then adapt #613 accordingly. |
Included a few of missing docstrings and removed a few parameters which are not used