"docs/vscode:/vscode.git/clone" did not exist on "b2aea8f3c62aa6ab1f49773c23da2b86f57fcac1"
Unverified Commit 9bdc8b73 authored by dagil-nvidia's avatar dagil-nvidia Committed by GitHub
Browse files

docs: fix 14 broken links detected by lychee CI (#6438)


Signed-off-by: default avatarDan Gil <dagil@nvidia.com>
Co-authored-by: default avatarCursor <cursoragent@cursor.com>
parent 121d8050
...@@ -2,4 +2,8 @@ ...@@ -2,4 +2,8 @@
^file:// ^file://
# Ignore URLs in test data files # Ignore URLs in test data files
.*tests/data.* .*tests/data.*
\ No newline at end of file
# Ignore placeholder URLs in docs templates
^https://\.\.\./
^https://github\.com/\.\.\.
\ No newline at end of file
...@@ -167,5 +167,5 @@ and the worker awaits for the data transfer to complete for yielding a response. ...@@ -167,5 +167,5 @@ and the worker awaits for the data transfer to complete for yielding a response.
- [NVIDIA Dynamo](https://developer.nvidia.com/dynamo) @ [GitHub](https://github.com/ai-dynamo/dynamo) - [NVIDIA Dynamo](https://developer.nvidia.com/dynamo) @ [GitHub](https://github.com/ai-dynamo/dynamo)
- [NVIDIA Inference Transfer Library (NIXL)](https://developer.nvidia.com/blog/introducing-nvidia-dynamo-a-low-latency-distributed-inference-framework-for-scaling-reasoning-ai-models/#nvidia_inference_transfer_library_nixl_low-latency_hardware-agnostic_communication%C2%A0) @ [GitHub](https://github.com/ai-dynamo/nixl) - [NVIDIA Inference Transfer Library (NIXL)](https://developer.nvidia.com/blog/introducing-nvidia-dynamo-a-low-latency-distributed-inference-framework-for-scaling-reasoning-ai-models/#nvidia_inference_transfer_library_nixl_low-latency_hardware-agnostic_communication%C2%A0) @ [GitHub](https://github.com/ai-dynamo/nixl)
- [Dynamo Multimodal Example](https://github.com/ai-dynamo/dynamo/tree/main/examples/multimodal.md) - [Dynamo Multimodal Example](https://github.com/ai-dynamo/dynamo/tree/main/examples/multimodal)
- [NVIDIA GPU Direct](https://developer.nvidia.com/gpudirect) - [NVIDIA GPU Direct](https://developer.nvidia.com/gpudirect)
...@@ -261,4 +261,4 @@ We currently provide deployment examples for Kubernetes and SLURM. ...@@ -261,4 +261,4 @@ We currently provide deployment examples for Kubernetes and SLURM.
- **[Deploying Dynamo with SGLang on Kubernetes](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/sglang/deploy/README.md)** - **[Deploying Dynamo with SGLang on Kubernetes](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/sglang/deploy/README.md)**
## SLURM ## SLURM
- **[Deploying Dynamo with SGLang on SLURM](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/sglang/slurm-jobs/README.md)** - **[Deploying Dynamo with SGLang on SLURM](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/sglang/slurm_jobs/README.md)**
...@@ -47,7 +47,7 @@ python -m dynamo.sglang \ ...@@ -47,7 +47,7 @@ python -m dynamo.sglang \
The diffusion worker uses the **LowConfidence** algorithm for the iterative refinement process. This algorithm refines tokens with low confidence scores, progressively replacing masked tokens with the model's predictions until confidence thresholds are met. The diffusion worker uses the **LowConfidence** algorithm for the iterative refinement process. This algorithm refines tokens with low confidence scores, progressively replacing masked tokens with the model's predictions until confidence thresholds are met.
For more details on diffusion algorithms and configuration options, refer to the [SGLang Diffusion Language Models documentation](https://github.com/sgl-project/sglang/blob/main/docs/supported_models/diffusion_language_models.md). For more details on diffusion algorithms and configuration options, refer to the [SGLang Diffusion Language Models documentation](https://github.com/sgl-project/sglang/blob/main/docs/supported_models/text_generation/diffusion_language_models.md).
## Testing the Deployment ## Testing the Deployment
......
...@@ -364,7 +364,7 @@ The `--enable-attention-dp` flag sets `attention_dp_size = tensor_parallel_size` ...@@ -364,7 +364,7 @@ The `--enable-attention-dp` flag sets `attention_dp_size = tensor_parallel_size`
## Performance Sweep ## Performance Sweep
For detailed instructions on running comprehensive performance sweeps across both aggregated and disaggregated serving configurations, see the [TensorRT-LLM Benchmark Scripts for DeepSeek R1 model](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/trtllm/performance-sweeps/README.md). This guide covers recommended benchmarking setups, usage of provided scripts, and best practices for evaluating system performance. For detailed instructions on running comprehensive performance sweeps across both aggregated and disaggregated serving configurations, see the [TensorRT-LLM Benchmark Scripts for DeepSeek R1 model](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/trtllm/performance_sweeps/README.md). This guide covers recommended benchmarking setups, usage of provided scripts, and best practices for evaluating system performance.
## Dynamo KV Block Manager Integration ## Dynamo KV Block Manager Integration
......
...@@ -98,7 +98,7 @@ kubectl create secret generic hf-token-secret \ ...@@ -98,7 +98,7 @@ kubectl create secret generic hf-token-secret \
### Step 1.3: Install Dynamo Platform (Per-Namespace) ### Step 1.3: Install Dynamo Platform (Per-Namespace)
If your cluster uses namespace-restricted Dynamo operators, you'll need to install the Dynamo platform in each namespace. Follow the [Dynamo Kubernetes Installation Guide](https://github.com/ai-dynamo/dynamo/blob/main/docs/kubernetes/installation-guide.md) to install the platform in both namespaces: If your cluster uses namespace-restricted Dynamo operators, you'll need to install the Dynamo platform in each namespace. Follow the [Dynamo Kubernetes Installation Guide](https://github.com/ai-dynamo/dynamo/blob/main/docs/pages/kubernetes/installation-guide.md) to install the platform in both namespaces:
- `router-off-test` - `router-off-test`
- `router-on-test` - `router-on-test`
......
...@@ -49,7 +49,7 @@ The Python `Context` class wraps the Rust `AsyncEngineContext` and exposes the f ...@@ -49,7 +49,7 @@ The Python `Context` class wraps the Rust `AsyncEngineContext` and exposes the f
- **`stop_generating()`**: Issues a stop generating signal, equivalent to the Rust method - **`stop_generating()`**: Issues a stop generating signal, equivalent to the Rust method
- **`async_killed_or_stopped()`**: An async method that completes when the context becomes either killed or stopped, whichever happens first. This combines the functionality of the Rust `killed()` and `stopped()` async methods using `tokio::select!`. - **`async_killed_or_stopped()`**: An async method that completes when the context becomes either killed or stopped, whichever happens first. This combines the functionality of the Rust `killed()` and `stopped()` async methods using `tokio::select!`.
For a working example of request cancellation, see the [cancellation demo](https://github.com/ai-dynamo/dynamo/tree/main/examples/custom-backend/cancellation/README.md). For a working example of request cancellation, see the [cancellation demo](https://github.com/ai-dynamo/dynamo/tree/main/examples/custom_backend/cancellation/README.md).
### Context Usage in Python ### Context Usage in Python
......
...@@ -10,7 +10,7 @@ The examples below assume you build the latest image yourself from source. If us ...@@ -10,7 +10,7 @@ The examples below assume you build the latest image yourself from source. If us
Demonstrates the basic concepts of Dynamo by creating a simple GPU-unaware graph. Demonstrates the basic concepts of Dynamo by creating a simple GPU-unaware graph.
[View Hello World Example](https://github.com/ai-dynamo/dynamo/tree/main/examples/runtime/hello_world) [View Hello World Example](https://github.com/ai-dynamo/dynamo/tree/main/examples/custom_backend/hello_world)
## vLLM ## vLLM
......
...@@ -46,7 +46,7 @@ Before deploying the platform, run the pre-deployment checks to ensure the clust ...@@ -46,7 +46,7 @@ Before deploying the platform, run the pre-deployment checks to ensure the clust
./deploy/pre-deployment/pre-deployment-check.sh ./deploy/pre-deployment/pre-deployment-check.sh
``` ```
This validates kubectl connectivity, StorageClass configuration, and GPU availability. See [pre-deployment checks](https://github.com/ai-dynamo/dynamo/tree/main/deploy/pre-deployment/README) for more details. This validates kubectl connectivity, StorageClass configuration, and GPU availability. See [pre-deployment checks](https://github.com/ai-dynamo/dynamo/tree/main/deploy/pre-deployment/README.md) for more details.
## 1. Install Platform First ## 1. Install Platform First
...@@ -79,9 +79,9 @@ Each backend has deployment examples and configuration options: ...@@ -79,9 +79,9 @@ Each backend has deployment examples and configuration options:
| Backend | Aggregated | Aggregated + Router | Disaggregated | Disaggregated + Router | Disaggregated + Planner | Disaggregated Multi-node | | Backend | Aggregated | Aggregated + Router | Disaggregated | Disaggregated + Router | Disaggregated + Planner | Disaggregated Multi-node |
|--------------|:----------:|:-------------------:|:-------------:|:----------------------:|:-----------------------:|:------------------------:| |--------------|:----------:|:-------------------:|:-------------:|:----------------------:|:-----------------------:|:------------------------:|
| **[SGLang](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/sglang/deploy/README)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **[SGLang](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/sglang/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **[TensorRT-LLM](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/trtllm/deploy/README)** | ✅ | ✅ | ✅ | ✅ | 🚧 | ✅ | | **[TensorRT-LLM](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/trtllm/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | 🚧 | ✅ |
| **[vLLM](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/vllm/deploy/README)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **[vLLM](https://github.com/ai-dynamo/dynamo/tree/main/examples/backends/vllm/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
## 3. Deploy Your First Model ## 3. Deploy Your First Model
...@@ -232,7 +232,7 @@ Key customization points include: ...@@ -232,7 +232,7 @@ Key customization points include:
- **[Managing Models with DynamoModel](deployment/dynamomodel-guide.md)** - Deploy LoRA adapters and manage models - **[Managing Models with DynamoModel](deployment/dynamomodel-guide.md)** - Deploy LoRA adapters and manage models
- **[Operator Documentation](dynamo-operator.md)** - How the platform works - **[Operator Documentation](dynamo-operator.md)** - How the platform works
- **[Service Discovery](service-discovery.md)** - Discovery backends and configuration - **[Service Discovery](service-discovery.md)** - Discovery backends and configuration
- **[Helm Charts](https://github.com/ai-dynamo/dynamo/tree/main/deploy/helm/README)** - For advanced users - **[Helm Charts](https://github.com/ai-dynamo/dynamo/tree/main/deploy/helm/README.md)** - For advanced users
- **[Checkpointing](chrek/README.md)** - Fast pod startup with checkpoint/restore - **[Checkpointing](chrek/README.md)** - Fast pod startup with checkpoint/restore
- **[GitOps Deployment with FluxCD](fluxcd.md)** - For advanced users - **[GitOps Deployment with FluxCD](fluxcd.md)** - For advanced users
- **[Logging](observability/logging.md)** - For logging setup - **[Logging](observability/logging.md)** - For logging setup
......
...@@ -679,9 +679,9 @@ securityContext: ...@@ -679,9 +679,9 @@ securityContext:
## Additional Resources ## Additional Resources
- [ChReK Helm Chart Values](https://github.com/ai-dynamo/dynamo/tree/main/deploy/helm/charts/chrek/values.yaml) - [ChReK Helm Chart Values](https://github.com/ai-dynamo/dynamo/tree/main/deploy/helm/charts/chrek/values.yaml)
- [Smart Entrypoint Script](https://github.com/ai-dynamo/dynamo/tree/main/deploy/chrek/scripts/smart-entrypoint.sh) - [ChReK Dockerfile](https://github.com/ai-dynamo/dynamo/tree/main/deploy/chrek/Dockerfile)
- [CRIU Documentation](https://criu.org/Main_Page) - [CRIU Documentation](https://criu.org/Main_Page)
- [CUDA Checkpoint Plugin](https://docs.nvidia.com/cuda/cuda-checkpoint-plugin/) - [CUDA Checkpoint Utility](https://github.com/NVIDIA/cuda-checkpoint)
--- ---
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment