cuvis-ai-schemas 0.1.0__tar.gz

cuvis_ai_schemas-0.1.0/.githooks/pre-commit

@@ -0,0 +1,38 @@
+#!/bin/bash
+# Pre-commit hook: Fast quality checks (linting + formatting)
+# Skip with: git commit --no-verify
+
+set -e
+
+echo "Running pre-commit checks..."
+
+# Get list of tracked files before running checks
+TRACKED_FILES=$(git diff --name-only --cached)
+
+# Run Ruff formatting first
+echo "→ Running Ruff formatting..."
+if ! uv run ruff format .; then
+    echo "✗ Ruff formatting failed. Please fix the errors and try again."
+    exit 1
+fi
+
+# Run Ruff linting with auto-fix (on formatted code)
+echo "→ Running Ruff linting (with auto-fix)..."
+if ! uv run ruff check . --fix; then
+    echo "✗ Ruff linting failed. Please fix the errors and try again."
+    exit 1
+fi
+
+# Auto-stage any files that were modified by Ruff
+# Only re-stage files that were originally staged
+if [ -n "$TRACKED_FILES" ]; then
+    echo "→ Auto-staging formatted files..."
+    echo "$TRACKED_FILES" | while read -r file; do
+        if [ -f "$file" ]; then
+            git add "$file"
+        fi
+    done
+fi
+
+echo "✓ Pre-commit checks passed!"
+exit 0

cuvis_ai_schemas-0.1.0/.githooks/pre-push

@@ -0,0 +1,54 @@
+#!/bin/bash
+# Pre-push hook: Comprehensive quality checks (linting + formatting + docstrings + tests)
+# Skip with: git push --no-verify
+
+set -e
+
+echo "Running pre-push checks..."
+
+# Sync dev dependencies first
+echo "→ Syncing dev dependencies..."
+if ! uv sync --all-extras --dev; then
+    echo "✗ Dev dependency sync failed. Please check your environment."
+    exit 1
+fi
+
+# Run Ruff formatting first
+echo "→ Running Ruff formatting..."
+if ! uv run ruff format .; then
+    echo "✗ Ruff formatting failed. Please fix the errors and try again."
+    exit 1
+fi
+
+# Run Ruff linting with auto-fix (on formatted code)
+echo "→ Running Ruff linting (with auto-fix)..."
+if ! uv run ruff check . --fix; then
+    echo "✗ Ruff linting failed. Please fix the errors and try again."
+    exit 1
+fi
+
+# Check docstring coverage (configured in pyproject.toml)
+echo "→ Checking docstring coverage..."
+if ! uv run interrogate cuvis_ai_schemas/; then
+    echo ""
+    echo "✗ Docstring coverage check failed!"
+    echo "  See configuration in pyproject.toml [tool.interrogate]"
+    echo ""
+    echo "  To see detailed missing docstrings:"
+    echo "    interrogate -vv cuvis_ai_schemas/"
+    echo ""
+    echo "  To skip this check (not recommended):"
+    echo "    git push --no-verify"
+    echo ""
+    exit 1
+fi
+
+# Run pytest with non-GPU tests
+echo "→ Running pytest (excluding GPU tests)..."
+if ! uv run python -m pytest tests/ -v --tb=line -m "not slow and not gpu"; then
+    echo "✗ Tests failed. Please fix the failing tests and try again."
+    exit 1
+fi
+
+echo "✓ All pre-push checks passed!"
+exit 0

cuvis_ai_schemas-0.1.0/.gitignore

@@ -0,0 +1,208 @@
+_build
+
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+/docs/_autosummary
+.history/
+/data/
+docs_dev/
+/outputs/
+/wandb/
+lightning_logs/
+.vscode/
+
+/tools/*csv.py
+>>>>>>> 0517224 (updated dataset.py, added band selection strategies and adaclip implementation with examples and tests)
+/examples//outputs/
+cuvis_ai/outputs/
+/tools/*csv.py
+runs/
+test_outputs/
+tensorboard/
+.clinerules
+experiments/
+*.pt
+/.venv-adaclip-test/
+!configs/pipeline/channel_selector.pt
+configs/**/*.png
+.claude/
+*.code-workspace
+
+# Logs
+*.log
+.history/
+.ru

cuvis_ai_schemas-0.1.0/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-02-04
+
+### Added
+- Initial release of cuvis-ai-schemas package
+- Core schema definitions extracted from cuvis-ai-core and cuvis-ai-ui
+- Pipeline structure schemas (PipelineConfig, NodeConfig, ConnectionConfig, PortSpec)
+- Plugin system schemas (PluginManifest, GitPluginConfig, LocalPluginConfig)
+- Training configuration schemas (TrainingConfig, DataConfig, OptimizerConfig, etc.)
+- Execution context schemas (Context, ExecutionStage, Artifact, Metric)
+- Discovery/metadata schemas (NodeInfo, PluginInfo, PipelineInfo)
+- gRPC proto definitions and generated Python stubs
+- Type conversion helpers for proto/Python interop
+- UI extensions for port display (PortDisplaySpec, DTYPE_COLORS)
+- Optional dependencies structure (proto, torch, numpy, lightning, full)
+- Comprehensive test suite
+- Development tools (ruff, pytest, mypy configuration)
+- Git hooks for pre-commit validation
+- Complete documentation (README, API docs)
+
+### Features
+- Lightweight core dependencies (pydantic + pyyaml only)
+- Optional extras for specific features
+- Full Pydantic validation for all schemas
+- JSON and YAML serialization support
+- Proto serialization for gRPC communication
+- Field aliases for backward compatibility
+- Type-safe schema definitions
+- UV package manager support
+- PyTorch CUDA index configuration
+
+### Schema Reconciliation
+- Unified PipelineConfig from core and UI implementations
+- Reconciled PortSpec with UI color extensions
+- Centralized proto definitions (single source of truth)
+- Consistent serialization patterns across all schemas
+
+### Documentation
+- Installation guide with examples
+- Usage examples for all schema categories
+- Development setup instructions
+- Architecture overview
+- Ecosystem integration guide
+- Migration guide for consumers
+
+## [Unreleased]
+
+### Planned
+- Additional schema validators
+- Performance optimizations
+- Extended documentation
+- More usage examples
+
+---
+
+**Legend:**
+- `Added`: New features
+- `Changed`: Changes in existing functionality
+- `Deprecated`: Soon-to-be removed features
+- `Removed`: Removed features
+- `Fixed`: Bug fixes
+- `Security`: Security fixes

cuvis_ai_schemas-0.1.0/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/PKG-INFO

@@ -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.