Skip to content

Commit 9ac0785

Browse files
hhzhang16tedzhouhk
andauthored
docs: Restructure profiling documentation around DGDR workflow (#3867)
Signed-off-by: Hannah Zhang <[email protected]> Signed-off-by: Hongkuan Zhou <[email protected]> Signed-off-by: hongkuanz <[email protected]> Co-authored-by: Hongkuan Zhou <[email protected]> Co-authored-by: hongkuanz <[email protected]>
1 parent ea9c1ea commit 9ac0785

File tree

13 files changed

+865
-488
lines changed

13 files changed

+865
-488
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Rerun with `curl -N` and change `stream` in the request to `true` to get the res
179179
Dynamo provides comprehensive benchmarking tools to evaluate and optimize your deployments:
180180

181181
- **[Benchmarking Guide](docs/benchmarks/benchmarking.md)** – Compare deployment topologies (aggregated vs. disaggregated vs. vanilla vLLM) using AIPerf
182-
- **[Pre-Deployment Profiling](docs/benchmarks/pre_deployment_profiling.md)** – Optimize configurations before deployment to meet SLA requirements
182+
- **[SLA-Driven Dynamo Deployments](docs/planner/sla_planner_quickstart.md)** – Optimize your deployment to meet SLA requirements
183183

184184
# Engines
185185

components/backends/trtllm/deploy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Advanced disaggregated deployment with SLA-based automatic scaling.
5353
- `TRTLLMPrefillWorker`: Specialized prefill-only worker
5454

5555
> [!NOTE]
56-
> This deployment requires pre-deployment profiling to be completed first. See [Pre-Deployment Profiling](../../../../docs/benchmarks/pre_deployment_profiling.md) for detailed instructions.
56+
> This deployment requires pre-deployment profiling to be completed first. See [Pre-Deployment Profiling](../../../../docs/benchmarks/sla_driven_profiling.md) for detailed instructions.
5757
5858
## CRD Structure
5959

components/backends/vllm/deploy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ We have public images available on [NGC Catalog](https://catalog.ngc.nvidia.com/
9999

100100
### Pre-Deployment Profiling (SLA Planner Only)
101101

102-
If using the SLA Planner deployment (`disagg_planner.yaml`), follow the [pre-deployment profiling guide](../../../../docs/benchmarks/pre_deployment_profiling.md) to run pre-deployment profiling. The results will be saved to the `dynamo-pvc` PVC and queried by the SLA Planner.
102+
If using the SLA Planner deployment (`disagg_planner.yaml`), follow the [pre-deployment profiling guide](../../../../docs/benchmarks/sla_driven_profiling.md) to run pre-deployment profiling. The results will be saved to the `dynamo-pvc` PVC and queried by the SLA Planner.
103103

104104
## Usage
105105

components/src/dynamo/planner/utils/perf_interpolation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
MISSING_PROFILING_DATA_ERROR_MESSAGE = (
3030
"SLA-Planner requires pre-deployment profiling results to run.\n"
31-
"Please follow /docs/benchmarks/pre_deployment_profiling.md to run the profiling first,\n"
31+
"Please follow /docs/benchmarks/sla_driven_profiling.md to run the profiling first,\n"
3232
"and make sure the profiling results are present in --profile-results-dir."
3333
)
3434

deploy/utils/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ python3 -m deploy.utils.download_pvc_results \
119119

120120
For complete benchmarking and profiling workflows:
121121
- **Benchmarking Guide**: See [docs/benchmarks/benchmarking.md](../../docs/benchmarks/benchmarking.md) for comparing DynamoGraphDeployments and external endpoints
122-
- **Pre-Deployment Profiling**: See [docs/benchmarks/pre_deployment_profiling.md](../../docs/benchmarks/pre_deployment_profiling.md) for optimizing configurations before deployment
122+
- **Pre-Deployment Profiling**: See [docs/benchmarks/sla_driven_profiling.md](../../docs/benchmarks/sla_driven_profiling.md) for optimizing configurations before deployment
123123

124124
## Notes
125125

docs/benchmarks/pre_deployment_profiling.md

Lines changed: 0 additions & 307 deletions
This file was deleted.

docs/benchmarks/sla_driven_profiling.md

Lines changed: 516 additions & 0 deletions
Large diffs are not rendered by default.

docs/images/pd_interpolation.png

1.45 MB
Loading

docs/planner/load_planner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ There are two additional rules set by planner to prevent over-compensation:
2424

2525
## SLA-based Scaling Up/Down Prefill/Decode Workers
2626

27-
See [Pre-Deployment Profiling](../benchmarks/pre_deployment_profiling.md) for more details.
27+
See [SLA-Driven Profiling](../benchmarks/sla_driven_profiling.md) for more details.
2828

2929
## Usage
3030

docs/planner/planner_intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,5 @@ Key features include:
7878

7979
Overview <self>
8080
SLA Planner Quick Start <sla_planner_quickstart>
81-
Pre-Deployment Profiling <../benchmarks/pre_deployment_profiling.md>
81+
SLA-Driven Profiling <../benchmarks/sla_driven_profiling.md>
8282
SLA-based Planner <sla_planner.md>

0 commit comments

Comments
 (0)