30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
# FleetOpt AGENTS
|
|
|
|
Overview
|
|
- FleetOpt is a production-ready, privacy-preserving multi-fleet optimization platform. This repository contains the MVP core and a clear architecture for future expansion.
|
|
|
|
Tech Stack
|
|
- Language: Python 3.9+
|
|
- Core modules: core/models.py, core/registry.py, core/solver.py, core/privacy.py, core/ledger.py
|
|
- Adapters: adapters/ros2_adapter.py (stub for ROS 2 integration)
|
|
- API (optional): server/api.py (FastAPI-based in-progress; tests should use core components directly)
|
|
- Tests: tests/test_fleetopt.py
|
|
|
|
Key Concepts
|
|
- LocalRobotPlan: a fleet-specific plan for a robot (tasks, path, objectives).
|
|
- SharedSignals: aggregated signals shared through the contract registry.
|
|
- PlanDelta: changes to a plan since last sync.
|
|
- PrivacyBudget: simple per-signal budget to bound leakage.
|
|
- GraphOfContracts: registry for signal exchange policies and signal lineage.
|
|
- DualVariables: ADMM dual variables used during coordination.
|
|
- AuditLog: governance ledger for traceability.
|
|
|
|
Development & Testing Rules
|
|
- Run tests with `pytest -q`.
|
|
- Packaging verification with `python3 -m build`.
|
|
- Ensure all changes are committed in small, cohesive patches; do not modify unrelated files.
|
|
|
|
Contribution
|
|
- Open PRs with clear scope and tests; ensure tests cover edge cases in the solver and privacy budget.
|
|
- When extending adapters, add unit tests that mock ROS 2 interfaces.
|