Skip to content

docs: make lifecycle migration verification runnable and versioned #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
stefan-jansen wants to merge 1 commit into from
Closed

docs: make lifecycle migration verification runnable and versioned #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/user-guide/backtest-to-live.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,29 @@ virtual positions, and orderly shutdown without a venue. Then compare the same s
and canonical intents in Backtest and Live on equivalent input. Record data cutoffs, execution
policy, starting positions, fees, and venue capabilities before interpreting outcome differences.
The [API reference](../api/index.md#engine) gives the Live engine signature.

## Run the installed-candidate comparison

From a Linux checkout of this repository with `uv` installed, run:

```bash
uv run --locked python scripts/qualification/check_dependency_matrix.py
```

The verifier builds the checkout's Live wheel, installs it into separate minimum, locked, and
maximum dependency environments, and runs the shared strategy through the real `Engine` and
`LiveEngine` contract tests. It also checks canonical order and broker contracts. The output names
the installed package versions for each profile; a failed contract or installation returns a
nonzero exit status. No provider credentials or venue orders are required.

The published shadow quickstart stack checked on 2026-10-17 was:

| Package | Version |
| --- | --- |
| `ml4t-live` | `0.1.2` |
| `ml4t-backtest` | `0.1.12` |
| `ml4t-specs` | `0.1.5` |

The complete shadow quickstart passed on that stack. The command above builds the current
checkout instead; use its reported versions when recording a new parity or migration result.
Neither result establishes equal venue execution or qualifies a later dependency release.
4 changes: 4 additions & 0 deletions docs/user-guide/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ or different target policy is a migration failure even when both strategies emit
See [Backtest to Live](backtest-to-live.md) for the portability boundary and
[Candidate Qualification](../qualification.md) for the complete package gate.

Run the [installed-candidate comparison](backtest-to-live.md#run-the-installed-candidate-comparison)
to exercise both engine dispatch paths and record the resolved dependency versions. The same
section names the published shadow reference stack; record separate versions for a new parity run.

## Migrate From The Published Beta

The published `0.1.0b3` package remains the prerelease API migration baseline. The first stable
Expand Down
Loading