Skip to content

Commit 95e2deb

Browse files
committed
docs:add-project-progress-tracker
1 parent c9227d4 commit 95e2deb

3 files changed

Lines changed: 72 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
Research framework for routing prompts across evolving LLM portfolios with a compact Liquid AI encoder.
66

7-
> **Research status:** Pre-alpha repository foundation. No benchmark results or trained router checkpoint are claimed yet.
7+
> **Research status:** Pre-alpha. The repository foundation is complete and the xRouteBench source audit is next. No benchmark results or trained router checkpoint are claimed yet.
8+
>
9+
> **Project progress:** [2 of 17 core parts complete — view the tracker](docs/PROJECT_TRACKER.md)
810
911
## Research question
1012

@@ -36,7 +38,7 @@ Development order:
3638
8. Online bandit adapter and budget pacing.
3739
9. External benchmarks, ablations, and research release.
3840

39-
See the [project blueprint](docs/PROJECT_BLUEPRINT.md) for the full ordered build plan and the [research handoff](docs/RESEARCH_HANDOFF.md) for the literature and dataset review.
41+
See the [project tracker](docs/PROJECT_TRACKER.md) for current progress, the [project blueprint](docs/PROJECT_BLUEPRINT.md) for the full ordered build plan, and the [research handoff](docs/RESEARCH_HANDOFF.md) for the literature and dataset review.
4042

4143
## Repository layout
4244

@@ -102,4 +104,3 @@ See [CONTRIBUTING.md](CONTRIBUTING.md). Please do not commit private prompts, pr
102104
## License
103105

104106
A code license has not yet been selected. Until a `LICENSE` file is added, default copyright applies. This does not change the separate licenses of Liquid AI models or upstream datasets.
105-

docs/PROJECT_BLUEPRINT.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
**Proposed paper title:** **LFM2.5-ModelRouter: Sparse Cold-Start Routing for Evolving LLM Portfolios**
77
**Primary encoder:** `LiquidAI/LFM2.5-Encoder-350M`
88
**Detailed research reference:** [`RESEARCH_HANDOFF.md`](RESEARCH_HANDOFF.md)
9+
**Current progress:** [`PROJECT_TRACKER.md`](PROJECT_TRACKER.md)
910

1011
This document is the practical build order for the project. Each numbered part is a real system component or a required research stage. We will follow the parts in order and will not treat a later part as complete until its entry conditions are satisfied.
1112

docs/PROJECT_TRACKER.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# LFM2.5-ModelRouter Project Tracker
2+
3+
| Tracker summary | Current value |
4+
|---|---|
5+
| Last updated | 2026-08-21 |
6+
| Current phase | Part 2 — Dataset Source Audit and Ingestion |
7+
| Core progress | 2 of 17 parts complete (Parts 0–16) |
8+
| Optional work | Part 17 is deferred until the MVP is complete |
9+
10+
This file is the quick status board for the project. The
11+
[project blueprint](PROJECT_BLUEPRINT.md) remains the source of truth for each
12+
part's requirements and completion gate.
13+
14+
## Status Legend
15+
16+
| Symbol | Meaning |
17+
|---|---|
18+
| ✅ Done | Completion gate passed and the work is merged |
19+
| 🚧 In progress | Work has started on a dedicated branch |
20+
| ➡️ Next | The next part to begin |
21+
| ⬜ Pending | Waiting for earlier parts |
22+
| 💤 Deferred | Optional work outside the current MVP |
23+
24+
## Full Project Tracker
25+
26+
| Part | System part | Status | Evidence or next gate |
27+
|---:|---|---|---|
28+
| 0 | Project Contract and Scope | ✅ Done | Scope and research question are documented |
29+
| 1 | Reproducible Repository Foundation | ✅ Done | [PR #1](https://github.com/MaharshPatelX/LFM2.5-ModelRouter/pull/1) merged; CI passed |
30+
| 2 | Dataset Source Audit and Ingestion | ➡️ **Next** | Produce the audit, manifest, schema snapshot, sample, adapter, and tests |
31+
| 3 | Canonical Data Layer | ⬜ Pending | Complete Part 2 first |
32+
| 4 | Deduplication and Leakage-Safe Splits | ⬜ Pending | Complete Part 3 first |
33+
| 5 | Baseline Suite | ⬜ Pending | Complete Part 4 first |
34+
| 6 | LFM Query Encoder | ⬜ Pending | Complete Part 5 first |
35+
| 7 | Candidate Model Profile System | ⬜ Pending | Complete Part 6 first |
36+
| 8 | Multi-Outcome Predictor | ⬜ Pending | Complete Part 7 first |
37+
| 9 | Runtime Registry, Constraints and Optimizer | ⬜ Pending | Complete Part 8 first |
38+
| 10 | Static Offline Evaluation | ⬜ Pending | Complete Part 9 first |
39+
| 11 | Unseen-Model Cold-Start Experiments | ⬜ Pending | Complete Part 10 first |
40+
| 12 | Non-Stationary Replay Simulator | ⬜ Pending | Complete Part 11 first |
41+
| 13 | Online Adapter and Budget Pacing | ⬜ Pending | Complete Part 12 first |
42+
| 14 | External and Extended Benchmarks | ⬜ Pending | Complete Part 13 first |
43+
| 15 | Ablations, Statistics and Research Validation | ⬜ Pending | Complete Part 14 first |
44+
| 16 | Research Release | ⬜ Pending | Complete Part 15 first |
45+
| 17 | Later Extensions | 💤 Deferred | Consider only after the MVP release |
46+
47+
## Next Part Checklist — Part 2
48+
49+
- [ ] Pin the exact xRouteBench dataset revision.
50+
- [ ] Record source URLs, verification date, configurations, splits, files, row counts, columns, dtypes, and missingness.
51+
- [ ] Confirm download requirements, license terms, and redistribution rules.
52+
- [ ] Download and inspect a small sample before handling the full dataset.
53+
- [ ] Implement an ingestion adapter that preserves source values.
54+
- [ ] Save a machine-readable schema snapshot and dataset manifest.
55+
- [ ] Add a small legally redistributable fixture and deterministic loading tests.
56+
- [ ] Write `reports/xroutebench_audit.md`.
57+
- [ ] Verify every Part 2 completion gate in the blueprint.
58+
- [ ] Merge the Part 2 pull request and mark Part 2 as done here.
59+
60+
## How to Maintain This Tracker
61+
62+
1. Keep only one part marked **Next** or **In progress**.
63+
2. Change **Next** to **In progress** when its implementation branch is created.
64+
3. Mark a part **Done** only after its blueprint completion gate passes and its pull request is merged.
65+
4. Add the merged pull request link in the evidence column.
66+
5. Move **Next** to the following part in the same tracker update.
67+
6. Update the date and progress count whenever a status changes.

0 commit comments

Comments
 (0)