Optimisers.jl icon indicating copy to clipboard operation
Optimisers.jl copied to clipboard

doc improvement: working with custom model types

Open CarloLucibello opened this issue 3 years ago • 1 comments

We should give more prominence in the docs to the usage of Flux.@functor and Optimisers.trainable to define trainable parameters of custom types.

CarloLucibello avatar Jun 02 '22 12:06 CarloLucibello

Yes. Where's the best place?

I don't want every docstring to become a novel, but perhaps the one for Optimisers.setup is one good place to show that this recurses into custom structs.

The main doc page uses a Flux model as the first example of applying a rule. It could instead first construct some simpler model, and show that a newly written optimisation rule is applied to all children etc?

mcabbott avatar Jun 02 '22 12:06 mcabbott