1.4 KiB

Raw Blame History

AGENTS.md

Architecture and contribution guide for CatOpt-Grid.

Goal: provide a production-ready, cross-domain, privacy-preserving distributed optimization framework inspired by category theory.
Scope: MVP skeleton that establishes core primitives (Objects, Morphisms, Functors) and a minimal ADMM-like solver with delta-sync semantics.
Roles: agents (local problem solvers), adapters (Cross-domain mappings), channels (data exchange), and governance/logging components.

Project Rules

Follow the architecture described in the main repository README and this AGENTS.md.
Tests must pass locally via the provided test.sh script.
Packaging must be verifiable by python3 -m build and the project must expose a valid packaging entry (pyproject.toml).
Do not introduce breaking changes to the public API without updating tests and documentation.

Development workflow

Implement small, well-scoped changes first (per the editing approach).
Write/adjust tests to cover new behavior.
Update README with usage, install, and contribution guidelines.

Testing and CI

Run test.sh locally to validate functionality and packaging viability.
Ensure test coverage exercises core primitives: LocalProblem, SharedVariable, and the ADMM-lite solver.

Changelog and governance

Document design decisions, tradeoffs, and privacy/security considerations in the README and AGENTS.md.

End of AGENTS.md