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

Fix missing parameter docstrings #609

Merged
merged 5 commits into from
Nov 26, 2024

Conversation

nerkulec
Copy link

Included a few of missing docstrings and removed a few parameters which are not used

Copy link
Member

@elcorto elcorto left a 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. 👍

@RandomDefaultUser
Copy link
Member

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 ParametersRunning are still missing:

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.

@RandomDefaultUser
Copy link
Member

I added the missing docstrings in #613.
As it turns out, most of these parameters are currently unused, so I commented them out, and would suggest we add a docstring once they are used/commented in again.

@RandomDefaultUser
Copy link
Member

I will merge this PR, and then adapt #613 accordingly.

@RandomDefaultUser RandomDefaultUser merged commit db47311 into develop Nov 26, 2024
6 checks passed
@RandomDefaultUser RandomDefaultUser deleted the fix-missing-parameter-docstrings branch November 26, 2024 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants