[Doc] Specify async engine args in docs (vllm-project#9726)

lk-chen · Nov 4, 2024 · 7be802c · 7be802c
1 parent 33fdcae
commit 7be802c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/vllm/engine/async_llm_engine.py b/vllm/engine/async_llm_engine.py
@@ -999,6 +999,7 @@ async def generate(
             >>> # the complete example.
             >>>
             >>> # initialize the engine and the example input
+            >>> # note that engine_args here is AsyncEngineArgs instance
             >>> engine = AsyncLLMEngine.from_engine_args(engine_args)
             >>> example_input = {
             >>>     "prompt": "What is LLM?",
@@ -1082,6 +1083,7 @@ async def encode(
             >>> # the complete example.
             >>>
             >>> # initialize the engine and the example input
+            >>> # note that engine_args here is AsyncEngineArgs instance
             >>> engine = AsyncLLMEngine.from_engine_args(engine_args)
             >>> example_input = {
             >>>     "input": "What is LLM?",