Docs/improve contributing guidelines#214
Open
paularamo wants to merge 1 commit into
Open
Conversation
nv-asotelo
reviewed
Jun 15, 2026
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.
This was referenced Jun 16, 2026
Closed
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.
Collaborator
|
@paularamo Hi, Sorry that we get this PR delayed. Now the main branch naming rules has changed, could you please resolve these conflicts and we could merge this asap? |
271f6c5 to
3aed2c8
Compare
Author
|
@foreverlms the conflict has been solved. |
Collaborator
|
@yaoxu-crypto Please have a review of this? |
Collaborator
|
Awaiting resolution on this: https://nvidia.slack.com/archives/C0AQFL327FH/p1781556961949859 |
Collaborator
|
Replace the generic CONTRIBUTING.md with a structured guide that establishes clear quality requirements, an application README template, author attribution, and a routing table for community contributions. Add cookbooks/cosmos3/applications/ directory with reasoner/ and generator/ subdirectories (audiovisual, action, transfer) for community and external recipes, keeping the existing NVIDIA-shipped cookbooks untouched. Add an Applications section to the main README.md Table of Contents and body, linking to the new applications directories.
3aed2c8 to
7433b81
Compare
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
cookbooks/cosmos3/applications/directory as the home for external recipes.cookbooks/cosmos3/applications/directory withreasoner/andgenerator/subdirectories (audiovisual, action, transfer), creating a clean contribution surface for the community without modifying the existing NVIDIA-shipped cookbook structure.Contributing Guide Enhancement
The current CONTRIBUTING.md is a 50-line generic fork-commit-PR boilerplate with no guidance on application structure, quality bar, or placement. This PR replaces it with a production-grade contributing guide that includes:
cookbooks/cosmos3/applications/tree with a routing table so contributors know exactly where their content belongs (reasoner, generator/audiovisual, generator/action, generator/transfer).run_<task>_with_<backend>.ipynb)Applications Directory
This PR adds
cookbooks/cosmos3/applications/as the designated home for community and external contributions. The directory mirrors the tower structure used by the core cookbooks:No existing files are moved or renamed — this is a pure addition that creates the contribution surface alongside the existing NVIDIA-shipped cookbooks.
Test Plan
applications/structureapplications/subdirectory README links back to the contributing guide