-
Notifications
You must be signed in to change notification settings - Fork 46
Unify launch cmd #438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
gtong-nv
merged 4 commits into
dev/jarcher/inference-runtime-api
from
dev/gtong/unify-launch-cmd
Aug 11, 2026
Merged
Unify launch cmd #438
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| schema_version: 1 | ||
| runner: lingbot-world-fast | ||
| mode: mp4 | ||
|
|
||
| scenario: | ||
| example_data: true | ||
| example_idx: 0 | ||
| total_blocks: 20 | ||
| pixel_width: 832 | ||
| pixel_height: 464 | ||
|
|
||
| output: | ||
| path: ../../outputs/lingbot-replay.mp4 | ||
| fps: 16 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| schema_version: 1 | ||
| runner: lingbot-world-fast | ||
| mode: webrtc | ||
|
|
||
| scenario: | ||
| example_idx: 0 | ||
|
|
||
| output: | ||
| host: 0.0.0.0 | ||
| port: 8080 | ||
| fps: 16 | ||
| video_width: 832 | ||
| video_height: 464 | ||
| warmup_chunks: 10 | ||
| warmup_timeout_s: 600 | ||
| client_liveness_timeout_s: 30 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| schema_version: 1 | ||
| runner: omnidreams-sv-2steps-chunk2-loc6-lightvae-lighttae-perf | ||
| mode: local-window | ||
|
|
||
| scenario: | ||
| auto_start: false | ||
| preload_scenes: false | ||
|
|
||
| output: | ||
| world_model_manifest_path: ../../integrations/omnidreams/omnidreams/interactive_drive/configs/example_world_model_perf.yaml |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| schema_version: 1 | ||
| runner: omnidreams-sv-2steps-chunk2-loc6-lightvae-lighttae | ||
| mode: mp4 | ||
|
|
||
| scenario: | ||
| example_data: true | ||
| total_blocks: 60 | ||
| pixel_width: 1280 | ||
| pixel_height: 704 | ||
|
|
||
| output: | ||
| path: ../../outputs/omnidreams-replay.mp4 | ||
| fps: 30 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| schema_version: 1 | ||
| runner: omnidreams-sv-2steps-chunk2-loc6-lightvae-lighttae | ||
| mode: "null" | ||
|
|
||
| scenario: | ||
| example_data: true | ||
| total_blocks: 10 | ||
| pixel_width: 1280 | ||
| pixel_height: 704 | ||
| fps: 30 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| schema_version: 1 | ||
| runner: omnidreams-sv-2steps-chunk2-loc6-lightvae-lighttae | ||
| mode: webrtc | ||
|
|
||
| runner_overrides: | ||
| device: cuda:0 | ||
|
|
||
| scenario: | ||
| scene_uuid: 0d404ff7-2b66-498c-b047-1ed8cded60d4 | ||
| scene_variant: default | ||
| camera_name: camera_front_wide_120fov | ||
|
|
||
| output: | ||
| host: 0.0.0.0 | ||
| port: 8089 | ||
| fps: 30 | ||
| video_width: 1280 | ||
| video_height: 704 | ||
| warmup_chunks: 10 | ||
| warmup_timeout_s: 600 | ||
| client_liveness_timeout_s: 10 |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| .. SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| .. SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| Launch manifests | ||
| ================ | ||
|
|
||
| Every FlashDreams model launch starts with the same command shape: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| uv run flashdreams-run <runner-slug> [mode] [--manifest PATH] | ||
|
|
||
| ``run`` is the default mode. Integrations may additionally expose ``mp4``, | ||
| ``null``, ``webrtc``, or ``local-window``. Inspect a resolved launch without | ||
| loading checkpoints or initializing CUDA with ``--no-instantiate``. | ||
|
|
||
| Schema | ||
| ------ | ||
|
|
||
| Launch manifests are strict, versioned YAML documents: | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| schema_version: 1 | ||
| runner: omnidreams-sv-2steps-chunk2-loc6-lightvae-lighttae | ||
| mode: webrtc | ||
|
|
||
| runner_overrides: | ||
| device: cuda:0 | ||
|
|
||
| scenario: | ||
| scene_uuid: 0d404ff7-2b66-498c-b047-1ed8cded60d4 | ||
| scene_variant: default | ||
|
|
||
| output: | ||
| host: 0.0.0.0 | ||
| port: 8089 | ||
|
|
||
| ``schema_version``, ``runner``, and ``mode`` are required. The remaining | ||
| sections are optional mappings: | ||
|
|
||
| .. note:: | ||
|
|
||
| Quote the null-output mode as ``mode: "null"`` in YAML; an unquoted | ||
| ``null`` is YAML's null scalar rather than the FlashDreams mode name. | ||
|
|
||
| ``runner_overrides`` | ||
| Recursive overrides for the registered runner configuration. The same | ||
| runner fields remain available as explicit CLI flags. | ||
|
|
||
| ``scenario`` | ||
| Inputs and controls such as prompts, example data, scenes, traces, and | ||
| rollout length. The selected integration validates the accepted fields. | ||
|
|
||
| ``output`` | ||
| Transport or artifact settings such as output path, frame rate, WebRTC | ||
| bind address, warmup, and local-window presentation settings. | ||
|
|
||
| Relative paths in keys named ``path`` or ending in ``_path``, ``_paths``, or | ||
| ``_dir`` resolve relative to the manifest file, which makes checked-in launch | ||
| manifests reproducible from any working directory. Unknown top-level or | ||
| integration-specific fields fail before CUDA initialization. | ||
|
|
||
| Precedence | ||
| ---------- | ||
|
|
||
| Settings resolve in this order, from lowest to highest precedence: | ||
|
|
||
| .. code-block:: text | ||
|
|
||
| registered runner preset | ||
| < manifest runner_overrides | ||
| < manifest scenario/output | ||
| < explicit CLI runner flags and --host/--port | ||
|
|
||
| The runner and positional mode must agree with the manifest. For example, this | ||
| fails instead of silently launching a different preset: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| uv run flashdreams-run lingbot-world-fast mp4 \ | ||
| --manifest docs/launch_manifests/lingbot_webrtc.yaml | ||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| # WebRTC | ||
| uv run flashdreams-run lingbot-world-fast webrtc \ | ||
| --manifest docs/launch_manifests/lingbot_webrtc.yaml | ||
|
|
||
| # MP4 replay | ||
| uv run flashdreams-run lingbot-world-fast mp4 \ | ||
| --manifest docs/launch_manifests/lingbot_mp4.yaml | ||
|
|
||
| # Resolve an OmniDreams launch without loading the model | ||
| uv run flashdreams-run \ | ||
| omnidreams-sv-2steps-chunk2-loc6-lightvae-lighttae webrtc \ | ||
| --manifest docs/launch_manifests/omnidreams_webrtc.yaml \ | ||
| --no-instantiate | ||
|
|
||
| OmniDreams local-window also accepts the existing | ||
| ``example_world_model*.yaml`` format directly as a compatibility input. New | ||
| automation should use a versioned launch manifest whose | ||
| ``output.world_model_manifest_path`` references that model-specific file. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: we will need to update the website accordingly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do another round of updating