31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
# EdgeMind - Agent Documentation
|
|
|
|
Architecture overview:
|
|
- core: idea15_edgemind_verifiable_onboard
|
|
- modules:
|
|
- planner.py: Lightweight MILP-free planner that matches goals to the cheapest providing action within energy budgets
|
|
- contracts.py: SafetyContract primitives for pre/post validation
|
|
- contract_layer.py: Data-contract layer scaffolding (Objects, Morphisms, Functors)
|
|
- cli.py: Simple CLI to exercise the planner and contracts
|
|
|
|
Tech stack:
|
|
- Python 3.8+
|
|
- Numpy, Pydantic, PyYAML for data structures and serialization
|
|
- Lightweight, edge-friendly planning logic with open-ended extensibility
|
|
|
|
How to test:
|
|
- Run pytest to execute tests
|
|
- Use test.sh to run tests and packaging verification (_build_) locally
|
|
|
|
Testing commands:
|
|
- bash test.sh
|
|
- python3 -m build
|
|
|
|
Rules for contributors:
|
|
- Implement features with small, well-scoped patches
|
|
- Write tests for every new feature
|
|
- Keep interfaces backwards-compatible unless explicitly requested
|
|
- Update AGENTS.md with notable architectural changes
|
|
- Added a minimal sidecar module (edgemind/sidecar.py): SQLite-backed append-only audit log and a simple PlanDelta merge helper. Tests added in tests/test_sidecar.py
|
|
- Added PlanCert/PlanProof helpers (edgemind/plan_cert.py): small, deterministic JSON-first certificate format and HMAC-based signing helpers for constrained devices. Tests added in tests/test_plan_cert.py
|