API: Add clarification and cleanup autodocs

It's possible to override parts of the example JSON to give proper
examples of values.

Signed-off-by: kingbri <bdashore3@proton.me>

OAI/types/common.py

@@ -74,7 +74,7 @@ class CommonCompletionRequest(BaseModel):
     mirostat_eta: Optional[float] = 0.1
     add_bos_token: Optional[bool] = True
     ban_eos_token: Optional[bool] = False
-    logit_bias: Optional[Dict[int, float]] = None
+    logit_bias: Optional[Dict[int, float]] = Field(default=None, examples=[[{"1": 10}]])
 
     # Aliased variables
     penalty_range: Optional[int] = Field(

OAI/types/model.py

@@ -68,9 +68,15 @@ class ModelLoadRequest(BaseModel):
     )
     gpu_split_auto: Optional[bool] = True
     gpu_split: Optional[List[float]] = Field(default_factory=list)
-    rope_scale: Optional[float] = 1.0
+    rope_scale: Optional[float] = Field(
+        description="Automatically pulled from the model's config if not present",
+        default=None,
+        examples=[1.0],
+    )
     rope_alpha: Optional[float] = Field(
-        description="Automatically calculated if not present", default=None
+        description="Automatically calculated if not present",
+        default=None,
+        examples=[1.0],
     )
     no_flash_attention: Optional[bool] = False
     # low_mem: Optional[bool] = False

main.py

@@ -51,7 +51,14 @@ from logger import init_logger
 
 logger = init_logger(__name__)
 
-app = FastAPI()
+app = FastAPI(
+    title="TabbyAPI",
+    summary="An OAI compatible exllamav2 API that's both lightweight and fast",
+    description=(
+        "This docs page is not meant to send requests! Please use a service "
+        "like Postman or a frontend UI."
+    ),
+)
 
 # Globally scoped variables. Undefined until initalized in main
 MODEL_CONTAINER: Optional[ModelContainer] = None