Skip to content

docs(explainable-palletizer): add scenario walkthroughs and refresh architecture diagram#216

Closed
nv-asotelo wants to merge 4 commits into
NVIDIA:mainfrom
nv-asotelo:codex/cosmos3-explainable-palletizer
Closed

docs(explainable-palletizer): add scenario walkthroughs and refresh architecture diagram#216
nv-asotelo wants to merge 4 commits into
NVIDIA:mainfrom
nv-asotelo:codex/cosmos3-explainable-palletizer

Conversation

@nv-asotelo

@nv-asotelo nv-asotelo commented Jun 16, 2026

Copy link
Copy Markdown

Summary

Extends the explainable-palletizer recipe documentation with end-to-end decision walkthroughs and an updated runtime architecture diagram. Intended to merge into codex/explainable-palletizer-recipe so it rolls into the existing upstream PR.

Commit: c943a33

Changes

Architecture diagram (assets/main_workflow.svg)

  • Redesigned to show App Server as the central hub (Sim, Inference, Frontend connect through it)
  • Clarifies that Frontend connects directly to Sim Server for the camera stream (WebSocket + REST /sim/)
  • Notes that Sim Server and Inference Server do not communicate directly
  • Updated visual style and zenith-net Docker network boundary

Decision walkthroughs (workflow_e2e.md)

Adds a new "Walkthrough: How the System Decides" section with three concrete control-loop examples:

Scenario | Action | Highlights -- | -- | -- 1 — Damaged carton | CALL_A_HUMAN | Open flap + crushed box; escalation before placement 2 — Heavy appliance | PICK_AND_PLACE | Empty pallets; heavy/sturdy box at base layer z=0, firm grip 3 — Mixed-SKU stacking | PICK_AND_PLACE | Partial pallet; heavy SPAM cans at z=2, delicate glass at z=3

How to review

  1. Skim the new walkthrough section in workflow_e2e.md (starts at "Walkthrough: How the System Decides").
  2. Open assets/main_workflow.svg in a browser to verify the hub-and-spoke layout matches the actual Compose wiring.
  3. Spot-check the three scenario screenshots against the described JSON actions.

Test plan

  •  Markdown renders locally (images + tables)
  •  No code/runtime changes — docs-only PR
  •  Optional: run make docker-up and confirm UI matches scenario screenshots (not required for merge)

paularamo and others added 4 commits June 15, 2026 18:02
…, and recipe templates

Replaces the generic contributing guide with a structured document that
reflects the actual cookbooks/cosmos3/ directory layout and establishes
clear quality requirements for community-contributed cookbooks:

- Cookbook structure section with routing table (reasoner, generator/audiovisual,
  generator/action, generator/transfer)
- Five quality requirements: open-access data, results/expected output,
  canonical setup, one-click runnable, naming convention
- Cookbook README template ready for contributors to copy
- Contribution areas table with clear accept/reject criteria
- Testing checklist for pre-submission validation

(cherry picked from commit 57d2fa4)
…ontributions

Move all existing notebooks, assets, specs, and helpers into basic_examples/
subdirectories under each tower (reasoner, generator/audiovisual, generator/action,
generator/transfer). This creates clean top-level directories ready to receive
community-contributed cookbooks as sibling folders alongside basic_examples/.

- reasoner/basic_examples/: 3 notebooks + prompt guide + 15 media assets
- generator/audiovisual/basic_examples/: 3 notebooks + prompts/images
- generator/action/basic_examples/: 5 notebooks + action/robot assets
- generator/transfer/basic_examples/: 1 notebook + specs + control videos
- Updated all 4 tower READMEs with basic_examples/ cookbook tables and paths
- Updated CONTRIBUTING.md directory tree to show contribution placement

(cherry picked from commit cd95ecc)
Fix all notebook links, nbviewer URLs, and asset paths in the main
README.md Examples table (11 entries) and the NIM curl example to
reference the new basic_examples/ subdirectories. Also update the
cookbooks/cosmos3/README.md vLLM server section to point at the
relocated run_with_vllm.ipynb.

(cherry picked from commit 669ba5c)
…rchitecture diagram

Document three control-loop examples (CALL_A_HUMAN, heavy base placement,
mixed-SKU stacking) with UI screenshots, and update the workflow SVG to
show App Server as the central hub.
@nv-asotelo nv-asotelo force-pushed the codex/cosmos3-explainable-palletizer branch from e1dbcc9 to a10ecd9 Compare June 16, 2026 03:50
@nv-asotelo nv-asotelo changed the title [codex] Add Cosmos3 explainable palletizer cookbook docs(explainable-palletizer): add scenario walkthroughs and refresh architecture diagram Jun 16, 2026
@nv-asotelo

Copy link
Copy Markdown
Author

Closing this upstream draft so we can stage the cookbook changes on nv-asotelo/cosmos first and narrow the diff before reopening upstream.

@nv-asotelo nv-asotelo closed this Jun 16, 2026
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.

2 participants