Re-write training docs #2114
Merged
Re-write training docs #2114
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
|
Once the build has completed, you can preview any updated documentation at this URL: https://fluxml.ai/Flux.jl/previews/PR2114/ in ~20 minutes Edit: especially https://fluxml.ai/Flux.jl/previews/PR2114/training/training/ Compare to http://fluxml.ai/Flux.jl/stable/training/training/ + http://fluxml.ai/Flux.jl/stable/models/regularisation/ |
This comment was marked as off-topic.
This comment was marked as off-topic.
3 tasks
mcabbott
force-pushed
the
explicit_doc1
branch
4 times, most recently
from
f2a8883 to
c6bac9a
Compare
2 tasks
mcabbott
force-pushed
the
explicit_doc1
branch
from
c6bac9a to
89074bc
Compare
|
I think this is about ready. It could use another set of eyeballs to see whether anything from the old docs has been lost, or made more confusing. |
mcabbott
commented
Dec 1, 2022
mcabbott
force-pushed
the
explicit_doc1
branch
from
a572da2 to
11e4825
Compare
CarloLucibello
approved these changes
Dec 15, 2022
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 re-writes
training.mdto move from implicit to explicit, #1986.And creates a new page
train_api.mdto hold the docstrings. For now they live together but the goal is that they can live in different sections, "narrative vs. lookup" -- see #2115Also updates basic.md to introduce explicit gradients first.
In all of these, it puts implicit things in
!!! noteboxes nearby. I start to think that's better than having a separate page for implicit-to-explicit changes.It expects #2082 in order forRebased.update!andAdamto work with explicit gradients, and for the newtrain!.But struggling to make the right docstrings show up.Oneupdate!signature isn't co-operating.After this I think regularisation.md needs some re-working. It could be a home for some of what's in optimisers.md (except the listing of rules), basically all the more advanced topics after this? I.e. this page is the basic idea of what a training loop looks like; the next one covers regularisation, freezing, scheduling, etc.Or maybe it should just be one page? This gets all the blue boxes telling you what to change in one place.