Skip to content

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

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.

Sign up for GitHub

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
hhzhang16 merged 4 commits into from
Sep 9, 2025
Merged

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

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1028c29
docs: update how deploy util helper files are mentioned
hhzhang16 Sep 9, 2025
d4f59bc
Update docs/benchmarks/pre_deployment_profiling.md
hhzhang16 Sep 9, 2025
d143edc
Update docs/benchmarks/pre_deployment_profiling.md
hhzhang16 Sep 9, 2025
e2d2040
Merge branch 'main' into 0.5.0-rc5-updates
hhzhang16 Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: update how deploy util helper files are mentioned 
Signed-off-by: Hannah Zhang <[email protected]>
  • Loading branch information
@hhzhang16
hhzhang16 committed Sep 9, 2025
commit 1028c29820fd182161450cb9a4ef7c85e588769d
12 changes: 6 additions & 6 deletions docs/benchmarks/pre_deployment_profiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Use the injector utility to place your DGD manifest into the PVC. The profiling

```bash
# Inject your disagg manifest
python3 deploy/utils/inject_manifest.py \
python3 -m deploy.utils.inject_manifest \
--namespace $NAMESPACE \
--src components/backends/vllm/deploy/disagg.yaml \
--dest /data/configs/disagg.yaml
Expand All @@ -127,13 +127,13 @@ Use the default pre-built image and inject custom configurations via PVC:
2. **Inject your custom disagg configuration:**
```bash
# 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
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
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.
Expand Down Expand Up @@ -193,10 +193,10 @@ To download the results:

```bash
# Download to directory
python3 deploy/utils/download_pvc_results.py --namespace $NAMESPACE --output-dir ./results --folder /data/profiling_results
python3 -m deploy.utils.inject_manifest.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
python3 deploy/utils/download_pvc_results.py --namespace $NAMESPACE --output-dir ./results --folder /data/profiling_results --no-config
python3 -m deploy.utils.inject_manifest.download_pvc_results --namespace $NAMESPACE --output-dir ./results --folder /data/profiling_results --no-config
```

The script will:
Expand Down
Loading