algograph-algebraic-portfol.../AGENTS.md

26 lines
1.1 KiB
Markdown

# AlgoGraph Agent Guide
Architecture overview
- Language: Python for the MVP. Clean separation between core algebraic graph primitives, a lightweight edge-friendly solver, and adapters.
- Core concepts:
- Objects: Local optimization blocks (PortfolioBlock)
- Morphisms: Signals carried between blocks (SignalMorphism)
- PlanDelta: Incremental plan changes with version metadata
- DualVariables: Optimization multipliers/price signals
- Adapters: TLS-enabled connectivity to brokers, feeds, and risk models.
- Central registry (conceptual): Tracks schemas, versions, and attestations for cross-venue interoperability.
What this repo contains
- A minimal, production-oriented MVP implementing the above concepts.
- A toy ADMM-like solver to demonstrate edge/offline capabilities.
- A lightweight adapter scaffold for two venues.
- Basic tests ensuring correctness of core primitives and solver behavior.
How to run tests
- bash test.sh
How to contribute
- Focus on small, testable changes. Prefer minimal, well-documented edits.
- Add or extend tests for any new feature.