|
1 | 1 | # Project Status |
2 | 2 |
|
3 | | -## Migration status |
4 | | -- Python-to-Rust module test parity is complete for the tracked mlfinlab suite. |
5 | | -- Source of truth: `openquant-rs/tests/crosswalk.md`. |
6 | | -- Roadmap remaining list is empty. |
| 3 | +## Current delivery state (2026-02-13) |
| 4 | +- AFML gap modules tracked in epic `OQ-mef` are implemented in `crates/openquant/src/`: |
| 5 | + `ensemble_methods`, `hyperparameter_tuning`, `backtesting_engine`, `synthetic_backtesting`, |
| 6 | + `strategy_risk`, `hpc_parallel`, `combinatorial_optimization`, and `streaming_hpc`. |
| 7 | +- Panic-based public API paths were migrated to typed errors under `OQ-mef.6`. |
| 8 | +- Notebook-first platform artifacts are present: |
| 9 | + Python bindings (`crates/pyopenquant`), Python API package (`python/openquant`), |
| 10 | + notebook starter packs (`notebooks/python`, `notebooks/rust`), experiment scaffold (`experiments/`), |
| 11 | + and CI smoke workflows (`.github/workflows/python-bindings.yml`, |
| 12 | + `.github/workflows/notebooks-examples-smoke.yml`). |
7 | 13 |
|
8 | | -## Do we still need mlfinlab repo locally? |
9 | | -Short answer: not required for day-to-day OpenQuant usage, still useful for maintenance. |
| 14 | +## Reconciliation status |
| 15 | +- Reconciliation source of truth: `docs/reconciliation_closure_history.md`. |
| 16 | +- Most previously closed deliverables are now present on `main`. |
| 17 | +- Two acceptance-criteria mismatches remain tracked as open follow-ups: |
| 18 | + - `OQ-ojp`: docs-site notebook workflow page + navigation links. |
| 19 | + - `OQ-det`: experiment plot artifact outputs and tests. |
10 | 20 |
|
11 | | -Keep mlfinlab if you want to: |
12 | | -- add new parity modules/tests in the future, |
13 | | -- re-generate fixtures from Python behavior, |
14 | | -- validate behavior drift against upstream changes. |
15 | | - |
16 | | -You can archive/remove mlfinlab locally if you are: |
17 | | -- focused only on OpenQuant runtime/library usage, |
18 | | -- not planning additional parity backports, |
19 | | -- comfortable relying on existing fixtures + Rust tests only. |
20 | | - |
21 | | -## Functional status |
22 | | -OpenQuant is functional for the migrated tracked package scope, with: |
23 | | -- passing fast/full Rust test sweeps (except intentionally isolated long SADF run in default fast path), |
24 | | -- benchmark baselines and regression checks, |
25 | | -- release-readiness CI workflow. |
26 | | - |
27 | | -## Known caveats |
28 | | -- `test_sadf_test` is intentionally excluded from fast CI and run in dedicated slow/nightly path. |
29 | | -- Performance thresholds are now wired but should be tightened over time as variance stabilizes. |
| 21 | +## Quality and CI posture |
| 22 | +- Core CI workflows are present for lint/test, benchmark regression, release checks, bindings smoke, |
| 23 | + and notebook/example smoke. |
| 24 | +- Remaining work is focused on documentation-site parity and experiment artifact completeness |
| 25 | + (tracked by `OQ-ojp` and `OQ-det`). |
0 commit comments