Skip to content

Commit

Permalink
Add TrainState docstring with Optimisers API
Browse files Browse the repository at this point in the history
The default TrainState docstring suggests using the version with the
Optimisers API, but it doesn't appear in the doc website. Add the
docstring manually to the website by adding the method to a @docs block.
  • Loading branch information
abhro committed Nov 30, 2024
1 parent 78ad9c9 commit 24b76cd
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/api/Lux/utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ basic building blocks which can be seamlessly composed to create complex trainin

```@docs
Training.TrainState
Training.TrainState(::AbstractLuxLayer, ::Any, ::Any, ::Optimisers.AbstractRule)
Training.compute_gradients
Training.apply_gradients
Training.apply_gradients!
Expand Down

0 comments on commit 24b76cd

Please sign in to comment.