Fix swagger UI example (#432)

Signed-off-by: Sivanantham Chinnaiyan <[email protected]>
kserve · Dec 22, 2024 · 3f9bdb9 · 3f9bdb9
1 parent 3c2e5da
commit 3f9bdb9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/get_started/swagger_ui.md b/docs/get_started/swagger_ui.md
@@ -29,13 +29,17 @@ spec:
       args: ["--enable_docs_url=True"]
       modelFormat:
         name: sklearn
+      runtime: kserve-sklearnserver
       storageUri: "gs://kfserving-examples/models/sklearn/1.0/model"
 EOF
 ```
 
 After the InferenceService becomes ready the Swagger UI will be served at **`/docs`**. 
 In our example above, the Swagger UI will be available at `http://sklearn-iris.kserve-test.example.com/docs`.
 
+!!! note
+    The Swagger UI may not be exposed or exposed with a different endpoint on other serving runtimes. For example, the MLServer runtime exposes the Swagger UI at `/v2/docs` endpoint. This example is only applicable to the KServe provided runtimes and runtimes that extend the KServe runtime SDK.
+
 ## Interact with InferenceService
 
 Click one of the V2 endpoints like `/v2`, it will expand and display the description and response from this API endpoint: