Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

GIMBAL Plans Directory

This directory contains planning documents, specifications, reviews, and completion reports for GIMBAL development.

Directory Structure

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

File Naming Convention

Files follow the pattern: v{major}.{minor}.{patch}_{type}.md

Types:

  • overview - High-level roadmap for a version
  • detailed_spec / spec_* - Detailed implementation specifications
  • completion_report - Post-implementation documentation and results
  • review* - Review comments and iteration notes
  • step{N}_* - Phase-specific documentation
  • debug_* / divergence_* - Debugging plans (archive when resolved)

Version 0.1 — Three-Stage HMM Integration

Status: ✅ Complete

v0.1 Overview

  • v0.1-overview.md - Three-stage architecture overview
  • v0.1-review-iteration2.md - Second iteration review comments

v0.1.1 — Collapsed HMM Engine (Stage 1)

  • v0.1.1-detailed-spec.md - Forward algorithm specification
  • v0.1.1-review-improvements.md - Review and improvement suggestions
  • v0.1.1-review-revision3.md - Third revision comments
  • v0.1.1-completion-report.md - ✅ Implementation results and validation

Key Achievement: Numerically stable collapsed HMM with PyTensor scan integration

v0.1.2 — Camera Observation Model (Stage 2)

  • v0.1.2-detailed-spec.md - Camera projection and kinematics specification
  • v0.1.2-spec-prompt.md - Specification development prompt
  • v0.1.2-review1.md - First review comments
  • v0.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 — Directional HMM Prior (Stage 3)

  • v0.1.3-detailed-spec.md - Directional prior over joint directions specification
  • v0.1.3-completion-report.md - ✅ Implementation results and label switching mitigation

Key Achievement: State-dependent canonical directions with flexible concentration sharing

Version 0.2 — Priors, Real Data, and Robustness

Status: 🔄 In Progress (v0.2.1 Complete, v0.2.2 Planning)

v0.2 Overview

v0.2.0 — Project Restructuring

Status: ✅ Complete

See v0.2.0/ directory for completion reports and planning documents.

v0.2.1 — Data-Driven Priors & Synthetic Data Pipeline

Status: ✅ Core features complete

Key Documents:

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:

Archived: Intermediate debug plans and iteration documents are in archive/v0.2.1/

v0.2.2 and Beyond

Create v0.2.2/ directory when planning the next phase. Follow the established naming conventions and keep the root clean for active work.

Phases (0.2.1 - 0.2.8) - Overall Roadmap

  1. Coarse Anatomical Priors & Basic Cleaning
  2. k-Means / Clustering Empirical-Bayes Priors
  3. Sampler Decision Spike
  4. Minimal Synthetic Diagnostics
  5. First Public Dataset Loader + Baseline Real-Data Fit
  6. Real-Data Diagnostics & Data-Driven Anatomical Priors
  7. Coarse PCA + Low-D HMM + Transition Upsampling
  8. PCA-Informed Priors for Full Model & State-Number Selection

Reference Documents (Non-Version-Specific)

Located in reference/ directory - design documents that apply across versions:

Development Workflow

For each phase:

  1. Create vX.Y.Z_detailed_spec.md or vX.Y.Z_stepN_*.md with implementation details
  2. Implement and test
  3. Write vX.Y.Z_completion_report.md documenting results
  4. Add review files (vX.Y.Z_review*.md) as needed during development
  5. Move intermediate/debug files to archive/vX.Y.Z/ when work is complete

Archive Directory

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

Quick Reference

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