Docs/improve contributing guidelines#214
Open
paularamo wants to merge 4 commits into
Open
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
…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
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.
nv-asotelo
reviewed
Jun 15, 2026
nv-asotelo
left a comment
nv-asotelo
left a comment
There was a problem hiding this comment.
LGTM - Need repo owners to weigh in on the contributing guidelines and migration of the basic examples to the respective directories.
Xuanmeng-Zhang
added a commit
that referenced
this pull request
Jun 16, 2026
- Place SFT recipes under their capability cookbooks: vision recipes ->
cookbooks/cosmos3/generator/audiovisual/finetune/, reasoner recipes ->
cookbooks/cosmos3/reasoner/finetune/ (sibling of existing inference content,
forward-compatible with #214).
- Surface the finetune cookbooks on the repo landing page (README Finetune).
- Trim each README to the happy path; link advanced config + raw torchrun to the
canonical framework docs (training.md, sft_config.md).
- Add the recommended NGC PyTorch base image to Prerequisites.
- Rewrite each launch_sft_*.sh as a simple, self-contained recipe: linear
numbered steps (download -> convert -> train) with hardcoded paths, dropping
the shared launcher helper and all env-var override knobs.
Adds "6. Author Attribution" to the cookbook quality requirements, requiring all recipes to include author name(s) and organization in both the README and notebook first cell. Updates the README template with the author block format.
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
3 participants
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
cookbooks/cosmos3/directory layout, establishes clear quality requirements forcommunity-contributed cookbooks, and provides a ready-to-copy README template.
basic_examples/subdirectories, creating a clean contribution surface for the community.
Contributing Guide Enhancement
The current CONTRIBUTING.md is a 50-line generic fork-commit-PR boilerplate with no guidance
on cookbook structure, quality bar, or placement. This PR replaces it with a production-grade
contributing guide that includes:
cookbooks/cosmos3/tree with a routing tableso contributors know exactly where their content belongs (reasoner, generator/audiovisual,
generator/action, generator/transfer).
run_<task>_with_<backend>.ipynb)results section, and dataset table with license.
Cookbook Restructure:
basic_examples/This PR also reorganizes every cookbook directory (reasoner, generator/audiovisual,
generator/action, generator/transfer) by moving the shipped starter notebooks, assets,
specs, and helpers into a
basic_examples/subdirectory. The top-level directory undereach tower now holds only the README and is ready to receive community-contributed
cookbooks as sibling folders (e.g.,
reasoner/worker_safety/,generator/audiovisual/its_text2image/).All paths in the main README.md Examples table (11 notebook links + nbviewer URLs),
the NIM curl example, and the cookbooks/cosmos3/README.md vLLM section have been
updated to reflect the new locations. No notebook content was modified, this is a
pure restructure to separate NVIDIA-shipped examples from the contribution surface.
Test Plan
basic_examples/pathsreasoner/basic_examples/assets/robot_153.jpg)