ezmsg-baseproc 1.2.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

ezmsg/baseproc/__init__.py

@@ -82,7 +82,7 @@ from .stateful import (
 from .units import (
     AdaptiveTransformerType,
     BaseAdaptiveTransformerUnit,
-    BaseClockDrivenProducerUnit,
+    BaseClockDrivenUnit,
     BaseConsumerUnit,
     BaseProcessorUnit,
     BaseProducerUnit,
@@ -158,7 +158,7 @@ __all__ = [
     "BaseConsumerUnit",
     "BaseTransformerUnit",
     "BaseAdaptiveTransformerUnit",
-    "BaseClockDrivenProducerUnit",
+    "BaseClockDrivenUnit",
     "GenAxisArray",
     # Type resolution helpers
     "get_base_producer_type",

ezmsg/baseproc/__version__.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.2.0'
-__version_tuple__ = version_tuple = (1, 2, 0)
+__version__ = version = '1.3.0'
+__version_tuple__ = version_tuple = (1, 3, 0)
 
 __commit_id__ = commit_id = None

ezmsg/baseproc/counter.py

@@ -9,7 +9,7 @@ from .clockdriven import (
     ClockDrivenState,
 )
 from .protocols import processor_state
-from .units import BaseClockDrivenProducerUnit
+from .units import BaseClockDrivenUnit
 
 
 class CounterSettings(ClockDrivenSettings):
@@ -57,7 +57,7 @@ class CounterTransformer(BaseClockDrivenProducer[CounterSettings, CounterTransfo
         )
 
 
-class Counter(BaseClockDrivenProducerUnit[CounterSettings, CounterTransformer]):
+class Counter(BaseClockDrivenUnit[CounterSettings, CounterTransformer]):
     """
     Transforms clock ticks into monotonically increasing counter values as AxisArray.
 

ezmsg/baseproc/protocols.py

@@ -5,8 +5,7 @@ import typing
 from dataclasses import dataclass
 
 import ezmsg.core as ez
-
-from .util.message import SampleMessage
+from ezmsg.util.messages.axisarray import AxisArray
 
 # --- Processor state decorator ---
 processor_state = functools.partial(dataclass, unsafe_hash=True, frozen=False, init=False)
@@ -138,7 +137,7 @@ class StatefulTransformer(
 
 
 class AdaptiveTransformer(StatefulTransformer, typing.Protocol):
-    def partial_fit(self, message: SampleMessage) -> None:
+    def partial_fit(self, message: AxisArray) -> None:
         """Update transformer state using labeled training data.
 
         This method should update the internal state/parameters of the transformer
@@ -146,4 +145,4 @@ class AdaptiveTransformer(StatefulTransformer, typing.Protocol):
         """
         ...
 
-    async def apartial_fit(self, message: SampleMessage) -> None: ...
+    async def apartial_fit(self, message: AxisArray) -> None: ...

ezmsg/baseproc/stateful.py

@@ -4,6 +4,9 @@ import pickle
 import typing
 from abc import ABC, abstractmethod
 
+from ezmsg.util.messages.axisarray import AxisArray
+from ezmsg.util.messages.util import replace
+
 from .processor import (
     BaseProcessor,
     BaseProducer,
@@ -256,7 +259,7 @@ class BaseStatefulTransformer(
 class BaseAdaptiveTransformer(
     BaseStatefulTransformer[
         SettingsType,
-        MessageInType | SampleMessage,
+        MessageInType,
         MessageOutType | None,
         StateType,
     ],
@@ -264,30 +267,41 @@ class BaseAdaptiveTransformer(
     typing.Generic[SettingsType, MessageInType, MessageOutType, StateType],
 ):
     @abstractmethod
-    def partial_fit(self, message: SampleMessage) -> None: ...
+    def partial_fit(self, message: AxisArray) -> None: ...
 
-    async def apartial_fit(self, message: SampleMessage) -> None:
+    async def apartial_fit(self, message: AxisArray) -> None:
         """Override me if you need async partial fitting."""
         return self.partial_fit(message)
 
-    def __call__(self, message: MessageInType | SampleMessage) -> MessageOutType | None:
+    def __call__(self, message: MessageInType) -> MessageOutType | None:
         """
         Adapt transformer with training data (and optionally labels)
-        in SampleMessage
+        in AxisArray with attrs["trigger"].
 
         Args:
-            message: An instance of SampleMessage with optional
-             labels (y) in message.trigger.value.data and
-             data (X) in message.sample.data
+            message: An AxisArray with optional trigger in attrs["trigger"],
+             containing labels (y) in attrs["trigger"].value and
+             data (X) in message.data
 
         Returns: None
         """
         if is_sample_message(message):
+            if isinstance(message, SampleMessage):
+                # Auto-convert old format → new format
+                message = replace(
+                    message.sample,
+                    attrs={**message.sample.attrs, "trigger": message.trigger},
+                )
             return self.partial_fit(message)
         return super().__call__(message)
 
-    async def __acall__(self, message: MessageInType | SampleMessage) -> MessageOutType | None:
+    async def __acall__(self, message: MessageInType) -> MessageOutType | None:
         if is_sample_message(message):
+            if isinstance(message, SampleMessage):
+                message = replace(
+                    message.sample,
+                    attrs={**message.sample.attrs, "trigger": message.trigger},
+                )
             return await self.apartial_fit(message)
         return await super().__acall__(message)
 

ezmsg/baseproc/units.py

@@ -3,10 +3,10 @@
 import math
 import traceback
 import typing
+import warnings
 from abc import ABC, abstractmethod
 
 import ezmsg.core as ez
-from ezmsg.util.generator import GenState
 from ezmsg.util.messages.axisarray import AxisArray, LinearAxis
 
 from .clockdriven import BaseClockDrivenProducer
@@ -14,7 +14,6 @@ from .composite import CompositeProcessor
 from .processor import BaseConsumer, BaseProducer, BaseTransformer
 from .protocols import MessageInType, MessageOutType, SettingsType
 from .stateful import BaseAdaptiveTransformer, BaseStatefulConsumer, BaseStatefulTransformer
-from .util.message import SampleMessage
 from .util.profile import profile_subpub
 from .util.typeresolution import resolve_typevar
 
@@ -223,7 +222,7 @@ class BaseAdaptiveTransformerUnit(
     ABC,
     typing.Generic[SettingsType, MessageInType, MessageOutType, AdaptiveTransformerType],
 ):
-    INPUT_SAMPLE = ez.InputStream(SampleMessage)
+    INPUT_SAMPLE = ez.InputStream(AxisArray)
     INPUT_SIGNAL = ez.InputStream(MessageInType)
     OUTPUT_SIGNAL = ez.OutputStream(MessageOutType)
 
@@ -242,11 +241,11 @@ class BaseAdaptiveTransformerUnit(
             yield self.OUTPUT_SIGNAL, result
 
     @ez.subscriber(INPUT_SAMPLE)
-    async def on_sample(self, msg: SampleMessage) -> None:
+    async def on_sample(self, msg: AxisArray) -> None:
         await self.processor.apartial_fit(msg)
 
 
-class BaseClockDrivenProducerUnit(
+class BaseClockDrivenUnit(
     BaseProcessorUnit[SettingsType],
     ABC,
     typing.Generic[SettingsType, ClockDrivenProducerType],
@@ -260,7 +259,7 @@ class BaseClockDrivenProducerUnit(
 
     Implement a new Unit as follows::
 
-        class SinGeneratorUnit(BaseClockDrivenProducerUnit[
+        class SinGeneratorUnit(BaseClockDrivenUnit[
             SinGeneratorSettings,     # SettingsType (must extend ClockDrivenSettings)
             SinProducer,              # ClockDrivenProducerType
         ]):
@@ -287,10 +286,42 @@ class BaseClockDrivenProducerUnit(
             yield self.OUTPUT_SIGNAL, result
 
 
-# Legacy class
+class GenState(ez.State):
+    """
+    .. deprecated::
+        ``GenState`` is deprecated. Define a local state class or use
+        ``ezmsg.baseproc`` processor classes instead.
+    """
+
+    gen: typing.Generator[typing.Any, typing.Any, None]
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        warnings.warn(
+            "GenState is deprecated. Define a local state class instead of subclassing GenState.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+
 class GenAxisArray(ez.Unit):
+    """
+    .. deprecated::
+        ``GenAxisArray`` is deprecated. Use ``BaseTransformerUnit`` or
+        ``BaseAdaptiveTransformerUnit`` from ``ezmsg.baseproc`` instead.
+    """
+
     STATE = GenState
 
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        warnings.warn(
+            "GenAxisArray is deprecated. Use BaseTransformerUnit or "
+            "BaseAdaptiveTransformerUnit from ezmsg.baseproc instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
     INPUT_SIGNAL = ez.InputStream(AxisArray)
     OUTPUT_SIGNAL = ez.OutputStream(AxisArray)
     INPUT_SETTINGS = ez.InputStream(ez.Settings)

ezmsg/baseproc/util/message.py

@@ -1,5 +1,6 @@
 import time
 import typing
+import warnings
 from dataclasses import dataclass, field
 
 from ezmsg.util.messages.axisarray import AxisArray
@@ -19,13 +20,28 @@ class SampleTriggerMessage:
 
 @dataclass
 class SampleMessage:
+    """
+    .. deprecated::
+        ``SampleMessage`` is deprecated. Use ``AxisArray`` with
+        ``attrs={"trigger": SampleTriggerMessage(...)}`` instead.
+    """
+
     trigger: SampleTriggerMessage
     """The time, window, and value (if any) associated with the trigger."""
 
     sample: AxisArray
     """The data sampled around the trigger."""
 
+    def __post_init__(self):
+        warnings.warn(
+            "SampleMessage is deprecated. Use AxisArray with " "attrs={'trigger': SampleTriggerMessage(...)} instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
 
-def is_sample_message(message: typing.Any) -> typing.TypeGuard[SampleMessage]:
-    """Check if the message is a SampleMessage."""
-    return hasattr(message, "trigger")
+def is_sample_message(message: typing.Any) -> bool:
+    """Detect old SampleMessage OR new AxisArray-with-trigger."""
+    if isinstance(message, SampleMessage):
+        return True
+    return isinstance(message, AxisArray) and "trigger" in getattr(message, "attrs", {})

{ezmsg_baseproc-1.2.0.dist-info → ezmsg_baseproc-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ezmsg-baseproc
-Version: 1.2.0
+Version: 1.3.0
 Summary: Base processor classes and protocols for ezmsg signal processing pipelines
 Author-email: Griffin Milsap <griffin.milsap@gmail.com>, Preston Peranich <pperanich@gmail.com>, Chadwick Boulay <chadwick.boulay@gmail.com>, Kyle McGraw <kmcgraw@blackrockneuro.com>
 License-Expression: MIT

ezmsg_baseproc-1.3.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+ezmsg/baseproc/__init__.py,sha256=DhINT6FB8iFdQk7RaNe8JY6YBZdv2FehuMfv8lWBN1w,4739
+ezmsg/baseproc/__version__.py,sha256=0Oc4EBzGTJOvXX0Vym4evglW1NQPpe8RLn8TdxsKzfs,704
+ezmsg/baseproc/clock.py,sha256=jRJGxaWWBek503OcGRYsW4Qc7Lt4m-tVl1wn_v-qCIk,3254
+ezmsg/baseproc/clockdriven.py,sha256=ckPZSVHZfYfjFRHDCERUWjDwyQgOu-aRTNsJ3EDFBaI,6161
+ezmsg/baseproc/composite.py,sha256=Lin4K_rmS2Tnxt-m8daP-PUyeeqL4id5JkVh-AUNrQw,14901
+ezmsg/baseproc/counter.py,sha256=FGW-Uu0PDHa6AJFjMC7GtiXC3LulBbyP1Z_ae895F3s,2152
+ezmsg/baseproc/processor.py,sha256=Ir9FtNuVG4yc-frwNxoYrlld99ff1mXwwGWaHxEJ6tY,8056
+ezmsg/baseproc/protocols.py,sha256=ECgFW48Mma7rRcW6b4QVVUzAMzXL-2dAiRIUv_ZG9nw,5109
+ezmsg/baseproc/stateful.py,sha256=sbChz1soxgW3IjDHKpU4gxsiJ3JzT3eDIDMvLkPr5F4,11995
+ezmsg/baseproc/units.py,sha256=1ds69VuWJtmCLy_UeAcFHO_4iExe2HxbdCJ5PgIy4Wc,12995
+ezmsg/baseproc/util/__init__.py,sha256=hvMUJOBuqioER50GZ5-GZiQbQ9NtQYEze13ZlR2jbMA,37
+ezmsg/baseproc/util/asio.py,sha256=0sF5oDc58DSLlcEgoUpNiqjjcbqnZhjSpQrXn6IdosM,4960
+ezmsg/baseproc/util/message.py,sha256=8eMB-OYwDkRIbzoCX30rfodNWCYYVcT-HQosuqoj2a8,1434
+ezmsg/baseproc/util/profile.py,sha256=MOQDsFsW6ddXT0uAOgytW3aK_AZW5ieA16Pz2hWuE2o,6189
+ezmsg/baseproc/util/typeresolution.py,sha256=5on4QcrYd1rxsRoDEqivNjuWT5BkU-Wg7XdTNaOircI,3485
+ezmsg_baseproc-1.3.0.dist-info/METADATA,sha256=Yy16gYyLvtjFcyEgUrCq1gbj-Jq-b7oK8KDfeS3rMNg,3415
+ezmsg_baseproc-1.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ezmsg_baseproc-1.3.0.dist-info/licenses/LICENSE,sha256=BDD8rfac1Ur7mp0_3izEdr6fHgSA3Or6U1Kb0ZAWsow,1066
+ezmsg_baseproc-1.3.0.dist-info/RECORD,,

ezmsg_baseproc-1.2.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-ezmsg/baseproc/__init__.py,sha256=cSkyXkfPvIiAxe6maHiZvJpFbdRw3xTEitBClXeehec,4755
-ezmsg/baseproc/__version__.py,sha256=-uLONazCO1SzFfcY-K6A1keL--LIVfTYccGX6ciADac,704
-ezmsg/baseproc/clock.py,sha256=jRJGxaWWBek503OcGRYsW4Qc7Lt4m-tVl1wn_v-qCIk,3254
-ezmsg/baseproc/clockdriven.py,sha256=ckPZSVHZfYfjFRHDCERUWjDwyQgOu-aRTNsJ3EDFBaI,6161
-ezmsg/baseproc/composite.py,sha256=Lin4K_rmS2Tnxt-m8daP-PUyeeqL4id5JkVh-AUNrQw,14901
-ezmsg/baseproc/counter.py,sha256=kcBPiVxMPULp4ojnVESNw7mn_4v0xSODfASHrL83GtM,2168
-ezmsg/baseproc/processor.py,sha256=Ir9FtNuVG4yc-frwNxoYrlld99ff1mXwwGWaHxEJ6tY,8056
-ezmsg/baseproc/protocols.py,sha256=O3Qp0ymE9Ovlmh8t22v-lMmFzuWK0D93REAYMnJV3xA,5106
-ezmsg/baseproc/stateful.py,sha256=-jjAZIyJA5eiTECi1fSfazfqgv__RtyqPp1ZvLFFIDI,11424
-ezmsg/baseproc/units.py,sha256=byFijVLEZFO145HE74sZk1_qpCu6nFjB8-vSYz9Grds,12077
-ezmsg/baseproc/util/__init__.py,sha256=hvMUJOBuqioER50GZ5-GZiQbQ9NtQYEze13ZlR2jbMA,37
-ezmsg/baseproc/util/asio.py,sha256=0sF5oDc58DSLlcEgoUpNiqjjcbqnZhjSpQrXn6IdosM,4960
-ezmsg/baseproc/util/message.py,sha256=l_b1b6bXX8N6VF9RbUELzsHs73cKkDURBdIr0lt3CY0,909
-ezmsg/baseproc/util/profile.py,sha256=MOQDsFsW6ddXT0uAOgytW3aK_AZW5ieA16Pz2hWuE2o,6189
-ezmsg/baseproc/util/typeresolution.py,sha256=5on4QcrYd1rxsRoDEqivNjuWT5BkU-Wg7XdTNaOircI,3485
-ezmsg_baseproc-1.2.0.dist-info/METADATA,sha256=H2jTn5VSw0pEwQWLdd3Hu0G1OCbbKM-On4AmKyyyfm4,3415
-ezmsg_baseproc-1.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-ezmsg_baseproc-1.2.0.dist-info/licenses/LICENSE,sha256=BDD8rfac1Ur7mp0_3izEdr6fHgSA3Or6U1Kb0ZAWsow,1066
-ezmsg_baseproc-1.2.0.dist-info/RECORD,,