Unverified Commit 241bd014 authored by hhzhang16's avatar hhzhang16 Committed by GitHub
Browse files

docs: update how deploy util helper files are mentioned (#2957)


Signed-off-by: default avatarHannah Zhang <hannahz@nvidia.com>
Signed-off-by: default avatarhhzhang16 <54051230+hhzhang16@users.noreply.github.com>
Co-authored-by: default avatarcoderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
parent 8c665c1b
...@@ -102,7 +102,7 @@ Use the injector utility to place your DGD manifest into the PVC. The profiling ...@@ -102,7 +102,7 @@ Use the injector utility to place your DGD manifest into the PVC. The profiling
```bash ```bash
# Inject your disagg manifest # Inject your disagg manifest
python3 deploy/utils/inject_manifest.py \ python3 -m deploy.utils.inject_manifest \
--namespace $NAMESPACE \ --namespace $NAMESPACE \
--src components/backends/vllm/deploy/disagg.yaml \ --src components/backends/vllm/deploy/disagg.yaml \
--dest /data/configs/disagg.yaml --dest /data/configs/disagg.yaml
...@@ -127,13 +127,13 @@ Use the default pre-built image and inject custom configurations via PVC: ...@@ -127,13 +127,13 @@ Use the default pre-built image and inject custom configurations via PVC:
2. **Inject your custom disagg configuration:** 2. **Inject your custom disagg configuration:**
```bash ```bash
# Use default disagg.yaml config # Use default disagg.yaml config
python3 deploy/utils/inject_manifest.py --namespace $NAMESPACE --src components/backends/vllm/deploy/disagg.yaml --dest /data/configs/disagg.yaml python3 -m deploy.utils.inject_manifest --namespace $NAMESPACE --src components/backends/vllm/deploy/disagg.yaml --dest /data/configs/disagg.yaml
# Or use a custom disagg config file # Or use a custom disagg config file
python3 deploy/utils/inject_manifest.py --namespace $NAMESPACE --src my-custom-disagg.yaml --dest /data/configs/disagg.yaml python3 -m deploy.utils.inject_manifest --namespace $NAMESPACE --src my-custom-disagg.yaml --dest /data/configs/disagg.yaml
# Or specify a custom target path in the PVC # Or specify a custom target path in the PVC
python3 deploy/utils/inject_manifest.py --namespace $NAMESPACE --src my-custom-disagg.yaml --dest /data/profiling_results/my-disagg.yaml python3 -m deploy.utils.inject_manifest --namespace $NAMESPACE --src my-custom-disagg.yaml --dest /data/profiling_results/my-disagg.yaml
``` ```
> **Note**: All paths must start with `/data/` for security reasons. If you forget this prefix, the script will show a helpful error message with the correct path. > **Note**: All paths must start with `/data/` for security reasons. If you forget this prefix, the script will show a helpful error message with the correct path.
...@@ -193,10 +193,10 @@ To download the results: ...@@ -193,10 +193,10 @@ To download the results:
```bash ```bash
# Download to directory # Download to directory
python3 deploy/utils/download_pvc_results.py --namespace $NAMESPACE --output-dir ./results --folder /data/profiling_results python3 -m deploy.utils.download_pvc_results --namespace $NAMESPACE --output-dir ./results --folder /data/profiling_results
# Download without any of the auto-created config.yaml files used in profiling # Download without any of the auto-created config.yaml files used in profiling
python3 deploy/utils/download_pvc_results.py --namespace $NAMESPACE --output-dir ./results --folder /data/profiling_results --no-config python3 -m deploy.utils.download_pvc_results --namespace $NAMESPACE --output-dir ./results --folder /data/profiling_results --no-config
``` ```
The script will: The script will:
......
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