embodied-schemas 0.6.0__tar.gz

embodied_schemas-0.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Branes-ai Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

embodied_schemas-0.6.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: embodied-schemas
+Version: 0.6.0
+Summary: Shared schemas and factual data for embodied AI hardware/software codesign
+Author: Branes-ai Team
+License: MIT
+Project-URL: Homepage, https://github.com/branes-ai/embodied-schemas
+Project-URL: Repository, https://github.com/branes-ai/embodied-schemas
+Project-URL: Issues, https://github.com/branes-ai/embodied-schemas/issues
+Keywords: embodied-ai,edge-ai,hardware,codesign,robotics,drones,schemas
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# Embodied Schemas
+
+Shared Pydantic schemas and factual hardware/model data for embodied AI hardware/software codesign.
+
+## Overview
+
+This package provides:
+
+1. **Pydantic Schema Models** - Type-safe data structures for hardware platforms, ML models, sensors, use cases, and benchmarks
+2. **Factual Data Catalog** - YAML files with validated specifications for chips, dev kits, perception models, and sensors
+3. **Registry API** - Unified access to query and filter the data catalog
+
+## Installation
+
+```bash
+pip install embodied-schemas
+
+# For development
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### Import Schema Models
+
+```python
+from embodied_schemas import (
+    HardwareEntry,
+    ModelEntry,
+    SensorEntry,
+    UseCaseEntry,
+    BenchmarkResult,
+)
+from embodied_schemas.hardware import HardwareType, PowerMode
+from embodied_schemas.constraints import LatencyTier, PowerClass
+```
+
+### Access Data Catalog
+
+```python
+from embodied_schemas import Registry
+
+# Load the catalog
+registry = Registry.load()
+
+# Look up hardware by ID
+jetson_nano = registry.hardware.get("nvidia_jetson_nano_4gb")
+
+# Find hardware matching criteria
+edge_devices = registry.hardware.find(
+    suitable_for="edge",
+    power_watts_max=15
+)
+
+# Look up models
+yolov8s = registry.models.get("yolov8s")
+detection_models = registry.models.find(type="object_detection")
+
+# Check compatibility
+is_compatible = registry.is_compatible(
+    model_id="yolov8s",
+    hardware_id="nvidia_jetson_nano_4gb",
+    variant="fp16"
+)
+```
+
+### Use in Tool Outputs
+
+```python
+from embodied_schemas import BenchmarkResult
+from embodied_schemas.benchmarks import LatencyMetrics
+
+result = BenchmarkResult(
+    model_id="yolov8s",
+    hardware_id="nvidia_jetson_nano_4gb",
+    variant="fp16",
+    verdict="PASS",
+    confidence="high",
+    latency=LatencyMetrics(
+        mean_ms=28.5,
+        std_ms=2.1,
+        p95_ms=32.0,
+    ),
+)
+```
+
+## Data Catalog Structure
+
+```
+data/
+├── hardware/           # Complete dev kits and platforms
+│   ├── nvidia/
+│   ├── qualcomm/
+│   ├── hailo/
+│   ├── google/
+│   └── ...
+├── chips/              # Raw SoC/chip specifications
+│   ├── nvidia/
+│   ├── qualcomm/
+│   └── ...
+├── models/             # ML model specifications
+│   ├── detection/
+│   ├── segmentation/
+│   └── ...
+├── sensors/            # Cameras, depth sensors, LiDAR
+│   ├── cameras/
+│   ├── depth/
+│   └── lidar/
+├── usecases/           # Application constraint templates
+│   ├── drone/
+│   ├── quadruped/
+│   ├── amr/
+│   └── edge/
+└── constraints/        # Tier definitions
+    ├── latency_tiers.yaml
+    └── power_classes.yaml
+```
+
+## Related Projects
+
+- [graphs](https://github.com/branes-ai/graphs) - Analysis tools, roofline models, simulators
+- [Embodied-AI-Architect](https://github.com/branes-ai/Embodied-AI-Architect) - LLM orchestration, CLI, knowledge base
+
+## Contributing
+
+### Adding Hardware Data
+
+1. Create YAML file: `src/embodied_schemas/data/hardware/{vendor}/{name}.yaml`
+2. Follow the schema in `src/embodied_schemas/hardware.py`
+3. Run validation: `pytest tests/test_data_validity.py`
+4. Include datasheet URL in the file
+
+### Schema Changes
+
+- Schema changes require version bump
+- Breaking changes require major version bump
+- Add deprecation warnings before removing fields
+
+## License
+
+MIT License - see LICENSE file for details.

embodied_schemas-0.6.0/README.md

@@ -0,0 +1,141 @@
+# Embodied Schemas
+
+Shared Pydantic schemas and factual hardware/model data for embodied AI hardware/software codesign.
+
+## Overview
+
+This package provides:
+
+1. **Pydantic Schema Models** - Type-safe data structures for hardware platforms, ML models, sensors, use cases, and benchmarks
+2. **Factual Data Catalog** - YAML files with validated specifications for chips, dev kits, perception models, and sensors
+3. **Registry API** - Unified access to query and filter the data catalog
+
+## Installation
+
+```bash
+pip install embodied-schemas
+
+# For development
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### Import Schema Models
+
+```python
+from embodied_schemas import (
+    HardwareEntry,
+    ModelEntry,
+    SensorEntry,
+    UseCaseEntry,
+    BenchmarkResult,
+)
+from embodied_schemas.hardware import HardwareType, PowerMode
+from embodied_schemas.constraints import LatencyTier, PowerClass
+```
+
+### Access Data Catalog
+
+```python
+from embodied_schemas import Registry
+
+# Load the catalog
+registry = Registry.load()
+
+# Look up hardware by ID
+jetson_nano = registry.hardware.get("nvidia_jetson_nano_4gb")
+
+# Find hardware matching criteria
+edge_devices = registry.hardware.find(
+    suitable_for="edge",
+    power_watts_max=15
+)
+
+# Look up models
+yolov8s = registry.models.get("yolov8s")
+detection_models = registry.models.find(type="object_detection")
+
+# Check compatibility
+is_compatible = registry.is_compatible(
+    model_id="yolov8s",
+    hardware_id="nvidia_jetson_nano_4gb",
+    variant="fp16"
+)
+```
+
+### Use in Tool Outputs
+
+```python
+from embodied_schemas import BenchmarkResult
+from embodied_schemas.benchmarks import LatencyMetrics
+
+result = BenchmarkResult(
+    model_id="yolov8s",
+    hardware_id="nvidia_jetson_nano_4gb",
+    variant="fp16",
+    verdict="PASS",
+    confidence="high",
+    latency=LatencyMetrics(
+        mean_ms=28.5,
+        std_ms=2.1,
+        p95_ms=32.0,
+    ),
+)
+```
+
+## Data Catalog Structure
+
+```
+data/
+├── hardware/           # Complete dev kits and platforms
+│   ├── nvidia/
+│   ├── qualcomm/
+│   ├── hailo/
+│   ├── google/
+│   └── ...
+├── chips/              # Raw SoC/chip specifications
+│   ├── nvidia/
+│   ├── qualcomm/
+│   └── ...
+├── models/             # ML model specifications
+│   ├── detection/
+│   ├── segmentation/
+│   └── ...
+├── sensors/            # Cameras, depth sensors, LiDAR
+│   ├── cameras/
+│   ├── depth/
+│   └── lidar/
+├── usecases/           # Application constraint templates
+│   ├── drone/
+│   ├── quadruped/
+│   ├── amr/
+│   └── edge/
+└── constraints/        # Tier definitions
+    ├── latency_tiers.yaml
+    └── power_classes.yaml
+```
+
+## Related Projects
+
+- [graphs](https://github.com/branes-ai/graphs) - Analysis tools, roofline models, simulators
+- [Embodied-AI-Architect](https://github.com/branes-ai/Embodied-AI-Architect) - LLM orchestration, CLI, knowledge base
+
+## Contributing
+
+### Adding Hardware Data
+
+1. Create YAML file: `src/embodied_schemas/data/hardware/{vendor}/{name}.yaml`
+2. Follow the schema in `src/embodied_schemas/hardware.py`
+3. Run validation: `pytest tests/test_data_validity.py`
+4. Include datasheet URL in the file
+
+### Schema Changes
+
+- Schema changes require version bump
+- Breaking changes require major version bump
+- Add deprecation warnings before removing fields
+
+## License
+
+MIT License - see LICENSE file for details.

embodied_schemas-0.6.0/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "embodied-schemas"
+version = "0.6.0"
+description = "Shared schemas and factual data for embodied AI hardware/software codesign"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "Branes-ai Team"}
+]
+keywords = [
+    "embodied-ai",
+    "edge-ai",
+    "hardware",
+    "codesign",
+    "robotics",
+    "drones",
+    "schemas",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: System :: Hardware",
+]
+dependencies = [
+    "pydantic>=2.0.0",
+    "pyyaml>=6.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/branes-ai/embodied-schemas"
+Repository = "https://github.com/branes-ai/embodied-schemas"
+Issues = "https://github.com/branes-ai/embodied-schemas/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"embodied_schemas.data" = ["**/*.yaml", "**/*.json"]
+
+[tool.black]
+line-length = 100
+target-version = ['py310', 'py311', 'py312']
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+select = ["E", "F", "I", "W"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+plugins = ["pydantic.mypy"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

embodied_schemas-0.6.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+