docs(explainable-palletizer): add scenario walkthroughs and refresh architecture diagram#216
Closed
nv-asotelo wants to merge 4 commits into
Closed
docs(explainable-palletizer): add scenario walkthroughs and refresh architecture diagram#216nv-asotelo wants to merge 4 commits into
nv-asotelo wants to merge 4 commits into
Conversation
…, 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.
e1dbcc9 to
a10ecd9
Compare
Author
|
Closing this upstream draft so we can stage the cookbook changes on nv-asotelo/cosmos first and narrow the diff before reopening upstream. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-recipeso it rolls into the existing upstream PR.Commit:
c943a33Changes
Architecture diagram (
assets/main_workflow.svg)/sim/)zenith-netDocker network boundaryDecision 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=3How to review
workflow_e2e.md(starts at "Walkthrough: How the System Decides").assets/main_workflow.svgin a browser to verify the hub-and-spoke layout matches the actual Compose wiring.Test plan
make docker-upand confirm UI matches scenario screenshots (not required for merge)