Add authentication instructions to GenAI-Perf tutorial (#170)

triton-inference-server · Nov 8, 2024 · 0304415 · 0304415
1 parent 5dfebe1
commit 0304415
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/genai-perf/README.md b/genai-perf/README.md
@@ -309,6 +309,26 @@ inference. Other modes such as the [embeddings](docs/embeddings.md) and
 
 </br>
 
+<!--
+======================
+AUTHENTICATION
+======================
+-->
+
+## Authentication
+
+GenAI-Perf can benchmark secure endpoints such as OpenAI, which require API
+key authentication. To do so, you must add your API key directly in the command.
+At the end of your command, append the below flags. Replace the key with your
+API key. The `--` flag allows arguments to pass directly into Perf Analyzer in
+superuser mode. The `-H` flag is used to add HTTP headers.
+
+```bash
+-- -H "Authorization: Bearer ${API_KEY}" -H "Accept: text/event-stream"
+```
+
+</br>
+
 <!--
 ======================
 METRICS

diff --git a/templates/genai-perf-templates/README_template b/templates/genai-perf-templates/README_template
@@ -309,6 +309,26 @@ inference. Other modes such as the [embeddings](docs/embeddings.md) and
 
 </br>
 
+<!--
+======================
+AUTHENTICATION
+======================
+-->
+
+## Authentication
+
+GenAI-Perf can benchmark secure endpoints such as OpenAI, which require API
+key authentication. To do so, you must add your API key directly in the command.
+At the end of your command, append the below flags. Replace the key with your
+API key. The `--` flag allows arguments to pass directly into Perf Analyzer in
+superuser mode. The `-H` flag is used to add HTTP headers.
+
+```bash
+-- -H "Authorization: Bearer ${API_KEY}" -H "Accept: text/event-stream"
+```
+
+</br>
+
 <!--
 ======================
 METRICS