Skip to content
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

Re-write training docs #2114

Merged
merged 28 commits into from
Dec 15, 2022
Merged

Re-write training docs #2114

merged 28 commits into from
Dec 15, 2022

Conversation

mcabbott
Copy link
Member

@mcabbott mcabbott commented Nov 19, 2022

This re-writes training.md to move from implicit to explicit, #1986.

And creates a new page train_api.md to hold the docstrings. For now they live together but the goal is that they can live in different sections, "narrative vs. lookup" -- see #2115

Also updates basic.md to introduce explicit gradients first.

In all of these, it puts implicit things in !!! note boxes nearby. I start to think that's better than having a separate page for implicit-to-explicit changes.

It expects #2082 in order for update! and Adam to work with explicit gradients, and for the new train!. Rebased. But struggling to make the right docstrings show up. One update! 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.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 19, 2022

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/

@codecov-commenter

This comment was marked as off-topic.

@mcabbott mcabbott force-pushed the explicit_doc1 branch 4 times, most recently from f2a8883 to c6bac9a Compare November 21, 2022 22:50
@mcabbott mcabbott marked this pull request as draft November 25, 2022 15:34
@mcabbott mcabbott marked this pull request as ready for review November 27, 2022 16:52
@mcabbott
Copy link
Member Author

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.

README.md Outdated Show resolved Hide resolved
docs/src/models/basics.md Show resolved Hide resolved
@CarloLucibello CarloLucibello added this to the v0.14 milestone Dec 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants