-
Notifications
You must be signed in to change notification settings - Fork 810
docs: Simplify sphinx build and table of contents on webpage #2519
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
Merged
Changes from 18 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
051a8ee
First draft: conf.py greatly simplified (need to add back nv theme, e…
rmccorm4 9d46868
Bring back some bits from old conf.py
rmccorm4 80b408d
Try relative paths for component READMEs, undo whitespace changes to …
rmccorm4 2a14789
Add symlink for sglang README, comment out suppressed myst warning
rmccorm4 d103271
Add minimal symlinks, and suppress myst.xref_missing warnings
rmccorm4 efbbfc8
Restore docs/components/router/README.md
rmccorm4 92cb7ec
Sync with main
rmccorm4 f5a6e49
Fix new warnings of unused docs after sync with main
rmccorm4 c18e5b4
docs: Refactor left side table of contents for docs website - v1
rmccorm4 95ba86e
Merge branch 'main' into rmccormick/docs_build
rmccorm4 fddd1e3
docs: Apply Harry's feedback, condense overview/quickstart, remove sl…
rmccorm4 eb6ff81
docs: Address CodeRabbit feedback
rmccorm4 ba773bf
Replace k8s quickstart with dynamo_deploy/README.md instead of dynamo…
rmccorm4 97be098
Replace k8s quickstart with dynamo_deploy/README.md instead of dynamo…
rmccorm4 bc1d940
Anish's feedback - use dynamo kubernetes platform doc as quickstart, …
rmccorm4 c373219
Anish's feedback - remove duplicate deploy quickstart, we already hav…
rmccorm4 d6db2fa
fix broken links from deleted dynamo deploy quickstart
rmccorm4 41ed5c6
CodeRabbit feedback: download docker compose file since no assumed gi…
rmccorm4 050fdc2
Remove outdated deploy quickstart from hidden_toctree
rmccorm4 6629466
Merge branch 'main' into rmccormick/docs_build
rmccorm4 a378217
Fix merge conflicts with main
rmccorm4 5841ada
Merge branch 'rmccormick/docs_build' of github.com:ai-dynamo/dynamo i…
rmccorm4 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
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,32 @@ | ||
| The examples below assume you build the latest image yourself from source. If using a prebuilt image follow the examples from the corresponding branch. | ||
|
|
||
| .. grid:: 1 2 2 2 | ||
| :gutter: 3 | ||
| :margin: 0 | ||
| :padding: 3 4 0 0 | ||
|
|
||
| .. grid-item-card:: :doc:`Hello World <../examples/runtime/hello_world/README>` | ||
| :link: ../examples/runtime/hello_world/README | ||
| :link-type: doc | ||
|
|
||
| Demonstrates the basic concepts of Dynamo by creating a simple GPU-unaware graph | ||
|
|
||
| .. grid-item-card:: :doc:`vLLM <../components/backends/vllm/README>` | ||
| :link: ../components/backends/vllm/README | ||
| :link-type: doc | ||
|
|
||
| Presents examples and reference implementations for deploying Large Language Models (LLMs) in various configurations with VLLM. | ||
|
|
||
| .. grid-item-card:: :doc:`SGLang <../components/backends/sglang/README>` | ||
| :link: ../components/backends/sglang/README | ||
| :link-type: doc | ||
|
|
||
| Presents examples and reference implementations for deploying Large Language Models (LLMs) in various configurations with SGLang. | ||
|
|
||
| .. grid-item-card:: :doc:`TensorRT-LLM <../components/backends/trtllm/README>` | ||
| :link: ../components/backends/trtllm/README | ||
| :link-type: doc | ||
|
|
||
| Presents examples and reference implementations for deploying Large Language Models (LLMs) in various configurations with TensorRT-LLM. | ||
|
|
||
|
|
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,44 @@ | ||
| Pip (PyPI) | ||
| ---------- | ||
|
|
||
| Install a pre-built wheel from PyPI. | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| # Create a virtual environment and activate it | ||
| uv venv venv | ||
| source venv/bin/activate | ||
|
|
||
| # Install Dynamo from PyPI (choose one backend extra) | ||
| uv pip install "ai-dynamo[sglang]==0.4.1" # or [vllm], [trtllm] | ||
|
|
||
|
|
||
| Pip from source | ||
| --------------- | ||
|
|
||
| Install directly from a local checkout for development. | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| # Clone the repository | ||
| git clone https://github.com/ai-dynamo/dynamo.git | ||
| cd dynamo | ||
|
|
||
| # Create a virtual environment and activate it | ||
| uv venv venv | ||
| source venv/bin/activate | ||
| uv pip install ".[sglang]" # or [vllm], [trtllm] | ||
rmccorm4 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| Docker | ||
| ------ | ||
|
|
||
| Pull and run prebuilt images from NVIDIA NGC (`nvcr.io`). | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| # Run a container (mount your workspace if needed) | ||
| docker run --rm -it \ | ||
| --gpus all \ | ||
| --network host \ | ||
| nvcr.io/nvidia/ai-dynamo/sglang-runtime:0.4.1 # or vllm, tensorrtllm | ||
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,43 @@ | ||
| Get started with Dynamo locally in just a few commands: | ||
|
|
||
| **1. Install Dynamo** | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| # Install uv (recommended Python package manager) | ||
| curl -LsSf https://astral.sh/uv/install.sh | sh | ||
|
|
||
| # Create virtual environment and install Dynamo | ||
| uv venv venv | ||
| source venv/bin/activate | ||
| uv pip install "ai-dynamo[sglang]==0.4.1" # or [vllm], [trtllm] | ||
rmccorm4 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| **2. Start etcd/NATS** | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| # Fetch and start etcd and NATS using Docker Compose | ||
| curl -fsSL -o docker-compose.yml https://raw.githubusercontent.com/ai-dynamo/dynamo/release/0.4.1/deploy/docker-compose.yml | ||
| docker compose -f docker-compose.yml up -d | ||
|
|
||
| **3. Run Dynamo** | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| # Start the OpenAI compatible frontend (default port is 8080) | ||
| python -m dynamo.frontend | ||
|
|
||
| # In another terminal, start an SGLang worker | ||
| python -m dynamo.sglang --model-path Qwen/Qwen3-0.6B | ||
|
|
||
| **4. Test your deployment** | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| curl localhost:8080/v1/chat/completions \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{"model": "Qwen/Qwen3-0.6B", | ||
| "messages": [{"role": "user", "content": "Hello!"}], | ||
| "max_tokens": 50}' | ||
|
|
||
rmccorm4 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
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,11 @@ | ||
| Overview | ||
| ============ | ||
|
|
||
| .. include:: ../architecture/architecture.md | ||
| :parser: myst_parser.sphinx_ | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
|
|
||
| Overview <self> | ||
| Disaggregated Serving <../architecture/disagg_serving> |
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,42 @@ | ||
| .. | ||
| SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
|
|
||
| Backends | ||
| ======== | ||
|
|
||
| NVIDIA Dynamo supports multiple inference backends to provide flexibility and performance optimization for different use cases and model architectures. Backends are the underlying engines that execute AI model inference, each optimized for specific scenarios, hardware configurations, and performance requirements. | ||
|
|
||
| Overview | ||
| -------- | ||
|
|
||
| Dynamo's multi-backend architecture allows you to: | ||
|
|
||
| * **Choose the optimal engine** for your specific workload and hardware | ||
| * **Switch between backends** without changing your application code | ||
| * **Leverage specialized optimizations** from each backend | ||
| * **Scale flexibly** across different deployment scenarios | ||
|
|
||
| Supported Backends | ||
| ------------------ | ||
|
|
||
| Dynamo currently supports the following high-performance inference backends: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| vLLM <../components/backends/vllm/README> | ||
| SGLang <../components/backends/sglang/README> | ||
| TensorRT-LLM <../components/backends/trtllm/README> |
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,8 @@ | ||
| .. | ||
| Quickstart Page (left sidebar target) | ||
| .. | ||
|
|
||
| Examples | ||
| ======== | ||
|
|
||
| .. include:: ../_includes/dive_in_examples.rst |
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 @@ | ||
| .. | ||
| Installation Page (left sidebar target) | ||
| .. | ||
|
|
||
| Installation | ||
| ============ | ||
|
|
||
| .. include:: ../_includes/install.rst | ||
|
|
||
|
|
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
This file was deleted.
Oops, something went wrong.
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 @@ | ||
| ../../../../components/backends/sglang/README.md |
1 change: 1 addition & 0 deletions
1
docs/components/backends/trtllm/multinode/multinode-examples.md
rmccorm4 marked this conversation as resolved.
Show resolved
Hide resolved
|
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 @@ | ||
| ../../../../../components/backends/trtllm/multinode/multinode-examples.md |
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 @@ | ||
| ../../../../components/backends/vllm/LMCache_Integration.md |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.