Improve WeightDecay docstring
#60
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ToucheSir
reviewed
Mar 7, 2022
|
|
||
| # Parameters | ||
| - Weight decay (`γ`): Decay applied to weights during optimisation. | ||
| """ | ||
| struct WeightDecay{T} | ||
| wd::T | ||
| gamma::T |
There was a problem hiding this comment.
I guess our policy is that most fields are not considered part of the public API?
There was a problem hiding this comment.
I guess so. And that 0.2 was so recent & we're still getting Flux to hook up to it.
There was a problem hiding this comment.
Yeah relying on field names is generally not guaranteed, so I think that's a fine policy.
darsnack
approved these changes
Mar 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds some comments borrowed from Flux in from #46, whose main change we decided wasn't needed.