From 277f6abba02a39a59cd89d4396a5a8e1b786398f Mon Sep 17 00:00:00 2001
From: abhro <5664668+abhro@users.noreply.github.com>
Date: Tue, 3 Dec 2024 04:06:01 -0500
Subject: [PATCH] docs: add TrainState docstring with Optimisers API (#1110)

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.
---
 docs/src/api/Lux/utilities.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/src/api/Lux/utilities.md b/docs/src/api/Lux/utilities.md
index f0ba68e11c..5f083d0df9 100644
--- a/docs/src/api/Lux/utilities.md
+++ b/docs/src/api/Lux/utilities.md
@@ -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!