Skip to content

Don't use state anywhere for the whole state tree #136

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

Merged
merged 1 commit into from
Apr 12, 2023

Conversation

mcabbott
Copy link
Member

@mcabbott mcabbott commented Apr 1, 2023

Doc-only change.

We use state for what init returns, so should probably never use it for what setup returns. That's called tree in code, and this calls it state_tree more places in the docs.

Unsure if we should change headings like Optimisers.update!(tree, model, gradient) -> (tree, model) to the more verbose Optimisers.update!(state_tree, model, gradient) -> (state_tree, model).

Another possibility for docs is to call the whole thing states plural.

@mcabbott mcabbott merged commit 9a87a88 into FluxML:master Apr 12, 2023
@mcabbott mcabbott deleted the doc_april branch April 12, 2023 15:00
@mcabbott mcabbott mentioned this pull request Apr 29, 2023
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.

2 participants