specs

Imported from ml4t/specs (AGENTS.md). Install upstream with npx skills add ml4t/specs. Copyright stays with the author.

ml4t-specs

Runtime-neutral, serializable contracts shared at the boundaries of the ML4T libraries. The package defines market-data schemas, artifact metadata, strategy lifecycle events, canonical order intents, execution policies, and position-rule state without depending on a backtest or live engine.

Public entry points

from ml4t.specs import FeedSpec, LifecycleContract, MarketDataSpec
from ml4t.specs import read_spec_payload, write_spec_payload

Use exports from ml4t.specs rather than implementation modules. Contract field names, enum values, validation behavior, and serialized representations are public compatibility surfaces.

Source map

Contract constraints

• Keep specifications independent of engine implementations. Backtest and Live own runtime behavior; Specs owns the values they exchange.
• Use versioned, serializable values for cross-library behavior.
• Export supported contract types from ml4t.specs.
• Preserve compatible payloads. When compatibility cannot be maintained, add a new contract version, migration guidance, and fixtures that define the transition.

Guide maintenance

Update this guide when a public contract family, authoritative documentation path, quality command, or cross-library ownership boundary changes. Do not add current issue state, local workspace paths, or implementation inventories that become stale as files move.

Quality commands

uv sync --dev
uv run ruff check src tests
uv run ruff format --check src tests
uv run ty check
uv run pytest
uv run mkdocs build --strict