Skip to content

Commit 6d8f10c

Browse files
authored
docs: Update README links to point to the GitHub repository for metrics and SLOs documentation (#168)
Update the README links to point to the GitHub repository for metrics and SLOs documentation instead of the raw markdown files in the repository. Signed-off-by: Ernest Wong <chwong719@gmail.com>
1 parent 2dc3d62 commit 6d8f10c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ After the evaluation is completed, GuideLLM will summarize the results into thre
9292

9393
The sections will look similar to the following: <img alt="Sample GuideLLM benchmark output" src="https://raw.githubusercontent.com/neuralmagic/guidellm/main/docs/assets/sample-output.png" />
9494

95-
For more details about the metrics and definitions, please refer to the [Metrics documentation](https://raw.githubusercontent.com/neuralmagic/guidellm/main/docs/metrics.md).
95+
For more details about the metrics and definitions, please refer to the [Metrics documentation](https://github.com/neuralmagic/guidellm/blob/main/docs/metrics.md).
9696

9797
#### 4. Explore the Results File
9898

@@ -106,7 +106,7 @@ The results from GuideLLM are used to optimize your LLM deployment for performan
106106

107107
For example, when deploying a chat application, we likely want to ensure that our time to first token (TTFT) and inter-token latency (ITL) are under certain thresholds to meet our service level objectives (SLOs) or service level agreements (SLAs). For example, setting TTFT to 200ms and ITL 25ms for the sample data provided in the example above, we can see that even though the server is capable of handling up to 13 requests per second, we would only be able to meet our SLOs for 99% of users at a request rate of 3.5 requests per second. If we relax our constraints on ITL to 50 ms, then we can meet the TTFT SLA for 99% of users at a request rate of approximately 10 requests per second.
108108

109-
For further details on determining the optimal request rate and SLOs, refer to the [SLOs documentation](https://raw.githubusercontent.com/neuralmagic/guidellm/main/docs/service_level_objectives.md).
109+
For further details on determining the optimal request rate and SLOs, refer to the [SLOs documentation](https://github.com/neuralmagic/guidellm/blob/main/docs/service_level_objectives.md).
110110

111111
### Configurations
112112

0 commit comments

Comments
 (0)