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

doc improvement: working with custom model types #84

Closed
CarloLucibello opened this issue Jun 2, 2022 · 2 comments
Closed

doc improvement: working with custom model types #84

CarloLucibello opened this issue Jun 2, 2022 · 2 comments

Comments

@CarloLucibello
Copy link
Member

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

@mcabbott
Copy link
Member

mcabbott commented Jun 2, 2022

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?

@CarloLucibello
Copy link
Member Author

this seems done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants