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

cuvis_ai_schemas/training/scheduler.py

@@ -0,0 +1,69 @@
+"""Scheduler configuration schema."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+if TYPE_CHECKING:
+    try:
+        from cuvis_ai_schemas.grpc.v1 import cuvis_ai_pb2
+    except ImportError:
+        cuvis_ai_pb2 = None  # type: ignore[assignment]
+
+
+class SchedulerConfig(BaseModel):
+    """Learning rate scheduler configuration."""
+
+    name: str | None = Field(
+        default=None, description="Scheduler type: cosine, step, exponential, plateau"
+    )
+    warmup_epochs: int = Field(default=0, ge=0, description="Number of warmup epochs")
+    min_lr: float = Field(default=1e-6, ge=0.0, description="Minimum learning rate")
+    t_max: int | None = Field(
+        default=None, ge=1, description="Maximum iterations (for cosine annealing)"
+    )
+    step_size: int | None = Field(
+        default=None, ge=1, description="Period of LR decay (for step scheduler)"
+    )
+    gamma: float | None = Field(
+        default=None, ge=0.0, le=1.0, description="Multiplicative factor of LR decay"
+    )
+    monitor: str | None = Field(
+        default=None, description="Metric to monitor (for plateau/reduce_on_plateau)"
+    )
+    mode: str = Field(default="min", description="min or max for monitored metrics")
+    factor: float = Field(
+        default=0.1,
+        ge=0.0,
+        le=1.0,
+        description="LR reduction factor for ReduceLROnPlateau",
+    )
+    patience: int = Field(default=10, ge=0, description="Patience for plateau scheduler")
+    threshold: float = Field(default=1e-4, ge=0.0, description="Plateau threshold")
+    threshold_mode: str = Field(default="rel", description="Plateau threshold mode")
+    cooldown: int = Field(default=0, ge=0, description="Cooldown epochs for plateau")
+    eps: float = Field(default=1e-8, ge=0.0, description="Minimum change in LR for plateau")
+    verbose: bool = Field(default=False, description="Verbose scheduler logging")
+
+    model_config = ConfigDict(extra="forbid", validate_assignment=True, populate_by_name=True)
+
+    def to_proto(self) -> Any:
+        """Convert to protobuf message (requires proto extra)."""
+        try:
+            from cuvis_ai_schemas.grpc.v1 import cuvis_ai_pb2
+        except ImportError as e:
+            raise ImportError(
+                "Proto support requires the 'proto' extra: pip install cuvis-ai-schemas[proto]"
+            ) from e
+
+        return cuvis_ai_pb2.SchedulerConfig(config_bytes=self.model_dump_json().encode("utf-8"))
+
+    @classmethod
+    def from_proto(cls, proto_config):
+        """Create from protobuf message (requires proto extra)."""
+        return cls.model_validate_json(proto_config.config_bytes.decode("utf-8"))
+
+
+__all__ = ["SchedulerConfig"]

cuvis_ai_schemas/training/trainer.py

@@ -0,0 +1,40 @@
+"""Trainer configuration schema."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from cuvis_ai_schemas.training.callbacks import CallbacksConfig
+
+
+class TrainerConfig(BaseModel):
+    """Lightning Trainer configuration."""
+
+    max_epochs: int = Field(default=100, ge=1, description="Maximum number of epochs")
+    accelerator: str = Field(default="auto", description="Accelerator type")
+    devices: int | str | None = Field(default=None, description="Number of devices or IDs")
+    default_root_dir: str | None = Field(default=None, description="Root directory for outputs")
+    precision: str | int = Field(default="32-true", description="Precision mode")
+    accumulate_grad_batches: int = Field(default=1, ge=1, description="Accumulate gradients")
+    enable_progress_bar: bool = Field(default=True, description="Show progress bar")
+    enable_checkpointing: bool = Field(default=False, description="Enable checkpointing")
+    log_every_n_steps: int = Field(default=50, ge=1, description="Log frequency in steps")
+    val_check_interval: float | int | None = Field(
+        default=1.0, ge=0.0, description="Validation interval"
+    )
+    check_val_every_n_epoch: int | None = Field(
+        default=1, ge=1, description="Validate every n epochs"
+    )
+    gradient_clip_val: float | None = Field(
+        default=None, ge=0.0, description="Gradient clipping value"
+    )
+    deterministic: bool = Field(default=False, description="Deterministic training")
+    benchmark: bool = Field(default=False, description="Enable cudnn benchmark")
+    callbacks: CallbacksConfig | None = Field(
+        default=None, description="Callback configurations for trainer"
+    )
+
+    model_config = ConfigDict(extra="forbid", validate_assignment=True, populate_by_name=True)
+
+
+__all__ = ["TrainerConfig"]

cuvis_ai_schemas-0.1.0.dist-info/METADATA

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: cuvis-ai-schemas
+Version: 0.1.0
+Summary: Lightweight schema definitions for cuvis-ai ecosystem
+Author-email: "Cubert GmbH, Ulm, Germany" <SDK@cubert-gmbh.com>
+License: Apache-2.0
+Project-URL: Homepage, https://www.cubert-hyperspectral.com/
+Project-URL: Repository, https://github.com/cubert-hyperspectral/cuvis-ai-schemas
+Project-URL: Documentation, https://cubert-hyperspectral.github.io/cuvis-ai-schemas/
+Project-URL: Issues, https://github.com/cubert-hyperspectral/cuvis-ai-schemas/issues
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.12,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: proto
+Requires-Dist: grpcio>=1.56.0; extra == "proto"
+Requires-Dist: protobuf>=4.25.0; extra == "proto"
+Requires-Dist: grpcio-tools>=1.56.0; extra == "proto"
+Provides-Extra: torch
+Requires-Dist: torch>=2.0.0; extra == "torch"
+Requires-Dist: torchvision; extra == "torch"
+Provides-Extra: numpy
+Requires-Dist: numpy>=1.21.0; extra == "numpy"
+Provides-Extra: lightning
+Requires-Dist: pytorch-lightning>=2.0.0; extra == "lightning"
+Provides-Extra: full
+Requires-Dist: cuvis-ai-schemas[lightning,numpy,proto,torch]; extra == "full"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: types-protobuf; extra == "dev"
+Requires-Dist: types-grpcio; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Requires-Dist: interrogate>=1.7.0; extra == "dev"
+Dynamic: license-file
+
+# cuvis-ai-schemas
+
+Lightweight schema definitions for the cuvis-ai ecosystem.
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/)
+
+## Overview
+
+`cuvis-ai-schemas` is a centralized, dependency-light package of schema definitions used across the cuvis-ai ecosystem. It enables type-safe communication between services without heavy runtime requirements.
+
+Key points:
+- Minimal deps (pydantic + pyyaml)
+- Full Pydantic validation
+- Optional extras for proto, torch, numpy, lightning
+
+## Installation
+
+```bash
+uv add cuvis-ai-schemas
+uv add "cuvis-ai-schemas[proto]"
+uv add "cuvis-ai-schemas[full]"
+```
+
+Extras:
+- `proto`: gRPC and protobuf support
+- `torch`: PyTorch dtype handling (validation only)
+- `numpy`: NumPy array support
+- `lightning`: PyTorch Lightning training configs
+- `full`: All features
+- `dev`: Development dependencies
+
+## Usage
+
+```python
+from cuvis_ai_schemas.pipeline import PipelineConfig, NodeConfig
+
+pipeline = PipelineConfig(
+    nodes=[NodeConfig(id="node_1", class_name="DataLoader", params={"batch_size": 32})],
+    connections=[],
+)
+
+pipeline_json = pipeline.to_json()
+pipeline = PipelineConfig.from_json(pipeline_json)
+```
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest tests/ -v
+uv run ruff check cuvis_ai_schemas/ tests/
+uv run ruff format cuvis_ai_schemas/ tests/
+uv run mypy cuvis_ai_schemas/
+```
+
+## Contributing
+
+Contributions are welcome. Please:
+1. Ensure tests pass
+2. Run ruff format and ruff check
+3. Keep type hints and update docs as needed
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.

cuvis_ai_schemas-0.1.0.dist-info/RECORD

@@ -0,0 +1,34 @@
+cuvis_ai_schemas/__init__.py,sha256=cEoW_6VhQTDoZJ7s36fD-XucImqr7Mte9kgYc8U5czY,138
+cuvis_ai_schemas/discovery/__init__.py,sha256=DZPwdfykdkiNYYdjr2GqaxXkuUWxqxSVDUy9QQvj7Sw,170
+cuvis_ai_schemas/enums/__init__.py,sha256=v4RxrtLuZHQ9IbZF-9UEP-7WC2YrTU8eD9PaO8MmPiU,168
+cuvis_ai_schemas/enums/types.py,sha256=Z3QI4Ot7ZQCx17d7R2P9cnVAYBNtbQF6jcv9NudfuQ8,706
+cuvis_ai_schemas/execution/__init__.py,sha256=eEPDx3Dp4hnUcnmchM8OxsQFc4O00Yw27erQ73aK8_I,361
+cuvis_ai_schemas/execution/context.py,sha256=cSfbqqnuVDv7qDW9av00WNnkBaR4L6oFiG6yEbCVhBw,1185
+cuvis_ai_schemas/execution/monitoring.py,sha256=Ergy2-Y30rN6Mv8LJznN9zTaFKqiOs6r4h--G4pFGAc,2198
+cuvis_ai_schemas/extensions/__init__.py,sha256=vra0q4YuJYhIlvOqUrAA9A5sCSrTQI5NBuo2NyyZmfQ,78
+cuvis_ai_schemas/extensions/ui/__init__.py,sha256=BQxq_sO2yDeXW6GP8m0azwrEdPGzXhC0w5S9Z8YsIvM,202
+cuvis_ai_schemas/extensions/ui/port_display.py,sha256=YeXlPcTA5KPhlzCXmuKJoi7tpLk3apy_B4HL_x53xd0,5692
+cuvis_ai_schemas/grpc/__init__.py,sha256=ic0OaeiJ_hSTme3i-J4h4sbPWESt9aub-kT4j9kaUWg,67
+cuvis_ai_schemas/grpc/v1/__init__.py,sha256=HWdAc1gI2PezL3t6auqyTu4L7qrX3A_q4_CVLVZavAA,316
+cuvis_ai_schemas/grpc/v1/cuvis_ai_pb2.py,sha256=Hxcp-Jv8DV3OklIOzGzd0oLzQteeBum2KlQGvByqLyQ,31205
+cuvis_ai_schemas/grpc/v1/cuvis_ai_pb2.pyi,sha256=6VmdJxOsPcglrae9BlnGleq2-E_4ByLwFXdjIdAsAT8,37546
+cuvis_ai_schemas/grpc/v1/cuvis_ai_pb2_grpc.py,sha256=A6zmNedPvywG4XS_8uZYx5vkxhRkuA2WSSWmGSjqDxo,51711
+cuvis_ai_schemas/pipeline/__init__.py,sha256=ujDyeGD0EF2lsn6AKmuzwGXMcMFVoZrtSdL2vNSbZsU,353
+cuvis_ai_schemas/pipeline/config.py,sha256=sYRd5a8-m6H_-8E1Nya7FfjDwIhjidmSGX7ZRp_ukPo,7204
+cuvis_ai_schemas/pipeline/ports.py,sha256=k8lNc7xgWgh-9k24kxK61LVIML_NAXKJ1ii-LvOEa4w,1419
+cuvis_ai_schemas/plugin/__init__.py,sha256=Ou9dYcJt8boyYJs7NXds684t_KMJbbzXgvGXdPI4sAY,244
+cuvis_ai_schemas/plugin/config.py,sha256=cBh4tt75z_WycirvFFlqwTCrzXU36hamV2hZy31c6K8,3777
+cuvis_ai_schemas/plugin/manifest.py,sha256=nOLx_qkWtlSYCsaILZOatSFx-Rqq5AKjDZKbXy_Wr_k,2832
+cuvis_ai_schemas/training/__init__.py,sha256=zqrwsjVKw1xTw4kXmaYZqCnxpBiUSbUgYhNxAQS8DVA,1016
+cuvis_ai_schemas/training/callbacks.py,sha256=37TLPoJVMLx2HSJ9MCAgnmh_oxfM9eTokeHbGa7y0Wk,5347
+cuvis_ai_schemas/training/config.py,sha256=pN2mXj2uqM4GJbjQREo6kHz_tz3U-fBBLHLPvgakAa4,5261
+cuvis_ai_schemas/training/data.py,sha256=9eE1g7_XFyMsYajupmpaTTADx9kAQrLeG2XS1rNNcwY,2652
+cuvis_ai_schemas/training/optimizer.py,sha256=H91MtWLuXVMsfzMnqzaA6FaZAan72tn3uP60eNV8H4c,2795
+cuvis_ai_schemas/training/run.py,sha256=n8H0HFgdYv89zFUUkda3Uq13qKXJwFe1jewz03gFP04,7150
+cuvis_ai_schemas/training/scheduler.py,sha256=08AHjnfwCxQXLaONj0ClnsawUuyhrNOU8rryf2eS38k,2747
+cuvis_ai_schemas/training/trainer.py,sha256=kXMRfm2ZUFKNaRYDHht2DnGahaj9wsHVFzir4w0i2Nk,1836
+cuvis_ai_schemas-0.1.0.dist-info/licenses/LICENSE,sha256=m9KVK0hEPXjQ4cu8W-_kuHdPbjMXZPyzmI4OPQL1xBk,10946
+cuvis_ai_schemas-0.1.0.dist-info/METADATA,sha256=hkXIaWsMMqCSPI1e_2lEneVabbLYJBiEviut8IN5AyM,3766
+cuvis_ai_schemas-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+cuvis_ai_schemas-0.1.0.dist-info/top_level.txt,sha256=-l9DD2FK3AVzo3ry6TOmsK9OmrXEDB6AX8y3K-n1agk,17
+cuvis_ai_schemas-0.1.0.dist-info/RECORD,,

cuvis_ai_schemas-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cuvis_ai_schemas-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Cubert GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cuvis_ai_schemas-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cuvis_ai_schemas