cuvis-ai-schemas 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

cuvis_ai_schemas/__init__.py

@@ -1,5 +1,5 @@
-"""cuvis-ai-schemas: Lightweight schema definitions for the cuvis-ai ecosystem."""
-
-__version__ = "0.1.0"
-
-__all__ = ["__version__"]
+"""cuvis-ai-schemas: Lightweight schema definitions for the cuvis-ai ecosystem."""
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

cuvis_ai_schemas/discovery/__init__.py

@@ -1,6 +1,6 @@
-"""Discovery and metadata schemas."""
-
-# Discovery schemas are primarily defined in proto
-# Python implementations will be added as needed
-
-__all__: list[str] = []
+"""Discovery and metadata schemas."""
+
+# Discovery schemas are primarily defined in proto
+# Python implementations will be added as needed
+
+__all__: list[str] = []

cuvis_ai_schemas/enums/__init__.py

@@ -1,5 +1,5 @@
-"""Shared enums across cuvis-ai ecosystem."""
-
-from cuvis_ai_schemas.enums.types import ArtifactType, ExecutionStage
-
-__all__ = ["ExecutionStage", "ArtifactType"]
+"""Shared enums across cuvis-ai ecosystem."""
+
+from cuvis_ai_schemas.enums.types import ArtifactType, ExecutionStage
+
+__all__ = ["ExecutionStage", "ArtifactType"]

cuvis_ai_schemas/enums/types.py

@@ -1,30 +1,30 @@
-"""Shared type enums for cuvis-ai ecosystem."""
-
-from enum import StrEnum
-
-
-class ExecutionStage(StrEnum):
-    """Execution stages for node filtering.
-
-    Nodes can specify which stages they should execute in to enable
-    stage-aware graph execution (e.g., loss nodes only in training).
-    """
-
-    ALWAYS = "always"
-    TRAIN = "train"
-    VAL = "val"
-    VALIDATE = "val"
-    TEST = "test"
-    INFERENCE = "inference"
-
-
-class ArtifactType(StrEnum):
-    """Types of artifacts with different validation/logging policies.
-
-    Attributes
-    ----------
-    IMAGE : str
-        Image artifact - expects shape (H, W, 1) monocular or (H, W, 3) RGB
-    """
-
-    IMAGE = "image"
+"""Shared type enums for cuvis-ai ecosystem."""
+
+from enum import StrEnum
+
+
+class ExecutionStage(StrEnum):
+    """Execution stages for node filtering.
+
+    Nodes can specify which stages they should execute in to enable
+    stage-aware graph execution (e.g., loss nodes only in training).
+    """
+
+    ALWAYS = "always"
+    TRAIN = "train"
+    VAL = "val"
+    VALIDATE = "val"
+    TEST = "test"
+    INFERENCE = "inference"
+
+
+class ArtifactType(StrEnum):
+    """Types of artifacts with different validation/logging policies.
+
+    Attributes
+    ----------
+    IMAGE : str
+        Image artifact - expects shape (H, W, 1) monocular or (H, W, 3) RGB
+    """
+
+    IMAGE = "image"

cuvis_ai_schemas/execution/__init__.py

@@ -1,12 +1,12 @@
-"""Execution context schemas."""
-
-from collections.abc import Iterator
-from typing import Any
-
-from cuvis_ai_schemas.execution.context import Context
-from cuvis_ai_schemas.execution.monitoring import Artifact, Metric
-
-# Type alias for data streaming
-InputStream = Iterator[dict[str, Any]]
-
-__all__ = ["Context", "Artifact", "Metric", "InputStream"]
+"""Execution context schemas."""
+
+from collections.abc import Iterator
+from typing import Any
+
+from cuvis_ai_schemas.execution.context import Context
+from cuvis_ai_schemas.execution.monitoring import Artifact, Metric
+
+# Type alias for data streaming
+InputStream = Iterator[dict[str, Any]]
+
+__all__ = ["Context", "Artifact", "Metric", "InputStream"]

cuvis_ai_schemas/execution/context.py

@@ -1,41 +1,41 @@
-"""Execution context for pipeline execution."""
-
-from dataclasses import dataclass
-
-from cuvis_ai_schemas.enums.types import ExecutionStage
-
-
-@dataclass
-class Context:
-    """Execution context passed to executor and nodes.
-
-    Contains runtime information that doesn't flow through data edges.
-    This replaces mutable global state with explicit context parameters.
-
-    Attributes
-    ----------
-    stage : ExecutionStage
-        Execution stage: "train", "val", "test", "inference"
-    epoch : int
-        Current training epoch
-    batch_idx : int
-        Current batch index within epoch
-    global_step : int
-        Global training step across all epochs
-
-    Examples
-    --------
-    >>> context = Context(stage=ExecutionStage.TRAIN, epoch=5, batch_idx=42, global_step=1337)
-    >>> executor.forward(context=context, batch=batch)
-
-    Notes
-    -----
-    Future extensions for distributed training:
-    - rank: int (process rank in distributed training)
-    - world_size: int (total number of processes)
-    """
-
-    stage: ExecutionStage = ExecutionStage.INFERENCE
-    epoch: int = 0
-    batch_idx: int = 0
-    global_step: int = 0
+"""Execution context for pipeline execution."""
+
+from dataclasses import dataclass
+
+from cuvis_ai_schemas.enums.types import ExecutionStage
+
+
+@dataclass
+class Context:
+    """Execution context passed to executor and nodes.
+
+    Contains runtime information that doesn't flow through data edges.
+    This replaces mutable global state with explicit context parameters.
+
+    Attributes
+    ----------
+    stage : ExecutionStage
+        Execution stage: "train", "val", "test", "inference"
+    epoch : int
+        Current training epoch
+    batch_idx : int
+        Current batch index within epoch
+    global_step : int
+        Global training step across all epochs
+
+    Examples
+    --------
+    >>> context = Context(stage=ExecutionStage.TRAIN, epoch=5, batch_idx=42, global_step=1337)
+    >>> executor.forward(context=context, batch=batch)
+
+    Notes
+    -----
+    Future extensions for distributed training:
+    - rank: int (process rank in distributed training)
+    - world_size: int (total number of processes)
+    """
+
+    stage: ExecutionStage = ExecutionStage.INFERENCE
+    epoch: int = 0
+    batch_idx: int = 0
+    global_step: int = 0

cuvis_ai_schemas/execution/monitoring.py

@@ -1,83 +1,83 @@
-"""Monitoring schemas for artifacts and metrics."""
-
-from dataclasses import dataclass
-from typing import TYPE_CHECKING
-
-from cuvis_ai_schemas.enums.types import ArtifactType, ExecutionStage
-
-if TYPE_CHECKING:
-    import numpy as np
-
-
-@dataclass
-class Artifact:
-    """Artifact for logging visualizations and data to monitoring systems.
-
-    Attributes
-    ----------
-    name : str
-        Name/identifier for the artifact
-    value : np.ndarray
-        Numpy array containing the artifact data (shape validated by type)
-    el_id : int
-        Element ID (e.g., batch item index, image index)
-    desc : str
-        Human-readable description of the artifact
-    type : ArtifactType
-        Type of artifact, determines validation and logging policy
-    stage : ExecutionStage
-        Execution stage when artifact was generated
-    epoch : int
-        Training epoch when artifact was generated
-    batch_idx : int
-        Batch index when artifact was generated
-
-    Examples
-    --------
-    >>> import numpy as np
-    >>> artifact = Artifact(
-    ...     name="heatmap_img_0",
-    ...     value=np.random.rand(256, 256, 3),
-    ...     el_id=0,
-    ...     desc="Anomaly heatmap for first image",
-    ...     type=ArtifactType.IMAGE
-    ... )
-    """
-
-    name: str
-    value: "np.ndarray"
-    el_id: int
-    desc: str
-    type: ArtifactType
-    stage: ExecutionStage = ExecutionStage.INFERENCE
-    epoch: int = 0
-    batch_idx: int = 0
-
-
-@dataclass
-class Metric:
-    """Metric for logging scalar values to monitoring systems.
-
-    Attributes
-    ----------
-    name : str
-        Name/identifier for the metric
-    value : float
-        Scalar metric value
-    stage : ExecutionStage
-        Execution stage when metric was recorded
-    epoch : int
-        Training epoch when metric was recorded
-    batch_idx : int
-        Batch index when metric was recorded
-
-    Examples
-    --------
-    >>> metric = Metric(name="loss/train", value=0.123, stage=ExecutionStage.TRAIN)
-    """
-
-    name: str
-    value: float
-    stage: ExecutionStage = ExecutionStage.INFERENCE
-    epoch: int = 0
-    batch_idx: int = 0
+"""Monitoring schemas for artifacts and metrics."""
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from cuvis_ai_schemas.enums.types import ArtifactType, ExecutionStage
+
+if TYPE_CHECKING:
+    import numpy as np
+
+
+@dataclass
+class Artifact:
+    """Artifact for logging visualizations and data to monitoring systems.
+
+    Attributes
+    ----------
+    name : str
+        Name/identifier for the artifact
+    value : np.ndarray
+        Numpy array containing the artifact data (shape validated by type)
+    el_id : int
+        Element ID (e.g., batch item index, image index)
+    desc : str
+        Human-readable description of the artifact
+    type : ArtifactType
+        Type of artifact, determines validation and logging policy
+    stage : ExecutionStage
+        Execution stage when artifact was generated
+    epoch : int
+        Training epoch when artifact was generated
+    batch_idx : int
+        Batch index when artifact was generated
+
+    Examples
+    --------
+    >>> import numpy as np
+    >>> artifact = Artifact(
+    ...     name="heatmap_img_0",
+    ...     value=np.random.rand(256, 256, 3),
+    ...     el_id=0,
+    ...     desc="Anomaly heatmap for first image",
+    ...     type=ArtifactType.IMAGE
+    ... )
+    """
+
+    name: str
+    value: "np.ndarray"
+    el_id: int
+    desc: str
+    type: ArtifactType
+    stage: ExecutionStage = ExecutionStage.INFERENCE
+    epoch: int = 0
+    batch_idx: int = 0
+
+
+@dataclass
+class Metric:
+    """Metric for logging scalar values to monitoring systems.
+
+    Attributes
+    ----------
+    name : str
+        Name/identifier for the metric
+    value : float
+        Scalar metric value
+    stage : ExecutionStage
+        Execution stage when metric was recorded
+    epoch : int
+        Training epoch when metric was recorded
+    batch_idx : int
+        Batch index when metric was recorded
+
+    Examples
+    --------
+    >>> metric = Metric(name="loss/train", value=0.123, stage=ExecutionStage.TRAIN)
+    """
+
+    name: str
+    value: float
+    stage: ExecutionStage = ExecutionStage.INFERENCE
+    epoch: int = 0
+    batch_idx: int = 0

cuvis_ai_schemas/extensions/__init__.py

@@ -1,3 +1,3 @@
-"""Optional extensions for specific use cases."""
-
-__all__: list[str] = []
+"""Optional extensions for specific use cases."""
+
+__all__: list[str] = []

cuvis_ai_schemas/extensions/ui/__init__.py

@@ -1,8 +1,8 @@
-"""UI-specific extensions for port display."""
-
-from cuvis_ai_schemas.extensions.ui.port_display import (
-    DTYPE_COLORS,
-    PortDisplaySpec,
-)
-
-__all__ = ["PortDisplaySpec", "DTYPE_COLORS"]
+"""UI-specific extensions for port display."""
+
+from cuvis_ai_schemas.extensions.ui.port_display import (
+    DTYPE_COLORS,
+    PortDisplaySpec,
+)
+
+__all__ = ["PortDisplaySpec", "DTYPE_COLORS"]