Enablement of REST API Usage within Google Colab Free Tier (lm-sys#2940)

rkinas · Jan 24, 2024 · 7ef41f3 · 7ef41f3
1 parent 3eea41e
commit 7ef41f3
Show file tree

Hide file tree

Showing 3 changed files with 350 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -258,6 +258,7 @@ export FASTCHAT_USE_MODELSCOPE=True
 ### OpenAI-Compatible RESTful APIs & SDK
 FastChat provides OpenAI-compatible APIs for its supported models, so you can use FastChat as a local drop-in replacement for OpenAI APIs.
 The FastChat server is compatible with both [openai-python](https://github.com/openai/openai-python) library and cURL commands.
+The REST API is capable of being executed from Google Colab free tier, as demonstrated in the [FastChat_API_GoogleColab.ipynb](https://github.com/lm-sys/FastChat/blob/main/playground/FastChat_API_GoogleColab.ipynb) notebook, available in our repository.
 See [docs/openai_api.md](docs/openai_api.md).
 
 ### Hugging Face Generation APIs

diff --git a/docs/openai_api.md b/docs/openai_api.md
@@ -8,6 +8,8 @@ The following OpenAI APIs are supported:
 - Completions. (Reference: https://platform.openai.com/docs/api-reference/completions)
 - Embeddings. (Reference: https://platform.openai.com/docs/api-reference/embeddings)
 
+The REST API can be seamlessly operated from Google Colab, as demonstrated in the [FastChat_API_GoogleColab.ipynb](https://github.com/lm-sys/FastChat/blob/main/playground/FastChat_API_GoogleColab.ipynb) notebook, available in our repository. This notebook provides a practical example of how to utilize the API effectively within the Google Colab environment.
+
 ## RESTful API Server
 First, launch the controller
 

diff --git a/playground/FastChat_API_GoogleColab.ipynb b/playground/FastChat_API_GoogleColab.ipynb