Skip to content

Commit ca6e589

Browse files
authored
Fix typos and add caveats (#27)
--------- Signed-off-by: rickyyx <[email protected]>
1 parent 02b0613 commit ca6e589

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ Where the lines are randomly sampled from a collection of lines from Shakespeare
2929

3030
To run the most basic load test you can the token_benchmark_ray script.
3131

32+
33+
### Caveats and Disclaimers
34+
35+
- The endpoints provider backend might vary widely, so this is not a reflection on how the software runs on a particular hardware.
36+
- The results may vary with time of day.
37+
- The results may vary with the load.
38+
- The results may not correlate with users’ workloads.
39+
3240
### OpenAI Compatible APIs
3341
```bash
3442
export OPENAI_API_KEY=secret_abcdefg
@@ -88,7 +96,7 @@ python token_benchmark_ray.py \
8896

8997
```
9098

91-
### HuggingFace API
99+
### Hugging Face
92100

93101
```bash
94102
export HUGGINGFACE_API_KEY="YOUR_HUGGINGFACE_API_KEY"
@@ -164,9 +172,9 @@ python token_benchmark_ray.py \
164172

165173
```
166174

167-
# Sagemaker
175+
### SageMaker
168176

169-
Sagemaker doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.
177+
SageMaker doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.
170178

171179
```bash
172180

@@ -244,7 +252,7 @@ python llm_correctness.py \
244252

245253
```
246254

247-
### HuggingFacAPI
255+
### Hugging Face
248256

249257
```bash
250258
export HUGGINGFACE_API_KEY="YOUR_HUGGINGFACE_API_KEY"
@@ -309,9 +317,9 @@ python llm_correctness.py \
309317

310318
```
311319

312-
### Sagemaker
320+
### SageMaker
313321

314-
Sagemaker doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.
322+
SageMaker doesn't return the total number of tokens that are generated by their endpoint, so tokens are counted using the LLama tokenizer.
315323

316324
```bash
317325

0 commit comments

Comments
 (0)