Extend setup docstring to show custom struct
#85
Merged
Conversation
This file contains 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
Jun 3, 2022
ToucheSir
reviewed
Jun 3, 2022
src/Optimisers.jl
Outdated
| julia> Optimisers.setup(Momentum(), model) | ||
| (lay = (mat = Leaf(Momentum{Float32}(0.01, 0.9), [0.0 0.0; 0.0 0.0]), vec = Leaf(Momentum{Float32}(0.01, 0.9), [0.0, 0.0])), fun = nothing) | ||
|
|
||
| julia> Optimisers.trainable(l::Layer) = (vec = l.vec,) # if necessary, ignore some parameters |
There was a problem hiding this comment.
My inclination is that we'd want a motivating example where @functor Layer (vec,) is not sufficient. The counter-argument would be that 99% of @functor use should not specify a list of properties because users may want to traverse to them with fmap and friends.
There was a problem hiding this comment.
Maybe best to leave this off here?
CarloLucibello
approved these changes
Jun 3, 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.
For #84