Skip to content

Commit

Permalink
docs: Add offline engine launch example and documentation (sgl-projec…
Browse files Browse the repository at this point in the history
  • Loading branch information
shuaills authored Feb 21, 2025
1 parent 4592afc commit e074e76
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/backend/offline_engine_api.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
"- Non-streaming asynchronous generation\n",
"- Streaming asynchronous generation\n",
"\n",
"****To launch the offline engine, `__main__` condition is necessary in your own script because we use \"spawn\" to create subprocesses, for more details please refer to [launch_engine](https://github.com/sgl-project/sglang/blob/main/examples/runtime/engine/launch_engine.py).****\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)."
]
},
Expand Down Expand Up @@ -45,7 +47,6 @@
"if is_in_ci():\n",
" import patch\n",
"\n",
"\n",
"llm = sgl.Engine(model_path=\"meta-llama/Meta-Llama-3.1-8B-Instruct\")"
]
},
Expand Down
17 changes: 17 additions & 0 deletions examples/runtime/engine/launch_engine.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
This example demonstrates how to launch the offline engine.
"""

import sglang as sgl


def main():
llm = sgl.Engine(model_path="meta-llama/Meta-Llama-3.1-8B-Instruct")
llm.generate("What is the capital of France?")
llm.shutdown()


# The __main__ condition is necessary here because we use "spawn" to create subprocesses
# Spawn starts a fresh program every time, if there is no __main__, it will run into infinite loop to keep spawning processes from sgl.Engine
if __name__ == "__main__":
main()

0 comments on commit e074e76

Please sign in to comment.