chaobrain · chaoming0625 · Jul 28, 2026 · Jul 28, 2026 · Jul 28, 2026
diff --git a/braintrace/_algorithm/base.py b/braintrace/_algorithm/base.py
@@ -37,9 +37,16 @@
 
 
 class EligibilityTrace(brainstate.ShortTermState):
-    """
-    The state for storing the eligibility trace during the computation of
-    online learning algorithms.
+    """Store the eligibility trace carried by an online-learning algorithm.
+
+    Parameters
+    ----------
+    value : PyTree[ArrayLike]
+        The initial eligibility-trace value.
+    name : str, optional
+        The state name.
+    **metadata : Any
+        Additional metadata stored with the state.
 
     Examples
     --------

diff --git a/braintrace/_algorithm/sequence.py b/braintrace/_algorithm/sequence.py
@@ -162,7 +162,7 @@ class SequenceDriverMixin:
         The learner's ``vjp_method``, or ``None`` if it has none.
 
     ``_seq_vjp_method`` is a hook rather than a ``getattr`` on the driver
-    because :class:`brainstate.nn.Vmap` defines no ``__getattr__`` and so does
+    because ``brainstate.nn.Vmap`` defines no ``__getattr__`` and so does
     not forward ``vjp_method`` from ``.module``. Reading the attribute off the
     driver object would silently yield ``None`` for every vmapped learner and
     bypass the window-mode validation entirely.
@@ -285,7 +285,7 @@ def etrace_grad(
         Returns
         -------
         grads or tuple
-            Mirrors :func:`brainstate.transform.grad`: ``grads``,
+            Mirrors ``brainstate.transform.grad``: ``grads``,
             ``(grads, losses)``, ``(grads, aux)`` or ``(grads, losses, aux)``.
 
         Raises
@@ -537,7 +537,7 @@ def body(*slices):
 
 
 class ETraceVmap(SequenceDriverMixin, brainstate.nn.Vmap):
-    """A :class:`brainstate.nn.Vmap` that carries the sequence drivers.
+    """Provide sequence drivers on a ``brainstate.nn.Vmap`` wrapper.
 
     Returned by ``braintrace.compile(..., vmap=True)`` so the call site is
     identical in batched and unbatched mode. Because it *is* a
@@ -555,7 +555,8 @@ class ETraceVmap(SequenceDriverMixin, brainstate.nn.Vmap):
     would drive the **unbatched** learner and silently produce per-lane-wrong
     results.
 
-    Window mode is refused here -- see :meth:`SequenceDriverMixin._seq_check_window`.
+    Window mode is refused here -- see
+    :meth:`SequenceDriverMixin.etrace_grad`.
     """
     __module__ = 'braintrace'
 

diff --git a/braintrace/_compile.py b/braintrace/_compile.py
@@ -154,7 +154,7 @@ def compile(
         ``trace_factorization`` and is forwarded to the constructor, so any
         coordinate admitted by the compatibility matrix can be compiled
         without a named preset.
-    *example_inputs
+    *example_inputs : Any
         Example call inputs (arrays / :class:`SingleStepData` /
         :class:`MultiStepData`) matching what ``learner.update(...)`` will
         receive. At least one is required.
@@ -184,7 +184,7 @@ def compile(
         ``result.module.report``). Requires a model whose hidden states are all
         (re)created in ``init_all_states``; models holding construction-time
         states may raise ``brainstate.transform.BatchAxisError``.
-    **options
+    **options : Any
         Forwarded to the algorithm constructor. See *Algorithm options* below.
 
     Returns

diff --git a/docs/_templates/classtemplate.rst b/docs/_templates/classtemplate.rst
@@ -7,3 +7,6 @@
 
 .. autoclass:: {{ name }}
     :members:
+    :exclude-members: __init__
+
+.. automethod:: {{ name }}.__init__
diff --git a/docs/apis/algorithm_details/braintrace.DNI.rst b/docs/apis/algorithm_details/braintrace.DNI.rst
diff --git a/docs/apis/algorithm_details/braintrace.D_RTRL.rst b/docs/apis/algorithm_details/braintrace.D_RTRL.rst
diff --git a/docs/apis/algorithm_details/braintrace.EProp.rst b/docs/apis/algorithm_details/braintrace.EProp.rst
diff --git a/docs/apis/algorithm_details/braintrace.ETraceAlgorithm.rst b/docs/apis/algorithm_details/braintrace.ETraceAlgorithm.rst
diff --git a/docs/apis/algorithm_details/braintrace.ETraceConfig.rst b/docs/apis/algorithm_details/braintrace.ETraceConfig.rst
diff --git a/docs/apis/algorithm_details/braintrace.ETraceVjpAlgorithm.rst b/docs/apis/algorithm_details/braintrace.ETraceVjpAlgorithm.rst
diff --git a/docs/apis/algorithm_details/braintrace.ETraceVmap.rst b/docs/apis/algorithm_details/braintrace.ETraceVmap.rst
diff --git a/docs/apis/algorithm_details/braintrace.EligibilityTrace.rst b/docs/apis/algorithm_details/braintrace.EligibilityTrace.rst
diff --git a/docs/apis/algorithm_details/braintrace.FixedRandomFeedback.rst b/docs/apis/algorithm_details/braintrace.FixedRandomFeedback.rst
diff --git a/docs/apis/algorithm_details/braintrace.IODimVjpAlgorithm.rst b/docs/apis/algorithm_details/braintrace.IODimVjpAlgorithm.rst
diff --git a/docs/apis/algorithm_details/braintrace.KappaFilter.rst b/docs/apis/algorithm_details/braintrace.KappaFilter.rst
diff --git a/docs/apis/algorithm_details/braintrace.OSTLFeedforward.rst b/docs/apis/algorithm_details/braintrace.OSTLFeedforward.rst
diff --git a/docs/apis/algorithm_details/braintrace.OSTLRecurrent.rst b/docs/apis/algorithm_details/braintrace.OSTLRecurrent.rst
diff --git a/docs/apis/algorithm_details/braintrace.ParamDimVjpAlgorithm.rst b/docs/apis/algorithm_details/braintrace.ParamDimVjpAlgorithm.rst
diff --git a/docs/apis/algorithm_details/braintrace.RandomProjectionVjpAlgorithm.rst b/docs/apis/algorithm_details/braintrace.RandomProjectionVjpAlgorithm.rst
diff --git a/docs/apis/algorithm_details/braintrace.SequenceDriverMixin.rst b/docs/apis/algorithm_details/braintrace.SequenceDriverMixin.rst
diff --git a/docs/apis/algorithm_details/braintrace.SnAp.rst b/docs/apis/algorithm_details/braintrace.SnAp.rst
diff --git a/docs/apis/algorithm_details/braintrace.SyntheticGradient.rst b/docs/apis/algorithm_details/braintrace.SyntheticGradient.rst
diff --git a/docs/apis/algorithm_details/braintrace.ThreeFactor.rst b/docs/apis/algorithm_details/braintrace.ThreeFactor.rst
diff --git a/docs/apis/algorithm_details/braintrace.UORO.rst b/docs/apis/algorithm_details/braintrace.UORO.rst
diff --git a/docs/apis/algorithm_details/braintrace.compile.rst b/docs/apis/algorithm_details/braintrace.compile.rst
diff --git a/docs/apis/algorithm_details/braintrace.pp_prop.rst b/docs/apis/algorithm_details/braintrace.pp_prop.rst
diff --git a/docs/apis/algorithm_details/braintrace.train_synthetic_gradient.rst b/docs/apis/algorithm_details/braintrace.train_synthetic_gradient.rst