Skip to content

docs: add landing index.md for multiproject build - #1

Merged
NicholasEhsanRoy merged 1 commit into
mainfrom
docs/landing-index
May 7, 2026
Merged

docs: add landing index.md for multiproject build#1
NicholasEhsanRoy merged 1 commit into
mainfrom
docs/landing-index

Conversation

@NicholasEhsanRoy

Copy link
Copy Markdown
Contributor

Summary

Adds a top-level `docs/index.md` so MADDENING's docs tree can be
built as a standalone Sphinx project, and slot into the unified
`microrobotica.org` multiproject docs site.

Test plan

  • `pip install sphinx myst-parser pydata-sphinx-theme && sphinx-build docs /tmp/maddening-docs` succeeds
  • Generated index renders all toctrees without unreferenced-document warnings

🤖 Generated with Claude Code

Lets MADDENING's docs/ tree be built as a standalone sphinx project
and as a subproject of the unified microrobotica.org docs site.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@NicholasEhsanRoy
NicholasEhsanRoy merged commit c1cfa2d into main May 7, 2026
5 checks passed
NicholasEhsanRoy added a commit that referenced this pull request May 19, 2026
Items #3, #4, #5, #6, #7, #8, #9 marked ☑ complete.  Item #2 marked
◐ in-progress: the subpackage scaffolding (primitives/, weights/,
training/, replace/) landed with full backwards-compat; the MIME
decoder-zoo extraction and the SurrogateArchitecture ABC decoupling
remain v0.2.x follow-ups.

Per-item caveats called out in the section headers:
  #4 — ships as warnings in v0.2; v0.2.1 flips to hard errors.
  #7 — credential lifecycle for AWS/GCP fully tested; live end-to-end
       launch deferred (would require real cloud accounts).
  #8 — file:// + manifest path covered; spot-kill end-to-end test
       deferred until RunPod sandbox is wired in CI.

#1 sharding remains ◐ — M9 multi-GPU smoke test still pending; all
M1-M8 milestones plus the LBM-Guo / wall_mask / replace_node v0.2.x
follow-ups are complete.

Full MADDENING suite after all eight: 1552 passed, 3 skipped, 0
failed — no regressions across the sequence.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
NicholasEhsanRoy added a commit that referenced this pull request May 19, 2026
Goes through every subtask box and updates status:
  [x] = done; [~] = partial (caveat in trailing note); [ ] = deferred

Marks v0.2 item #1's last v0.2.x follow-up (`static_data` channel) as
done now that #3 has landed.  No content changes beyond status —
narrative text and metrics are unchanged.

Remaining open boxes are the cross-repo / live-cloud / docs items
that need either MIME-side work, real cloud credentials, or a
written migration guide:

  - #2: decoder zoo pull-over from MIME; SurrogateTrainer ABC
        decoupling; physical move of trainer/callbacks/physics_losses
        out of the v0.1 leaf modules; CHANGELOG note
  - #3: checkpoint provider-config pattern; sharded-static_data
        semantics; HeatNode / FVM mesh consumer migrations
  - #4: lab-facing migration guide; v0.2.1 flip-to-errors tracking
        issue; MIME-graph smoke check
  - #5: runnable LBM-velocity subscription demo script
  - #6: per-field change-detection wire-format extension; explicit
        latency-budget timing assertion; 256³ live benchmark
  - #7: live end-to-end launches on Lambda / AWS / GCP
  - #8: S3/GCS/Azure blob URLs in download_and_load_state; real
        RunPod spot-kill end-to-end; top-level cloud_resume.md
  - #9: standalone "profile an LBM step" example

Plus #1 M9 (RunPod multi-GPU smoke).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
NicholasEhsanRoy added a commit that referenced this pull request May 19, 2026
The autonomous follow-up batch landed six concrete artifacts that
close out the remaining subtask boxes:

  #3 — HeatNode migration to static_data + checkpoint round-trip
       (9e1fc5b)
  #4 — edge_validation_migration.md guide (9e8e72d)
  #5 — runnable WS subscribe demo (76f606e)
  #6 — encode-latency budget test + slow marker (fc3a6c8)
  #8 — cloud_resume.md top-level guide (9e8e72d)
  #9 — profile_lbm_step example (f70ae23)

Plus the umbrella docs work in 9e8e72d:
  - release_notes/v0.2.md
  - developer_guide/versioned_docs.md (multi-version design)
  - _static/switcher.json
  - installation.md row for the [compression] extra
  - index.md toctree wiring

Remaining open boxes (rolled to v0.2.x / v0.3):
  - #2 decoder pull-over from MIME; ABC decoupling; CHANGELOG note
  - #3 sharded-static_data semantics; FVM mesh migration
  - #4 GitHub issue for the 0.2.1 flip; MIME-graph smoke check
  - #6 per-field-skip wire format
  - #7 live cloud-launch validations
  - #8 s3:// / gs:// URL schemes; live RunPod spot-kill round-trip
  - #1 M9 multi-GPU smoke

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
NicholasEhsanRoy added a commit that referenced this pull request May 20, 2026
Marks the four pre-tag design decisions (commit ec70c19) as
resolved across items #3, #4, #1, #8:

  #3 — sharded static_data semantics decided + documented;
        HeatNode migrated to StaticArray(shard, axis=0);
        Definition-of-done is fully ticked.
  #4 — v0.2.1 flip trigger pinned to MIME-migration-complete;
        units permanently advisory (closed in UnitMismatchWarning
        docstring).
  #1 — requires_halo warning escalated to FutureWarning and now
        references the new MigrationError that takes over in v0.3.
        Grep CI for unmigrated callsites lives on MIME's side.
  #8 — schema version bump policy pinned (N reads N and N-1;
        older raises CheckpointVersionError naming the intermediate
        release).  Policy is the module docstring on
        checkpoint.py + enforced by verify_manifest.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
NicholasEhsanRoy added a commit that referenced this pull request Jun 24, 2026
…SSED)

The node engine is dimension-general from M0, so 2D/3D work directly; this
milestone exercises and validates them and retires the spike's #1 timeline risk
(Limitation 11: 3D Mallat BCOO never built/autodiff'd in JAX).

Verified (7 tests, tests/adaptive/test_wavelet_node_nd.py):
- 2D: cold-start retains coarse, grad-vs-FD 1e-6 (eager), update jittable
  no-recompile.
- 3D RISK GATE: isolated Mallat BCOO solve jax.grad = FD to 4e-11 absolute
  (FD-truncation-limited in relative terms) — the spike's eager-only 1e-9 now
  confirmed on the production 3D JIT path. Full-node 3D grad-vs-FD <1e-6;
  update jittable no-recompile.
- 3D 16^3 (slow lane): hybrid-Jacobi kappa=158 (matches FINDINGS closeout
  Inv 1); CDD at k=N/16 reaches J_err <0.5% vs full solve (closeout 1A ~0.1%).

Runs on GPU (RTX A2000). 3D construct+coldstart ~24s; no ballooning — gate
passed well within the 1-week budget. No src change (engine already dim-general).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PPpX4SXbQjVDCgQbaMcvpC
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.

1 participant