From 21c3009945e9d3e2b4b56d93fc9c120ee73ccdaa Mon Sep 17 00:00:00 2001
From: josc146 <josStorer@outlook.com>
Date: Thu, 15 Jun 2023 21:52:22 +0800
Subject: [PATCH] improve api docs

---
 backend-python/routes/completion.py        | 30 ++++++++++++++++++++++
 backend-python/routes/config.py            | 13 +++++++++-
 backend-python/utils/rwkv.py               | 11 ++++++++
 deploy-examples/ChatGPT-Next-Web/setup.bat |  4 +--
 4 files changed, 55 insertions(+), 3 deletions(-)

diff --git a/backend-python/routes/completion.py b/backend-python/routes/completion.py
index a7c61c5..16f86ca 100644
--- a/backend-python/routes/completion.py
+++ b/backend-python/routes/completion.py
@@ -24,6 +24,21 @@ class ChatCompletionBody(ModelConfigBody):
     stream: bool = False
     stop: str = None
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "messages": [{"role": "user", "content": "hello"}],
+                "model": "rwkv",
+                "stream": False,
+                "stop": None,
+                "max_tokens": 1000,
+                "temperature": 1.2,
+                "top_p": 0.5,
+                "presence_penalty": 0.4,
+                "frequency_penalty": 0.4,
+            }
+        }
+
 
 completion_lock = Lock()
 
@@ -242,6 +257,21 @@ class CompletionBody(ModelConfigBody):
     stream: bool = False
     stop: str = None
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "prompt": "The following is an epic science fiction masterpiece that is immortalized, with delicate descriptions and grand depictions of interstellar civilization wars.\nChapter 1.\n",
+                "model": "rwkv",
+                "stream": False,
+                "stop": None,
+                "max_tokens": 100,
+                "temperature": 1.2,
+                "top_p": 0.5,
+                "presence_penalty": 0.4,
+                "frequency_penalty": 0.4,
+            }
+        }
+
 
 @router.post("/v1/completions")
 @router.post("/completions")
diff --git a/backend-python/routes/config.py b/backend-python/routes/config.py
index 4d3bb4b..907da44 100644
--- a/backend-python/routes/config.py
+++ b/backend-python/routes/config.py
@@ -29,6 +29,15 @@ class SwitchModelBody(BaseModel):
     strategy: str
     customCuda: bool = False
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "model": "models/RWKV-4-World-3B-v1-OnlyForTest_80%_trained-20230612-ctx4096.pth",
+                "strategy": "cuda fp16",
+                "customCuda": False,
+            }
+        }
+
 
 @router.post("/switch-model")
 def switch_model(body: SwitchModelBody, response: Response, request: Request):
@@ -59,7 +68,9 @@ def switch_model(body: SwitchModelBody, response: Response, request: Request):
         print(e)
         quick_log(request, body, f"Exception: {e}")
         global_var.set(global_var.Model_Status, global_var.ModelStatus.Offline)
-        raise HTTPException(Status.HTTP_500_INTERNAL_SERVER_ERROR, "failed to load")
+        raise HTTPException(
+            Status.HTTP_500_INTERNAL_SERVER_ERROR, f"failed to load: {e}"
+        )
 
     if global_var.get(global_var.Model_Config) is None:
         global_var.set(
diff --git a/backend-python/utils/rwkv.py b/backend-python/utils/rwkv.py
index f1ebcc2..f1d0589 100644
--- a/backend-python/utils/rwkv.py
+++ b/backend-python/utils/rwkv.py
@@ -201,6 +201,17 @@ class ModelConfigBody(BaseModel):
     presence_penalty: float = Field(default=None, ge=-2, le=2)
     frequency_penalty: float = Field(default=None, ge=-2, le=2)
 
+    class Config:
+        schema_extra = {
+            "example": {
+                "max_tokens": 1000,
+                "temperature": 1.2,
+                "top_p": 0.5,
+                "presence_penalty": 0.4,
+                "frequency_penalty": 0.4,
+            }
+        }
+
 
 def set_rwkv_config(model: RWKV, body: ModelConfigBody):
     if body.max_tokens is not None:
diff --git a/deploy-examples/ChatGPT-Next-Web/setup.bat b/deploy-examples/ChatGPT-Next-Web/setup.bat
index 7f3b3be..08e13f2 100644
--- a/deploy-examples/ChatGPT-Next-Web/setup.bat
+++ b/deploy-examples/ChatGPT-Next-Web/setup.bat
@@ -11,8 +11,8 @@ start python ./RWKV-Runner/backend-python/main.py
 
 powershell -Command "(Test-Path ./RWKV-Runner/models) -or (mkdir RWKV-Runner/models)"
 powershell -Command "Import-Module BitsTransfer"
-powershell -Command "(Test-Path ./RWKV-Runner/models/RWKV-4-World-1.5B-v1-20230607-ctx4096.pth) -or (Start-BitsTransfer https://huggingface.co/BlinkDL/rwkv-4-world/resolve/main/RWKV-4-World-1.5B-v1-20230607-ctx4096.pth ./RWKV-Runner/models/RWKV-4-World-1.5B-v1-20230607-ctx4096.pth)"
-powershell -Command "Invoke-WebRequest http://127.0.0.1:8000/switch-model -Method POST -ContentType 'application/json' -Body '{\"model\":\"./RWKV-Runner/models/RWKV-4-World-1.5B-v1-20230607-ctx4096.pth\",\"strategy\":\"cuda fp32 *20+\"}'"
+powershell -Command "(Test-Path ./RWKV-Runner/models/RWKV-4-World-1.5B-v1-fixed-20230612-ctx4096.pth) -or (Start-BitsTransfer https://huggingface.co/BlinkDL/rwkv-4-world/resolve/main/RWKV-4-World-1.5B-v1-fixed-20230612-ctx4096.pth ./RWKV-Runner/models/RWKV-4-World-1.5B-v1-fixed-20230612-ctx4096.pth)"
+powershell -Command "Invoke-WebRequest http://127.0.0.1:8000/switch-model -Method POST -ContentType 'application/json' -Body '{\"model\":\"./RWKV-Runner/models/RWKV-4-World-1.5B-v1-fixed-20230612-ctx4096.pth\",\"strategy\":\"cuda fp32 *20+\"}'"
 
 git clone https://github.com/Yidadaa/ChatGPT-Next-Web --depth=1
 cd ChatGPT-Next-Web