Skip to content

Commit 26f0f4b

Browse files
committed
docstring updates
1 parent 23ac9e0 commit 26f0f4b

3 files changed

Lines changed: 4 additions & 3 deletions

File tree

src/ezmsg/learn/process/linear_regressor.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ class LinearRegressorTransformer(
3131
"""
3232
Linear regressor.
3333
34-
Note: `partial_fit` is not 'partial'. It fully resets the model using the entirety of the SampleMessage provided.
34+
Note: `partial_fit` is not 'partial'. It fully resets the model using the entirety of the
35+
SampleTriggerMessage in the input message's "training" attrs.
3536
If you require adaptive fitting, try using the adaptive_linear_regressor module.
3637
"""
3738

src/ezmsg/learn/process/ssr.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ class LRRUnit(
356356
"""ezmsg Unit wrapping :class:`LRRTransformer`.
357357
358358
Follows the :class:`BaseAdaptiveDecompUnit` pattern — accepts
359-
:class:`AxisArray` (not :class:`SampleMessage`) for self-supervised
359+
:class:`AxisArray` for self-supervised
360360
training via ``INPUT_SAMPLE``.
361361
"""
362362

tests/unit/test_mlp_old.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ def xy_gen(set: int = 0):
185185

186186
# Train: This is unrealistic in that we would normally do inference on many axisarray messages throughout
187187
# the trial, and only do training infrequently at the end of a trial if we can infer the labels.
188-
# But I'm too lazy to split the data into many small axarrs and one large SampleMessage per trial.
188+
# But I'm too lazy to split the data into many small AxisArrays and one large labeled AxisArrays-with-triggers.
189189
proc.partial_fit(sample_msg)
190190

191191
def eval_test(processor, set: int = 1):

0 commit comments

Comments
 (0)