docs: add migration notebook and clarify export usage
This commit is contained in:
@@ -33,8 +33,9 @@ mercury --working-dir notebooks/
|
||||
# Or work on them directly in JupyterLab
|
||||
jupyter lab notebooks/
|
||||
|
||||
# Export the corrected business case as LLM-readable report sources
|
||||
# (exports/*.html for review, exports/*.md for feeding an LLM)
|
||||
# Export the business-case notebooks as LLM-readable report sources
|
||||
# (exports/*.html for review, exports/*.md for feeding an LLM;
|
||||
# optional filter: python scripts/export_report.py migration)
|
||||
python scripts/export_report.py
|
||||
|
||||
# Tests
|
||||
@@ -46,17 +47,18 @@ pytest
|
||||
**The notebooks are the deliverables.** All math lives in the pure-Python
|
||||
`tokencalc/` library; the notebooks are thin presentation layers over it.
|
||||
[Mercury](https://runmercury.com) serves them as interactive web apps — the
|
||||
`mercury` input widgets in `ctm_business_case_corrected.ipynb` let you tune
|
||||
`mercury` input widgets in the business-case notebooks let you tune
|
||||
contract values, termination dates, token assumptions, and implementation
|
||||
pricing live for a client, and headless runs (nbconvert, the section-10 regression
|
||||
gate) simply use the widget defaults. `scripts/export_report.py` executes the
|
||||
notebook and writes HTML + markdown to `exports/`; the notebook's section-12
|
||||
machine-readable appendix carries every number behind the figures so an LLM
|
||||
can draft the client report from the export.
|
||||
pricing live for a client, and headless runs (nbconvert, each notebook's
|
||||
regression-gate section) simply use the widget defaults. `scripts/export_report.py`
|
||||
executes the notebooks and writes HTML + markdown to `exports/`; each notebook's
|
||||
machine-readable appendix section carries every number behind the figures so an
|
||||
LLM can draft the client report from the export.
|
||||
|
||||
| Notebook | Purpose |
|
||||
|---|---|
|
||||
| `notebooks/ctm_business_case_corrected.ipynb` | Client-facing corrected business case (Mercury-interactive) |
|
||||
| `notebooks/ctm_migration_wfm.ipynb` | Migration + WFM only, all AI removed — the no-AI floor of the case (Mercury-interactive) |
|
||||
| `notebooks/ctm_token_calculator.ipynb` | Full token-cost / scenario workbench |
|
||||
|
||||
| Module | Purpose |
|
||||
|
||||
Reference in New Issue
Block a user