Add training loop to docs #1488
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
|
cc @ToucheSir |
ToucheSir
approved these changes
Jan 29, 2021
darsnack
reviewed
Jan 29, 2021
|
|
||
| ```@docs | ||
| Flux.Optimise.train! | ||
| ``` | ||
|
|
||
| There are plenty of examples in the [model zoo](https://github.com/FluxML/model-zoo). | ||
| There are plenty of examples in the [model zoo](https://github.com/FluxML/model-zoo), and |
There was a problem hiding this comment.
Suggested change
| There are plenty of examples in the [model zoo](https://github.com/FluxML/model-zoo), and | |
| Like the loop above, `train!` expects the data to be [iterable](https://docs.julialang.org/en/v1/manual/interfaces/#man-interface-iteration). Most default collections Julia, like `Array`s, are iterable. | |
| There are plenty more examples in the [model zoo](https://github.com/FluxML/model-zoo), and |
There was a problem hiding this comment.
We already mention and demonstrate the iteration twice in the couple lines above, do we need it again here?
There was a problem hiding this comment.
People unfamiliar to Julia may not realize that the syntax for x in xs requires the iteration interface. The suggestion was made to make understanding the resulting method error easier for new users.
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 also links to the correct point in the docs to read about custom training loop behaviour.