Don't use state
anywhere for the whole state tree
#136
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.
Doc-only change.
We use
state
for whatinit
returns, so should probably never use it for whatsetup
returns. That's calledtree
in code, and this calls itstate_tree
more places in the docs.Unsure if we should change headings like
Optimisers.update!(tree, model, gradient) -> (tree, model)
to the more verboseOptimisers.update!(state_tree, model, gradient) -> (state_tree, model)
.Another possibility for docs is to call the whole thing
states
plural.