nvidia/cosmos-framework · Archived

cosmos3-codebase-nav

Navigate the Cosmos3 package codebase to find where parameters, configs, defaults, scripts, and documentation live. Use when the user asks "where is X in cosmos3", "how do I find the config for Y", "where are the defaults", "where do I change a parameter", or any question about locating files, modules, or settings. Also use when the user opens or edits files and needs orientation.

First seen Jul 13, 2026

Installation

$ npx skills add nvidia/cosmos-framework --skill cosmos3-codebase-nav

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from nvidia/cosmos-framework.

npx skills add nvidia/cosmos-framework

Browse all from nvidia/cosmos-framework

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 500
License LICENSE
Default branch main
Open issues 12
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 11,259 B
  • docs SUMMARY.md 411 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 5 installs

SKILL.md

Cosmos3 Codebase Navigation

When to use this skill

  • Use this skill when an agent is navigating the Cosmos3 package
  • Use this skill to answer "where is X", "how do I find the config for Y", or any file-location question
  • Use this skill when the user opens or edits cosmos3 files and needs orientation

Path convention

All paths below are relative to this file's location (.agents/skills/cosmos3-codebase-nav/). The repo is laid out as:

  • cosmos_framework/ — main training package (data, model, trainer, callbacks, checkpoint, utils, …).
  • cosmosframework/configs/base/experiment/ — vfm (generator) experiment SKUs referenced by [train.trainpolicy].experiment in the recipe TOMLs.
  • cosmos_framework/configs/base/reasoner/experiment/ — vlm (reasoner) experiment SKUs.
  • cosmos_framework/inference/ — inference subpackage (args, model, inference engine, defaults, Ray serving, common helpers).
  • cosmosframework/scripts/ — top-level entry-point scripts (train, inference, eval, exportmodel, convertmodeltodcp, upsampleprompts, captionfromvideo, captionstosftjsonl, actionpolicyserver, …). Invoked as python -m cosmosframework.scripts.<name>.
  • examples/toml/sftconfig/<recipe>.toml + examples/launchsft<recipe>.sh — paired SFT recipes (training entry-point input). The shell sources examples/sftlaunchercommon.sh, which forwards into cosmos_framework.scripts.train --sft-toml=....
  • cosmosframework/configs/tomlconfig/ — pydantic schemas (sft_config.py) and helpers that validate the recipe TOML at load time.

Quick Reference

Where parameters and defaults live

What you're looking for File
Sampling params (num_steps, guidance, shift, fps, etc.) ../../../cosmos_framework/inference/args.py → SamplingArgs, SamplingOverrides
Per-modality default values ../../../cosmosframework/inference/defaults/<mode>/sampleargs.json
Setup params (parallelism, checkpoints, model path) ../../../cosmos_framework/inference/args.py → OmniSetupArgs, OmniSetupOverrides
Common args base classes ../../../cosmos_framework/inference/common/args.py → ArgsBase, OverridesBase
Ray serving parallelism presets ../../../cosmosframework/inference/ray/configs/latency.yaml, ../../../cosmosframework/inference/ray/configs/throughput.yaml
Feature flags ../../../cosmos_framework/utils/flags.py
Prompt upsampler system prompt ../../../cosmosframework/inference/defaults/promptupsampler.txt
Video captioner system prompt ../../../cosmosframework/inference/defaults/videocaptioner.txt
SFT recipe TOMLs (paired with examples/launchsft*.sh) ../../../examples/toml/sft_config/<recipe>.toml
SFT pydantic schema (validates the recipe TOML) ../../../cosmosframework/configs/tomlconfig/sft_config.py
Training experiment SKUs (vfm) ../../../cosmos_framework/configs/base/experiment/
Training experiment SKUs (vlm / reasoner) ../../../cosmos_framework/configs/base/reasoner/experiment/
Example inputs ../../../inputs/omni/t2i.json, ../../../inputs/omni/t2v.json, ../../../inputs/omni/i2v.json, …

Available modality modes for defaults: text2image, text2video, image2video, image2image, video2video, forwarddynamics, inversedynamics, wam.

Config defaults resolution chain

When a user runs inference, default parameter values are resolved in this order:

cosmos_framework/inference/defaults/<mode>/sample_args.json     # 1. Per-modality JSON defaults (num_steps, guidance, shift, fps, etc.)
        ↓
_load_modality_defaults() in cosmos_framework/inference/args.py # 2. Loaded and cached at import time
        ↓
SamplingArgs / SamplingOverrides                      # 3. Pydantic models with field-level validation
        ↓
OmniSampleOverrides.build_sample()                    # 4. Merges user overrides → final resolved args
        ↓
_RESOLUTION_SHIFT_DEFAULTS[model_size, resolution]    # 5. Model+resolution shift override (if user didn't set shift)
        ↓
CLI flags (--guidance, --shift, etc.)                 # 6. User overrides from command line

The RESOLUTIONSHIFTDEFAULTS table in ../../../cosmosframework/inference/args.py (on OmniSampleOverrides) overrides the default shift based on model size and resolution, unless the user explicitly specified --shift.

Mode Default file Key defaults
text2image ../../../cosmosframework/inference/defaults/text2image/sampleargs.json num_frames=1, guidance=6.0, shift=10.0
text2video ../../../cosmosframework/inference/defaults/text2video/sampleargs.json num_frames=189, guidance=6.0, shift=10.0
image2video ../../../cosmosframework/inference/defaults/image2video/sampleargs.json num_frames=189, guidance=6.0, shift=10.0

Action and video2video modes also have defaults under cosmosframework/inference/defaults/{image2image,video2video,forwarddynamics,inversedynamics,policy}/sampleargs.json.

Users can also supply a custom defaults file per-request via the defaults_file field in sample arguments (see ../../../docs/inference.md).

Where to make changes

Task Edit
Change a built-in default value ../../../cosmosframework/inference/defaults/<mode>/sampleargs.json
Add a new CLI parameter SamplingArgs + SamplingOverrides in ../../../cosmosframework/inference/args.py, then add to each sampleargs.json
Change parallelism presets ../../../cosmos_framework/inference/ray/configs/latency.yaml or throughput.yaml
Add a new script ../../../cosmos_framework/scripts/ — follow inference.py as the pattern

Key entry points

Entry point How to run
Batch inference python -m cosmos_framework.scripts.inference
Training python -m cosmosframework.scripts.train --sft-toml=examples/toml/sftconfig/<recipe>.toml
Online serving (Ray) python -m cosmos_framework.inference.ray.serve
Submit to Ray server python -m cosmos_framework.inference.ray.submit
Gradio UI python -m cosmos_framework.inference.ray.gradio
Prompt upsampling python -m cosmosframework.scripts.upsampleprompts
Model export (HF) python -m cosmosframework.scripts.exportmodel
DCP conversion python -m cosmosframework.scripts.convertmodeltodcp
Diffusers conversion python -m cosmosframework.scripts.convertmodeltodiffusers
Video captioning python -m cosmosframework.scripts.captionfrom_video
Captions → SFT JSONL python -m cosmosframework.scripts.captionstosftjsonl
Action policy server (LIBERO HTTP) python -m cosmosframework.scripts.actionpolicyserverlibero
Action policy server (RoboLab WS) python -m cosmosframework.scripts.actionpolicyserverrobolab

Documentation

Doc Covers
../../../AGENTS.md Commands, rules, key file locations (read this first)
../../../README.md Overview, quickstart, examples
../../../docs/setup.md Installation, environment, checkpoints
../../../docs/code_structure.md Repo layout and per-subpackage tour of cosmos_framework/
../../../docs/inference.md Sample args, default values, custom defaults
../../../docs/training.md SFT / post-training workflow
../../../docs/faq.md FAQ, tips, and troubleshooting