From 6b859e7ddd8178823dc500a52cd172791b15677b Mon Sep 17 00:00:00 2001 From: Chayenne Date: Fri, 28 Feb 2025 21:59:20 -0800 Subject: [PATCH] Docs: add special warning to engine docs (#3979) --- docs/backend/offline_engine_api.ipynb | 7 +++++-- docs/serve.sh | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/backend/offline_engine_api.ipynb b/docs/backend/offline_engine_api.ipynb index 4d5f4034a..1ee45d4f4 100644 --- a/docs/backend/offline_engine_api.ipynb +++ b/docs/backend/offline_engine_api.ipynb @@ -18,10 +18,13 @@ "- Non-streaming asynchronous generation\n", "- Streaming asynchronous generation\n", "\n", + "Additionally, you can easily build a custom server on top of the SGLang offline engine. A detailed example working in a python script can be found in [custom_server](https://github.com/sgl-project/sglang/blob/main/examples/runtime/engine/custom_server.py).\n", "\n", - "**To launch the offline engine in your python scripts,** `__main__` **condition is necessary, since we use** `spawn` **mode to create subprocesses. Please refer to this** [simple example](https://github.com/sgl-project/sglang/blob/main/examples/runtime/engine/launch_engine.py) **for more details.**\n", + "## SPECIAL WARNING!!!!\n", "\n", - "Additionally, you can easily build a custom server on top of the SGLang offline engine. A detailed example working in a python script can be found in [custom_server](https://github.com/sgl-project/sglang/blob/main/examples/runtime/engine/custom_server.py)." + "**To launch the offline engine in your python scripts,** `__main__` **condition is necessary, since we use** `spawn` **mode to create subprocesses. Please refer to this simple example**:\n", + "\n", + "https://github.com/sgl-project/sglang/blob/main/examples/runtime/engine/launch_engine.py" ] }, { diff --git a/docs/serve.sh b/docs/serve.sh index 5a12e9093..ed35ba1f3 100644 --- a/docs/serve.sh +++ b/docs/serve.sh @@ -1,3 +1,3 @@ make clean make html -python3 -m http.server --d _build/html +python3 -m http.server --d _build/html 8003