This directory contains planning documents, specifications, reviews, and completion reports for GIMBAL development.
plans/
├── README.md # This file
├── reference/ # General design references (not version-specific)
├── v0.1/ # v0.1 complete documentation
├── v0.2.0/ # v0.2.0 complete documentation
├── v0.2.1/ # v0.2.1 active documentation
├── v0.2.2/ # v0.2.2 planning (create as needed)
└── archive/ # Historical and intermediate files
├── meta/ # Repository-level historical docs
└── v0.2.1/ # v0.2.1 intermediate debug/iteration files
Files follow the pattern: v{major}.{minor}.{patch}_{type}.md
Types:
overview- High-level roadmap for a versiondetailed_spec/spec_*- Detailed implementation specificationscompletion_report- Post-implementation documentation and resultsreview*- Review comments and iteration notesstep{N}_*- Phase-specific documentationdebug_*/divergence_*- Debugging plans (archive when resolved)
Status: ✅ Complete
v0.1-overview.md- Three-stage architecture overviewv0.1-review-iteration2.md- Second iteration review comments
v0.1.1-detailed-spec.md- Forward algorithm specificationv0.1.1-review-improvements.md- Review and improvement suggestionsv0.1.1-review-revision3.md- Third revision commentsv0.1.1-completion-report.md- ✅ Implementation results and validation
Key Achievement: Numerically stable collapsed HMM with PyTensor scan integration
v0.1.2-detailed-spec.md- Camera projection and kinematics specificationv0.1.2-spec-prompt.md- Specification development promptv0.1.2-review1.md- First review commentsv0.1.2-completion-report.md- ✅ Implementation results and interface contracts
Key Achievement: Per-timestep likelihood computation, exposed U and x_all for Stage 3
v0.1.3-detailed-spec.md- Directional prior over joint directions specificationv0.1.3-completion-report.md- ✅ Implementation results and label switching mitigation
Key Achievement: State-dependent canonical directions with flexible concentration sharing
Status: 🔄 In Progress (v0.2.1 Complete, v0.2.2 Planning)
- v0.2-overview.md - Eight-phase roadmap for v0.2 development
- v0.2-biomechanical-priors-notes.md - Notes on biomechanical prior development
Status: ✅ Complete
See v0.2.0/ directory for completion reports and planning documents.
Status: ✅ Core features complete
Key Documents:
- v0.2.1_step3_completion_summary.md ← Step 3 canonical reference
- v0.2.1_completion_report.md - Data-driven priors implementation
- v0.2.1_spec_data_driven_priors.md - Technical specification
- v0.2.1_Quick_reference_after_step_3_for_step_4.md - Step 4 planning reference
- v0.2.1_step4_implementation_summary.md - Step 4 sampler work
- v0.2.1_divergence_plan_2.md - Current divergence debugging plan
Key Achievements:
- Data-driven priors pipeline (triangulation → cleaning → statistics → priors)
- Synthetic data generation with second-order dynamics
- Camera visualization and 3-tier identifiability checking
- Consolidated skeleton metrics and visualization modules
- Sampler comparison and initialization improvements
Additional Files:
- v0.2.1_step3_synthetic_data_generation.md - Step 3 original plan
- v0.2.1_step3_clarifications_and_questions.md - Design decisions
- v0.2.1_step4_fit_L00.md - Fit configuration documentation
- v0.2.1_toolchain_switches_inventory.md - Configuration options
Archived: Intermediate debug plans and iteration documents are in
archive/v0.2.1/
Create v0.2.2/ directory when planning the next phase. Follow the established naming conventions and keep the root clean for active work.
- Coarse Anatomical Priors & Basic Cleaning
- k-Means / Clustering Empirical-Bayes Priors
- Sampler Decision Spike ✅
- Minimal Synthetic Diagnostics
- First Public Dataset Loader + Baseline Real-Data Fit
- Real-Data Diagnostics & Data-Driven Anatomical Priors
- Coarse PCA + Low-D HMM + Transition Upsampling
- PCA-Informed Priors for Full Model & State-Number Selection
Located in reference/ directory - design documents that apply across versions:
- blended_local_frame_design.md - Local anatomical coordinate frames design
- coordinates.md - Coordinate system construction formulas
- Public database survey.md - Survey of available public motion capture datasets
For each phase:
- Create
vX.Y.Z_detailed_spec.mdorvX.Y.Z_stepN_*.mdwith implementation details - Implement and test
- Write
vX.Y.Z_completion_report.mddocumenting results - Add review files (
vX.Y.Z_review*.md) as needed during development - Move intermediate/debug files to
archive/vX.Y.Z/when work is complete
The archive/ directory contains:
meta/- Repository-level historical documents (e.g., machine transfer notes, cleanup plans)v0.2.1/- v0.2.1 intermediate debug, divergence plans, and iteration documents
Files are archived when:
- They represent intermediate iterations superseded by final documents
- They are debugging plans that have been resolved
- They are historical context no longer needed for active development
| Version | Status | Key Files |
|---|---|---|
| v0.1 (3-stage HMM) | ✅ Complete | v0.1/ - All Stage 1-3 specs and completion reports |
| v0.2.0 (Restructuring) | ✅ Complete | v0.2.0/ |
| v0.2.1 (Data-Driven Priors) | ✅ Complete | v0.2.1/ |
| v0.2.2 (Next Phase) | 📋 Planning | Create v0.2.2/ directory as needed |
Last Updated: January 14, 2026