-
-
Notifications
You must be signed in to change notification settings - Fork 611
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
Get rid of documentation warnings and 404 pages #1987
Conversation
I would vote not to add |
Yes, having a separate page for
Should I create a new page or should append Or maybe we should add a new section under the "Optimisers" page for this? |
980c0bf
to
7b3be71
Compare
|
cc: @DhairyaLGandhi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a good step forwards, fixes things which are broken.
* fix cross-references * add missing docstrings
Add `cpu` and `gpu` to the manual and `Optimisers.jl` as a dependency
7b3be71
to
46932c7
Compare
Changes/Additions
404
pageRelated PRs - FluxML/Functors.jl#42, JuliaML/MLUtils.jl#95
Leftover work
Flux.destructure
in@docs
block insrc\utilities.md
destructure
is now imported fromOptimisers
. Should I addOptimisers.jl
as a doc dependency? Adding a new dependency that has functions and structs named the same as those ofFlux
would also mean specifying the package in the docs. For example, changing this -to this -
and so on. Could you please let me know if
Flux
plans to import all these optimisers fromOptimisers.jl
? If yes, then this would be a good idea.Flux.trainable
](@\ref)' insrc\training\training.md
.Again, this would require adding
Optimisers.jl
as a doc dependency.Missing docstrings
The logs also show a bunch of docstrings that do not appear in the manual. Most of them are a part of the internal API, but I have marked some of them which I think are user-facing. Should I add them in the manual?
PR Checklist