Adding sanity check to openapi docs.

2024-07-09 11:13:48 +02:00 · 2024-07-09 11:13:48 +02:00 · fe710af25f
parent 5e2a305880
commit fe710af25f
6 changed files with 91 additions and 31 deletions
--- a/.github/workflows/autodocs.yaml
+++ b/.github/workflows/autodocs.yaml
@ -30,6 +30,10 @@ jobs:
      id: install-router
      run: cargo install --path router/

+    - uses: actions/setup-node@v4
+      with:
+        node-version: 22
+
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
@ -37,4 +41,5 @@ jobs:

    - name: Check that documentation is up-to-date
      run: |
+        npm install -g swagger-ui
        python update_doc.py --check
--- a/Cargo.lock
+++ b/Cargo.lock
@ -3740,7 +3740,7 @@ dependencies = [

 [[package]]
 name = "text-generation-benchmark"
-version = "2.1.1-dev0"
+version = "2.1.2-dev0"
 dependencies = [
 "average",
 "clap",
@ -3761,7 +3761,7 @@ dependencies = [

 [[package]]
 name = "text-generation-client"
-version = "2.1.1-dev0"
+version = "2.1.2-dev0"
 dependencies = [
 "async-trait",
 "base64 0.22.1",
@ -3779,7 +3779,7 @@ dependencies = [

 [[package]]
 name = "text-generation-launcher"
-version = "2.1.1-dev0"
+version = "2.1.2-dev0"
 dependencies = [
 "clap",
 "ctrlc",
@ -3798,7 +3798,7 @@ dependencies = [

 [[package]]
 name = "text-generation-router"
-version = "2.1.1-dev0"
+version = "2.1.2-dev0"
 dependencies = [
 "async-stream",
 "axum 0.7.5",
--- a/docs/openapi.json
+++ b/docs/openapi.json
@ -809,7 +809,6 @@
      "ChatRequest": {
        "type": "object",
        "required": [
-          "model",
          "messages"
        ],
        "properties": {
@ -854,7 +853,8 @@
          "model": {
            "type": "string",
            "description": "[UNUSED] ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.",
-            "example": "mistralai/Mistral-7B-Instruct-v0.2"
+            "example": "mistralai/Mistral-7B-Instruct-v0.2",
+            "nullable": true
          },
          "n": {
            "type": "integer",
@ -1116,7 +1116,6 @@
      "CompletionRequest": {
        "type": "object",
        "required": [
-          "model",
          "prompt"
        ],
        "properties": {
@ -1138,7 +1137,8 @@
          "model": {
            "type": "string",
            "description": "UNUSED\nID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.",
-            "example": "mistralai/Mistral-7B-Instruct-v0.2"
+            "example": "mistralai/Mistral-7B-Instruct-v0.2",
+            "nullable": true
          },
          "prompt": {
            "$ref": "#/components/schemas/Prompt"
@ -1708,6 +1708,62 @@
          }
        }
      },
+      "MessageChunk": {
+        "oneOf": [
+          {
+            "type": "object",
+            "required": [
+              "text",
+              "type"
+            ],
+            "properties": {
+              "text": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "text"
+                ]
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "image_url",
+              "type"
+            ],
+            "properties": {
+              "image_url": {
+                "$ref": "#/components/schemas/Url"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "image_url"
+                ]
+              }
+            }
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type"
+        }
+      },
+      "MessageContent": {
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/MessageChunk"
+            }
+          }
+        ]
+      },
      "PrefillToken": {
        "type": "object",
        "required": [
--- a/docs/source/basic_tutorials/launcher.md
+++ b/docs/source/basic_tutorials/launcher.md
@ -62,9 +62,7 @@ Options:
          Possible values:
          - awq:              4 bit quantization. Requires a specific AWQ quantized model: <https://hf.co/models?search=awq>. Should replace GPTQ models wherever possible because of the better latency
          - eetq:             8 bit quantization, doesn't require specific model. Should be a drop-in replacement to bitsandbytes with much better performance. Kernels are from <https://github.com/NetEase-FuXi/EETQ.git>
-          - exl2:             Variable bit quantization. Requires a specific EXL2 quantized model: <https://hf.co/models?search=exl2>. Requires exllama2 kernels and does not support tensor parallelism (num_shard > 1)
          - gptq:             4 bit quantization. Requires a specific GTPQ quantized model: <https://hf.co/models?search=gptq>. text-generation-inference will use exllama (faster) kernels wherever possible, and use triton kernel (wider support) when it's not. AWQ has faster kernels
-          - marlin:           4 bit quantization. Requires a specific Marlin quantized model: <https://hf.co/models?search=marlin>
          - bitsandbytes:     Bitsandbytes 8bit. Can be applied on any model, will cut the memory requirement in half, but it is known that the model will be much slower to run than the native f16
          - bitsandbytes-nf4: Bitsandbytes 4bit. Can be applied on any model, will cut the memory requirement by 4x, but it is known that the model will be much slower to run than the native f16
          - bitsandbytes-fp4: Bitsandbytes 4bit. nf4 should be preferred in most cases but maybe this one has better perplexity performance for you model
@ -126,7 +124,7 @@ Options:
 ## MAX_TOP_N_TOKENS
 ```shell
      --max-top-n-tokens <MAX_TOP_N_TOKENS>
-          This is the maximum allowed value for clients to set `top_n_tokens`. `top_n_tokens` is used to return information about the the `n` most likely tokens at each generation step, instead of just the sampled token. This information can be used for downstream tasks like for classification or ranking
+          This is the maximum allowed value for clients to set `top_n_tokens`. `top_n_tokens is used to return information about the the `n` most likely tokens at each generation step, instead of just the sampled token. This information can be used for downstream tasks like for classification or ranking
          
          [env: MAX_TOP_N_TOKENS=]
          [default: 5]
@ -336,13 +334,6 @@ Options:
      --otlp-endpoint <OTLP_ENDPOINT>
          [env: OTLP_ENDPOINT=]

-```
-## OTLP_SERVICE_NAME
-```shell
-      --otlp-service-name <OTLP_SERVICE_NAME>
-          [env: OTLP_SERVICE_NAME=]
-          [default: text-generation-inference.router]
-
 ```
 ## CORS_ALLOW_ORIGIN
 ```shell
@ -416,14 +407,6 @@ Options:
          [env: MAX_CLIENT_BATCH_SIZE=]
          [default: 4]

-```
-## LORA_ADAPTERS
-```shell
-      --lora-adapters <LORA_ADAPTERS>
-          Lora Adapters a list of adapter ids i.e. `repo/adapter1,repo/adapter2` to load during startup that will be available to callers via the `adapter_id` field in a request
-          
-          [env: LORA_ADAPTERS=]
-
 ```
 ## HELP
 ```shell
--- a/router/src/server.rs
+++ b/router/src/server.rs
@ -13,8 +13,8 @@ use crate::validation::ValidationError;
 use crate::{
    BestOfSequence, Details, ErrorResponse, FinishReason, GenerateParameters, GenerateRequest,
    GenerateResponse, GrammarType, HubModelInfo, HubProcessorConfig, HubTokenizerConfig, Info,
-    Message, PrefillToken, SimpleToken, StreamDetails, StreamResponse, Token, TokenizeResponse,
-    Usage, Validation,
+    Message, MessageChunk, MessageContent, PrefillToken, SimpleToken, StreamDetails,
+    StreamResponse, Token, TokenizeResponse, Usage, Validation,
 };
 use crate::{
    ChatCompletion, ChatCompletionChoice, ChatCompletionChunk, ChatCompletionComplete,
@ -1446,6 +1446,8 @@ pub async fn run(
    GrammarType,
    ChatRequest,
    Message,
+    MessageContent,
+    MessageChunk,
    ChatCompletionComplete,
    ChatCompletionChoice,
    ChatCompletionDelta,
--- a/update_doc.py
+++ b/update_doc.py
@ -155,7 +155,7 @@ def check_openapi(check: bool):
                filename,
            ],
            capture_output=True,
-        ).stdout.decode()
+        ).stdout.decode("utf-8")
        os.remove(tmp_filename)

        if diff:
@ -164,11 +164,25 @@ def check_openapi(check: bool):
                "OpenAPI documentation is not up-to-date, run `python update_doc.py` in order to update it"
            )

-        return True
    else:
        os.rename(tmp_filename, filename)
        print("OpenAPI documentation updated.")
-        return True
+    errors = subprocess.run(
+        [
+            "swagger-cli",
+            # allow for trailing whitespace since it's not significant
+            # and the precommit hook will remove it
+            "validate",
+            filename,
+        ],
+        capture_output=True,
+    ).stderr.decode("utf-8")
+    if errors:
+        print(errors)
+        raise Exception(
+            f"OpenAPI documentation is invalid, `swagger-cli validate` showed some error:\n {errors}"
+        )
+    return True


 def main():