robot-data-audit 0.2.0__tar.gz

robot_data_audit-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Niu Su Technology
+
+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.

robot_data_audit-0.2.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: robot-data-audit
+Version: 0.2.0
+Summary: Robot Data Audit (RDA) - Quality auditing tool for robot datasets
+Author-email: Niu Su Tech <dev@niusutech.com>
+License: MIT
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: numpy>=1.24
+Requires-Dist: lerobot>=0.6
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Provides-Extra: ui
+Requires-Dist: streamlit>=1.30.0; extra == "ui"
+Requires-Dist: plotly>=5.18.0; extra == "ui"
+Requires-Dist: pandas>=2.0; extra == "ui"
+Dynamic: license-file
+
+# Robot Data Audit (RDA)
+
+Quality auditing tool for robot datasets. RDA provides comprehensive metrics for
+evaluating the integrity, temporal consistency, motion quality, and distribution
+coverage of robot trajectory datasets.
+
+## Features
+
+- **Integrity Metrics**: Missing frames, NaN values, schema validation
+- **Temporal Metrics**: Timestamp consistency, sensor sync, jitter analysis
+- **Motion Metrics**: Joint limits, velocity profiles, discontinuities, idle detection
+- **Distribution Metrics**: Distribution statistics, coverage analysis
+- **Three-tier classification**: PASS / REVIEW / EXCLUDE
+- **CLI-first design**: Easy to integrate into data pipelines
+- **Streamlit UI** (coming in v0.2.0): Interactive dashboard for exploring results
+
+## Installation
+
+### From PyPI
+
+> **Note:** PyPI publishing is planned for the v0.2.0 release.
+> Until then, install from source as described below.
+
+```bash
+# Coming soon — PyPI package name: robot-data-assurance
+# pip install robot-data-assurance
+```
+
+### From source (development)
+
+```bash
+git clone <repository-url>
+cd robot-data-audit
+pip install -e .
+```
+
+### With UI support (v0.2.0+)
+
+```bash
+pip install -e ".[ui]"
+```
+
+## Quick Start
+
+### 1. Audit a dataset
+
+```bash
+rda audit /path/to/lerobot/dataset
+```
+
+This will run all 12 RDA metrics against every episode in the dataset and print a
+text summary to the console. A JSON report is automatically saved to
+`<dataset_path>/rda_report.json`.
+
+### 2. Use example datasets
+
+```bash
+# See examples and usage tips
+rda example
+```
+
+### 3. Customize output
+
+```bash
+# Save report to a specific path
+rda audit /path/to/dataset --output my_report.json
+
+# Output JSON to stdout (for piping)
+rda audit /path/to/dataset --format json
+
+# Verbose mode with platform info
+rda audit /path/to/dataset --platform so101 -v
+```
+
+### 4. Preview the UI (coming soon)
+
+```bash
+rda audit /path/to/dataset --ui
+```
+
+## CLI Reference
+
+### `rda audit`
+
+Audit a LeRobot dataset at the given PATH.
+
+```bash
+rda audit [OPTIONS] PATH
+```
+
+| Option | Description |
+|--------|-------------|
+| `-o, --output FILE` | Path to save the JSON audit report. Defaults to `<path>/rda_report.json`. |
+| `--format [json\|text]` | Output format for the audit report. Default: `text`. |
+| `--platform TEXT` | Robot platform name (e.g. `so101`, `droid`). Used for Tier 3 platform-specific metrics. |
+| `--ui` | Launch the Streamlit web UI after the audit completes. *(v0.2.0 preview)* |
+| `-v, --verbose` | Enable verbose output. |
+| `-V, --version` | Show version and exit. |
+| `-h, --help` | Show help message and exit. |
+
+### `rda example`
+
+Show example usage and sample dataset paths.
+
+```bash
+rda example
+```
+
+## Exit Codes
+
+| Code | Meaning |
+|------|---------|
+| `0` | Audit completed successfully, no EXCLUDE verdicts |
+| `1` | Error (invalid path, dataset loading failed, etc.) |
+| `2` | Audit completed successfully, at least one EXCLUDE verdict |
+
+## Project Structure
+
+```
+rda/
+├── cli/          # Click CLI entry points
+├── io/           # Data loading and schema definitions
+├── metrics/      # Audit metric implementations (12 metrics total)
+├── audit/        # Dataset and episode-level audit orchestration
+└── report/       # Report generation and summary
+
+docs/             # API documentation and design specs
+examples/         # Example scripts
+  ├── basic_audit.py       # Core workflow demo (synthetic data ready)
+  └── custom_metrics.py    # How to write custom audit metrics
+tests/            # 155 unit tests
+```
+
+## Documentation
+
+- **[API Reference](docs/API.md)** — Full Python API documentation
+- **[MVP Product Spec](docs/MVP_PRODUCT_SPEC.md)** — Product requirements (v0.2.0)
+- **[Technical Design](TECHNICAL_DESIGN.md)** — Architecture and design decisions
+- **[Project Charter](PROJECT_CHARTER.md)** — Mission, goals, and scope
+- **[Roadmap](ROADMAP.md)** — Release plan and milestones
+- **[Changelog](CHANGELOG.md)** — Version history
+
+## Python API Quick Start
+
+```python
+from rda.audit.dataset_audit import DatasetAuditor
+from rda.io.lerobot_loader import iter_episodes, load_lerobot_dataset
+from rda.report import generate_dataset_report
+
+dataset_info = load_lerobot_dataset("/path/to/dataset")
+auditor = DatasetAuditor()
+result = auditor.audit_dataset(dataset_info, iter_episodes("/path/to/dataset"))
+
+report = generate_dataset_report(result)
+print(f"DHI: {report['quality']['dhi']} / 100")
+```
+
+See [docs/API.md](docs/API.md) for the complete API reference, or
+[examples/](examples/) for runnable scripts.
+
+## Development
+
+### Running tests
+
+```bash
+pytest
+```
+
+### Linting
+
+```bash
+pip install -e ".[dev]"
+ruff check rda/
+```
+
+## License
+
+MIT

robot_data_audit-0.2.0/README.md

@@ -0,0 +1,178 @@
+# Robot Data Audit (RDA)
+
+Quality auditing tool for robot datasets. RDA provides comprehensive metrics for
+evaluating the integrity, temporal consistency, motion quality, and distribution
+coverage of robot trajectory datasets.
+
+## Features
+
+- **Integrity Metrics**: Missing frames, NaN values, schema validation
+- **Temporal Metrics**: Timestamp consistency, sensor sync, jitter analysis
+- **Motion Metrics**: Joint limits, velocity profiles, discontinuities, idle detection
+- **Distribution Metrics**: Distribution statistics, coverage analysis
+- **Three-tier classification**: PASS / REVIEW / EXCLUDE
+- **CLI-first design**: Easy to integrate into data pipelines
+- **Streamlit UI** (coming in v0.2.0): Interactive dashboard for exploring results
+
+## Installation
+
+### From PyPI
+
+> **Note:** PyPI publishing is planned for the v0.2.0 release.
+> Until then, install from source as described below.
+
+```bash
+# Coming soon — PyPI package name: robot-data-assurance
+# pip install robot-data-assurance
+```
+
+### From source (development)
+
+```bash
+git clone <repository-url>
+cd robot-data-audit
+pip install -e .
+```
+
+### With UI support (v0.2.0+)
+
+```bash
+pip install -e ".[ui]"
+```
+
+## Quick Start
+
+### 1. Audit a dataset
+
+```bash
+rda audit /path/to/lerobot/dataset
+```
+
+This will run all 12 RDA metrics against every episode in the dataset and print a
+text summary to the console. A JSON report is automatically saved to
+`<dataset_path>/rda_report.json`.
+
+### 2. Use example datasets
+
+```bash
+# See examples and usage tips
+rda example
+```
+
+### 3. Customize output
+
+```bash
+# Save report to a specific path
+rda audit /path/to/dataset --output my_report.json
+
+# Output JSON to stdout (for piping)
+rda audit /path/to/dataset --format json
+
+# Verbose mode with platform info
+rda audit /path/to/dataset --platform so101 -v
+```
+
+### 4. Preview the UI (coming soon)
+
+```bash
+rda audit /path/to/dataset --ui
+```
+
+## CLI Reference
+
+### `rda audit`
+
+Audit a LeRobot dataset at the given PATH.
+
+```bash
+rda audit [OPTIONS] PATH
+```
+
+| Option | Description |
+|--------|-------------|
+| `-o, --output FILE` | Path to save the JSON audit report. Defaults to `<path>/rda_report.json`. |
+| `--format [json\|text]` | Output format for the audit report. Default: `text`. |
+| `--platform TEXT` | Robot platform name (e.g. `so101`, `droid`). Used for Tier 3 platform-specific metrics. |
+| `--ui` | Launch the Streamlit web UI after the audit completes. *(v0.2.0 preview)* |
+| `-v, --verbose` | Enable verbose output. |
+| `-V, --version` | Show version and exit. |
+| `-h, --help` | Show help message and exit. |
+
+### `rda example`
+
+Show example usage and sample dataset paths.
+
+```bash
+rda example
+```
+
+## Exit Codes
+
+| Code | Meaning |
+|------|---------|
+| `0` | Audit completed successfully, no EXCLUDE verdicts |
+| `1` | Error (invalid path, dataset loading failed, etc.) |
+| `2` | Audit completed successfully, at least one EXCLUDE verdict |
+
+## Project Structure
+
+```
+rda/
+├── cli/          # Click CLI entry points
+├── io/           # Data loading and schema definitions
+├── metrics/      # Audit metric implementations (12 metrics total)
+├── audit/        # Dataset and episode-level audit orchestration
+└── report/       # Report generation and summary
+
+docs/             # API documentation and design specs
+examples/         # Example scripts
+  ├── basic_audit.py       # Core workflow demo (synthetic data ready)
+  └── custom_metrics.py    # How to write custom audit metrics
+tests/            # 155 unit tests
+```
+
+## Documentation
+
+- **[API Reference](docs/API.md)** — Full Python API documentation
+- **[MVP Product Spec](docs/MVP_PRODUCT_SPEC.md)** — Product requirements (v0.2.0)
+- **[Technical Design](TECHNICAL_DESIGN.md)** — Architecture and design decisions
+- **[Project Charter](PROJECT_CHARTER.md)** — Mission, goals, and scope
+- **[Roadmap](ROADMAP.md)** — Release plan and milestones
+- **[Changelog](CHANGELOG.md)** — Version history
+
+## Python API Quick Start
+
+```python
+from rda.audit.dataset_audit import DatasetAuditor
+from rda.io.lerobot_loader import iter_episodes, load_lerobot_dataset
+from rda.report import generate_dataset_report
+
+dataset_info = load_lerobot_dataset("/path/to/dataset")
+auditor = DatasetAuditor()
+result = auditor.audit_dataset(dataset_info, iter_episodes("/path/to/dataset"))
+
+report = generate_dataset_report(result)
+print(f"DHI: {report['quality']['dhi']} / 100")
+```
+
+See [docs/API.md](docs/API.md) for the complete API reference, or
+[examples/](examples/) for runnable scripts.
+
+## Development
+
+### Running tests
+
+```bash
+pytest
+```
+
+### Linting
+
+```bash
+pip install -e ".[dev]"
+ruff check rda/
+```
+
+## License
+
+MIT

robot_data_audit-0.2.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "robot-data-audit"
+version = "0.2.0"
+description = "Robot Data Audit (RDA) - Quality auditing tool for robot datasets"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+authors = [
+    { name = "Niu Su Tech", email = "dev@niusutech.com" },
+]
+classifiers = [
+    "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",
+]
+dependencies = [
+    "click>=8.0",
+    "pydantic>=2.0",
+    "numpy>=1.24",
+    "lerobot>=0.6",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1",
+]
+ui = [
+    "streamlit>=1.30.0",
+    "plotly>=5.18.0",
+    "pandas>=2.0",
+]
+
+[project.scripts]
+rda = "rda.cli.main:cli"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["rda*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

robot_data_audit-0.2.0/rda/__init__.py

@@ -0,0 +1,3 @@
+"""Robot Data Audit (RDA) - Quality auditing tool for robot datasets."""
+
+__version__ = "0.2.0"

robot_data_audit-0.2.0/rda/audit/__init__.py

@@ -0,0 +1,14 @@
+"""Audit orchestration for RDA."""
+
+from rda.audit.rules import AuditVerdict, classify_episode
+from rda.audit.episode_audit import EpisodeAuditor, EpisodeAuditResult
+from rda.audit.dataset_audit import DatasetAuditor, DatasetAuditResult
+
+__all__ = [
+    "AuditVerdict",
+    "classify_episode",
+    "EpisodeAuditor",
+    "EpisodeAuditResult",
+    "DatasetAuditor",
+    "DatasetAuditResult",
+]

robot_data_audit-0.2.0/rda/audit/dataset_audit.py

@@ -0,0 +1,75 @@
+"""Dataset-level audit logic."""
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Dict, List, Optional
+
+from rda.audit.episode_audit import EpisodeAuditResult, EpisodeAuditor
+from rda.audit.rules import AuditVerdict
+from rda.io.schema import DatasetInfo
+
+
+@dataclass
+class DatasetAuditResult:
+    """Result of auditing an entire dataset.
+
+    Attributes:
+        dataset_info: Metadata about the dataset.
+        episodes: Mapping from episode index to EpisodeAuditResult.
+        verdict_counts: Summary count of each verdict across all episodes.
+    """
+
+    dataset_info: DatasetInfo
+    episodes: Dict[int, EpisodeAuditResult] = field(default_factory=dict)
+    verdict_counts: Dict[AuditVerdict, int] = field(default_factory=dict)
+
+    @property
+    def num_episodes(self) -> int:
+        return len(self.episodes)
+
+    def compute_verdict_counts(self) -> Dict[AuditVerdict, int]:
+        """Recount verdict tallies from the episode results."""
+        counts = {v: 0 for v in AuditVerdict}
+        for ep_result in self.episodes.values():
+            counts[ep_result.verdict] += 1
+        self.verdict_counts = counts
+        return counts
+
+
+class DatasetAuditor:
+    """Orchestrates the full audit of a dataset, episode by episode."""
+
+    def __init__(
+        self,
+        episode_auditor: Optional[EpisodeAuditor] = None,
+    ) -> None:
+        """Initialize the dataset auditor.
+
+        Args:
+            episode_auditor: EpisodeAuditor instance to use for each episode.
+                If None, a default EpisodeAuditor with all metrics is created.
+        """
+        self.episode_auditor = episode_auditor or EpisodeAuditor()
+
+    def audit_dataset(
+        self,
+        dataset_info: DatasetInfo,
+        episode_iter,
+    ) -> DatasetAuditResult:
+        """Audit all episodes in the dataset.
+
+        Args:
+            dataset_info: Dataset metadata.
+            episode_iter: Iterator yielding EpisodeData objects.
+
+        Returns:
+            DatasetAuditResult with per-episode results and summary counts.
+        """
+        result = DatasetAuditResult(dataset_info=dataset_info)
+
+        for episode in episode_iter:
+            ep_result = self.episode_auditor.audit(episode)
+            result.episodes[episode.episode_index] = ep_result
+
+        result.compute_verdict_counts()
+        return result