Skip to content

Update pipeline documentation, both public facing and internal#644

Draft
juaristi22 wants to merge 3 commits intomainfrom
maria/methodology-docs
Draft

Update pipeline documentation, both public facing and internal#644
juaristi22 wants to merge 3 commits intomainfrom
maria/methodology-docs

Conversation

@juaristi22
Copy link
Copy Markdown
Collaborator

Fix #643

juaristi22 and others added 3 commits March 27, 2026 19:06
…ll diagnostics to HF

- docs/methodology.md and docs/data.md updated to match current pipeline
- pipeline.py now uploads validation diagnostics after H5 builds complete,
  in addition to the existing calibration diagnostics upload

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Move docs/calibration_internals.ipynb → docs/internals/calibration_package_internals.ipynb
- Add docs/internals/data_build_internals.ipynb: Stage 1 coverage — clone creation with real assign_random_geography() on 20 records, source imputation concept demo, PUF cloning toy walkthrough
- Add docs/internals/local_dataset_assembly_internals.ipynb: Stages 3–4 — Hard Concrete L0 math, λ preset comparison, weight expansion reference, diagnostics column guide
- Add docs/internals/README.md: navigation index + §9 pipeline orchestration (run ID format, Modal volumes, step dependency graph, resume logic, HuggingFace artifact paths, meta.json structure)
- Extend calibration_package_internals with Part 4 (matrix assembly per-state, domain constraints) and Part 5 (takeup randomization cross-stage demo)
- All notebooks execute with zero errors under --allow-errors; toy inputs complete in <30s
- Add changelog fragment

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@juaristi22 juaristi22 marked this pull request as draft March 27, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Complete calibration_internals.ipynb — document remaining pipeline stages

1 participant