api_server.py 28.8 KB
Newer Older
1
import asyncio
2
import atexit
3
4
import importlib
import inspect
5
import multiprocessing
6
import os
7
import re
8
import signal
9
import socket
10
import tempfile
11
import uuid
12
from argparse import Namespace
13
from contextlib import asynccontextmanager
14
from functools import partial
15
from http import HTTPStatus
16
from typing import AsyncIterator, Optional, Set, Tuple
17

18
import uvloop
19
from fastapi import APIRouter, FastAPI, Request
Zhuohan Li's avatar
Zhuohan Li committed
20
21
from fastapi.exceptions import RequestValidationError
from fastapi.middleware.cors import CORSMiddleware
22
from fastapi.responses import JSONResponse, Response, StreamingResponse
23
from starlette.datastructures import State
24
from starlette.routing import Mount
25
from typing_extensions import assert_never
Zhuohan Li's avatar
Zhuohan Li committed
26

27
import vllm.envs as envs
28
from vllm.config import ModelConfig
Woosuk Kwon's avatar
Woosuk Kwon committed
29
from vllm.engine.arg_utils import AsyncEngineArgs
30
from vllm.engine.async_llm_engine import AsyncLLMEngine  # type: ignore
31
32
33
from vllm.engine.multiprocessing.client import MQLLMEngineClient
from vllm.engine.multiprocessing.engine import run_mp_engine
from vllm.engine.protocol import EngineClient
34
from vllm.entrypoints.chat_utils import load_chat_template
35
from vllm.entrypoints.launcher import serve_http
36
from vllm.entrypoints.logger import RequestLogger
37
38
from vllm.entrypoints.openai.cli_args import (make_arg_parser,
                                              validate_parsed_serve_args)
39
40
# yapf conflicts with isort for this block
# yapf: disable
41
from vllm.entrypoints.openai.protocol import (ChatCompletionRequest,
42
                                              ChatCompletionResponse,
43
                                              CompletionRequest,
44
                                              CompletionResponse,
45
46
                                              DetokenizeRequest,
                                              DetokenizeResponse,
47
                                              EmbeddingRequest,
48
49
50
                                              EmbeddingResponse,
                                              EmbeddingResponseData,
                                              ErrorResponse,
51
                                              LoadLoraAdapterRequest,
52
                                              PoolingRequest, PoolingResponse,
53
                                              ScoreRequest, ScoreResponse,
54
                                              TokenizeRequest,
55
56
57
                                              TokenizeResponse,
                                              UnloadLoraAdapterRequest)
# yapf: enable
58
59
from vllm.entrypoints.openai.serving_chat import OpenAIServingChat
from vllm.entrypoints.openai.serving_completion import OpenAIServingCompletion
60
from vllm.entrypoints.openai.serving_embedding import OpenAIServingEmbedding
61
from vllm.entrypoints.openai.serving_engine import BaseModelPath, OpenAIServing
62
from vllm.entrypoints.openai.serving_pooling import OpenAIServingPooling
63
from vllm.entrypoints.openai.serving_score import OpenAIServingScores
64
65
from vllm.entrypoints.openai.serving_tokenization import (
    OpenAIServingTokenization)
66
from vllm.entrypoints.openai.tool_parsers import ToolParserManager
67
from vllm.entrypoints.utils import with_cancellation
68
from vllm.logger import init_logger
yhu422's avatar
yhu422 committed
69
from vllm.usage.usage_lib import UsageContext
70
from vllm.utils import (FlexibleArgumentParser, get_open_zmq_ipc_path,
71
                        is_valid_ipv6_address, set_ulimit)
72
from vllm.version import __version__ as VLLM_VERSION
Zhuohan Li's avatar
Zhuohan Li committed
73

74
TIMEOUT_KEEP_ALIVE = 5  # seconds
Zhuohan Li's avatar
Zhuohan Li committed
75

76
prometheus_multiproc_dir: tempfile.TemporaryDirectory
77

78
# Cannot use __name__ (https://github.com/vllm-project/vllm/pull/4765)
79
logger = init_logger('vllm.entrypoints.openai.api_server')
80

81
_running_tasks: Set[asyncio.Task] = set()
82

83

84
@asynccontextmanager
85
async def lifespan(app: FastAPI):
86
87
    try:
        if app.state.log_stats:
88
            engine_client: EngineClient = app.state.engine_client
89
90
91

            async def _force_log():
                while True:
92
93
                    await asyncio.sleep(10.)
                    await engine_client.do_log_stats()
94
95
96
97
98
99
100
101
102
103
104
105
106
107

            task = asyncio.create_task(_force_log())
            _running_tasks.add(task)
            task.add_done_callback(_running_tasks.remove)
        else:
            task = None
        try:
            yield
        finally:
            if task is not None:
                task.cancel()
    finally:
        # Ensure app state including engine ref is gc'd
        del app.state
108
109


110
@asynccontextmanager
111
async def build_async_engine_client(
112
        args: Namespace) -> AsyncIterator[EngineClient]:
113

114
    # Context manager to handle engine_client lifecycle
115
116
117
    # Ensures everything is shutdown and cleaned up on error/exit
    engine_args = AsyncEngineArgs.from_cli_args(args)

118
119
120
121
122
123
124
125
126
    async with build_async_engine_client_from_engine_args(
            engine_args, args.disable_frontend_multiprocessing) as engine:
        yield engine


@asynccontextmanager
async def build_async_engine_client_from_engine_args(
    engine_args: AsyncEngineArgs,
    disable_frontend_multiprocessing: bool = False,
127
) -> AsyncIterator[EngineClient]:
128
    """
129
    Create EngineClient, either:
130
131
132
133
134
135
        - in-process using the AsyncLLMEngine Directly
        - multiprocess using AsyncLLMEngine RPC

    Returns the Client or None if the creation failed.
    """

136
137
138
    # Fall back
    # TODO: fill out feature matrix.
    if (MQLLMEngineClient.is_unsupported_config(engine_args)
139
            or envs.VLLM_USE_V1 or disable_frontend_multiprocessing):
140
141
        engine_config = engine_args.create_engine_config(
            UsageContext.OPENAI_API_SERVER)
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
        uses_ray = getattr(AsyncLLMEngine._get_executor_cls(engine_config),
                           "uses_ray", False)

        build_engine = partial(AsyncLLMEngine.from_engine_args,
                               engine_args=engine_args,
                               engine_config=engine_config,
                               usage_context=UsageContext.OPENAI_API_SERVER)
        if uses_ray:
            # Must run in main thread with ray for its signal handlers to work
            engine_client = build_engine()
        else:
            engine_client = await asyncio.get_running_loop().run_in_executor(
                None, build_engine)

        yield engine_client
157
158
        if hasattr(engine_client, "shutdown"):
            engine_client.shutdown()
159
160
161
162
        return

    # Otherwise, use the multiprocessing AsyncLLMEngine.
    else:
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
        if "PROMETHEUS_MULTIPROC_DIR" not in os.environ:
            # Make TemporaryDirectory for prometheus multiprocessing
            # Note: global TemporaryDirectory will be automatically
            #   cleaned up upon exit.
            global prometheus_multiproc_dir
            prometheus_multiproc_dir = tempfile.TemporaryDirectory()
            os.environ[
                "PROMETHEUS_MULTIPROC_DIR"] = prometheus_multiproc_dir.name
        else:
            logger.warning(
                "Found PROMETHEUS_MULTIPROC_DIR was set by user. "
                "This directory must be wiped between vLLM runs or "
                "you will find inaccurate metrics. Unset the variable "
                "and vLLM will properly handle cleanup.")

178
        # Select random path for IPC.
179
        ipc_path = get_open_zmq_ipc_path()
180
181
        logger.debug("Multiprocessing frontend to use %s for IPC Path.",
                     ipc_path)
182

183
        # Start RPCServer in separate process (holds the LLMEngine).
184
185
        # the current process might have CUDA context,
        # so we need to spawn a new process
186
187
        context = multiprocessing.get_context("spawn")

188
189
190
191
        # The Process can raise an exception during startup, which may
        # not actually result in an exitcode being reported. As a result
        # we use a shared variable to communicate the information.
        engine_alive = multiprocessing.Value('b', True, lock=False)
192
193
194
        engine_process = context.Process(target=run_mp_engine,
                                         args=(engine_args,
                                               UsageContext.OPENAI_API_SERVER,
195
                                               ipc_path, engine_alive))
196
        engine_process.start()
197
        engine_pid = engine_process.pid
198
        assert engine_pid is not None, "Engine process failed to start."
199
        logger.info("Started engine process with PID %d", engine_pid)
200

201
202
203
204
205
206
207
208
        def _cleanup_ipc_path():
            socket_path = ipc_path.replace("ipc://", "")
            if os.path.exists(socket_path):
                os.remove(socket_path)

        # Ensure we clean up the local IPC socket file on exit.
        atexit.register(_cleanup_ipc_path)

209
210
        # Build RPCClient, which conforms to EngineClient Protocol.
        engine_config = engine_args.create_engine_config()
211
212
213
214
        build_client = partial(MQLLMEngineClient, ipc_path, engine_config,
                               engine_pid)
        mq_engine_client = await asyncio.get_running_loop().run_in_executor(
            None, build_client)
215
        try:
216
217
            while True:
                try:
218
                    await mq_engine_client.setup()
219
                    break
220
                except TimeoutError:
221
222
                    if (not engine_process.is_alive()
                            or not engine_alive.value):
223
                        raise RuntimeError(
224
225
                            "Engine process failed to start. See stack "
                            "trace for the root cause.") from None
226

227
            yield mq_engine_client  # type: ignore[misc]
228
229
        finally:
            # Ensure rpc server process was terminated
230
            engine_process.terminate()
231
232

            # Close all open connections to the backend
233
            mq_engine_client.close()
234

235
236
237
238
239
            # Wait for engine process to join
            engine_process.join(4)
            if engine_process.exitcode is None:
                # Kill if taking longer than 5 seconds to stop
                engine_process.kill()
240

241
242
243
244
245
            # Lazy import for prometheus multiprocessing.
            # We need to set PROMETHEUS_MULTIPROC_DIR environment variable
            # before prometheus_client is imported.
            # See https://prometheus.github.io/client_python/multiprocess/
            from prometheus_client import multiprocess
246
            multiprocess.mark_process_dead(engine_process.pid)
247

248

Ethan Xu's avatar
Ethan Xu committed
249
router = APIRouter()
Zhuohan Li's avatar
Zhuohan Li committed
250

251

252
def mount_metrics(app: FastAPI):
253
254
255
256
257
258
259
260
261
    # Lazy import for prometheus multiprocessing.
    # We need to set PROMETHEUS_MULTIPROC_DIR environment variable
    # before prometheus_client is imported.
    # See https://prometheus.github.io/client_python/multiprocess/
    from prometheus_client import (CollectorRegistry, make_asgi_app,
                                   multiprocess)

    prometheus_multiproc_dir_path = os.getenv("PROMETHEUS_MULTIPROC_DIR", None)
    if prometheus_multiproc_dir_path is not None:
262
263
        logger.debug("vLLM to use %s as PROMETHEUS_MULTIPROC_DIR",
                     prometheus_multiproc_dir_path)
264
265
266
267
268
269
270
271
272
        registry = CollectorRegistry()
        multiprocess.MultiProcessCollector(registry)

        # Add prometheus asgi middleware to route /metrics requests
        metrics_route = Mount("/metrics", make_asgi_app(registry=registry))
    else:
        # Add prometheus asgi middleware to route /metrics requests
        metrics_route = Mount("/metrics", make_asgi_app())

273
    # Workaround for 307 Redirect for /metrics
274
    metrics_route.path_regex = re.compile("^/metrics(?P<path>.*)$")
275
    app.routes.append(metrics_route)
276
277


278
279
280
281
282
283
def base(request: Request) -> OpenAIServing:
    # Reuse the existing instance
    return tokenization(request)


def chat(request: Request) -> Optional[OpenAIServingChat]:
284
285
286
    return request.app.state.openai_serving_chat


287
def completion(request: Request) -> Optional[OpenAIServingCompletion]:
288
289
290
    return request.app.state.openai_serving_completion


291
292
293
294
def pooling(request: Request) -> Optional[OpenAIServingPooling]:
    return request.app.state.openai_serving_pooling


295
296
def embedding(request: Request) -> Optional[OpenAIServingEmbedding]:
    return request.app.state.openai_serving_embedding
297
298


299
300
301
302
def score(request: Request) -> Optional[OpenAIServingScores]:
    return request.app.state.openai_serving_scores


303
304
def tokenization(request: Request) -> OpenAIServingTokenization:
    return request.app.state.openai_serving_tokenization
305
306


307
def engine_client(request: Request) -> EngineClient:
308
309
310
    return request.app.state.engine_client


Ethan Xu's avatar
Ethan Xu committed
311
@router.get("/health")
312
async def health(raw_request: Request) -> Response:
313
    """Health check."""
314
    await engine_client(raw_request).check_health()
315
316
317
    return Response(status_code=200)


Ethan Xu's avatar
Ethan Xu committed
318
@router.post("/tokenize")
319
@with_cancellation
320
async def tokenize(request: TokenizeRequest, raw_request: Request):
321
322
    handler = tokenization(raw_request)

323
    generator = await handler.create_tokenize(request, raw_request)
324
325
326
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
327
    elif isinstance(generator, TokenizeResponse):
328
329
        return JSONResponse(content=generator.model_dump())

330
331
    assert_never(generator)

332

Ethan Xu's avatar
Ethan Xu committed
333
@router.post("/detokenize")
334
@with_cancellation
335
async def detokenize(request: DetokenizeRequest, raw_request: Request):
336
337
    handler = tokenization(raw_request)

338
    generator = await handler.create_detokenize(request, raw_request)
339
340
341
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
342
    elif isinstance(generator, DetokenizeResponse):
343
344
        return JSONResponse(content=generator.model_dump())

345
346
    assert_never(generator)

347

Ethan Xu's avatar
Ethan Xu committed
348
@router.get("/v1/models")
349
async def show_available_models(raw_request: Request):
350
351
352
    handler = base(raw_request)

    models = await handler.show_available_models()
353
    return JSONResponse(content=models.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
354
355


Ethan Xu's avatar
Ethan Xu committed
356
@router.get("/version")
357
async def show_version():
358
    ver = {"version": VLLM_VERSION}
359
360
361
    return JSONResponse(content=ver)


Ethan Xu's avatar
Ethan Xu committed
362
@router.post("/v1/chat/completions")
363
@with_cancellation
364
365
async def create_chat_completion(request: ChatCompletionRequest,
                                 raw_request: Request):
366
367
368
369
    handler = chat(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Chat Completions API")
370

371
    generator = await handler.create_chat_completion(request, raw_request)
372

373
374
375
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
376

377
    elif isinstance(generator, ChatCompletionResponse):
378
        return JSONResponse(content=generator.model_dump())
379

380
381
    return StreamingResponse(content=generator, media_type="text/event-stream")

382

Ethan Xu's avatar
Ethan Xu committed
383
@router.post("/v1/completions")
384
@with_cancellation
385
async def create_completion(request: CompletionRequest, raw_request: Request):
386
387
388
389
390
391
    handler = completion(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Completions API")

    generator = await handler.create_completion(request, raw_request)
392
393
394
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
395
    elif isinstance(generator, CompletionResponse):
396
        return JSONResponse(content=generator.model_dump())
Zhuohan Li's avatar
Zhuohan Li committed
397

398
399
    return StreamingResponse(content=generator, media_type="text/event-stream")

Zhuohan Li's avatar
Zhuohan Li committed
400

Ethan Xu's avatar
Ethan Xu committed
401
@router.post("/v1/embeddings")
402
@with_cancellation
403
async def create_embedding(request: EmbeddingRequest, raw_request: Request):
404
405
    handler = embedding(raw_request)
    if handler is None:
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
        fallback_handler = pooling(raw_request)
        if fallback_handler is None:
            return base(raw_request).create_error_response(
                message="The model does not support Embeddings API")

        logger.warning(
            "Embeddings API will become exclusive to embedding models "
            "in a future release. To return the hidden states directly, "
            "use the Pooling API (`/pooling`) instead.")

        res = await fallback_handler.create_pooling(request, raw_request)
        if isinstance(res, PoolingResponse):
            generator = EmbeddingResponse(
                id=res.id,
                object=res.object,
                created=res.created,
                model=res.model,
                data=[
                    EmbeddingResponseData(
                        index=d.index,
                        embedding=d.data,  # type: ignore
                    ) for d in res.data
                ],
                usage=res.usage,
            )
        else:
            generator = res
    else:
        generator = await handler.create_embedding(request, raw_request)
435

436
437
438
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
439
    elif isinstance(generator, EmbeddingResponse):
440
441
        return JSONResponse(content=generator.model_dump())

442
443
    assert_never(generator)

444

445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
@router.post("/pooling")
@with_cancellation
async def create_pooling(request: PoolingRequest, raw_request: Request):
    handler = pooling(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Pooling API")

    generator = await handler.create_pooling(request, raw_request)
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
    elif isinstance(generator, PoolingResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


463
@router.post("/score")
464
@with_cancellation
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
async def create_score(request: ScoreRequest, raw_request: Request):
    handler = score(raw_request)
    if handler is None:
        return base(raw_request).create_error_response(
            message="The model does not support Score API")

    generator = await handler.create_score(request, raw_request)
    if isinstance(generator, ErrorResponse):
        return JSONResponse(content=generator.model_dump(),
                            status_code=generator.code)
    elif isinstance(generator, ScoreResponse):
        return JSONResponse(content=generator.model_dump())

    assert_never(generator)


481
@router.post("/v1/score")
482
@with_cancellation
483
484
485
486
487
488
489
490
async def create_score_v1(request: ScoreRequest, raw_request: Request):
    logger.warning(
        "To indicate that Score API is not part of standard OpenAI API, we "
        "have moved it to `/score`. Please update your client accordingly.")

    return await create_score(request, raw_request)


491
492
493
494
495
496
if envs.VLLM_TORCH_PROFILER_DIR:
    logger.warning(
        "Torch Profiler is enabled in the API server. This should ONLY be "
        "used for local development!")

    @router.post("/start_profile")
497
    async def start_profile(raw_request: Request):
498
        logger.info("Starting profiler...")
499
        await engine_client(raw_request).start_profile()
500
501
502
503
        logger.info("Profiler started.")
        return Response(status_code=200)

    @router.post("/stop_profile")
504
    async def stop_profile(raw_request: Request):
505
        logger.info("Stopping profiler...")
506
        await engine_client(raw_request).stop_profile()
507
508
509
510
        logger.info("Profiler stopped.")
        return Response(status_code=200)


511
512
513
514
515
516
if envs.VLLM_ALLOW_RUNTIME_LORA_UPDATING:
    logger.warning(
        "Lora dynamic loading & unloading is enabled in the API server. "
        "This should ONLY be used for local development!")

    @router.post("/v1/load_lora_adapter")
517
518
    async def load_lora_adapter(request: LoadLoraAdapterRequest,
                                raw_request: Request):
519
520
521
522
523
524
525
        for route in [chat, completion, embedding]:
            handler = route(raw_request)
            if handler is not None:
                response = await handler.load_lora_adapter(request)
                if isinstance(response, ErrorResponse):
                    return JSONResponse(content=response.model_dump(),
                                        status_code=response.code)
526
527
528
529

        return Response(status_code=200, content=response)

    @router.post("/v1/unload_lora_adapter")
530
531
    async def unload_lora_adapter(request: UnloadLoraAdapterRequest,
                                  raw_request: Request):
532
533
534
535
536
537
538
        for route in [chat, completion, embedding]:
            handler = route(raw_request)
            if handler is not None:
                response = await handler.unload_lora_adapter(request)
                if isinstance(response, ErrorResponse):
                    return JSONResponse(content=response.model_dump(),
                                        status_code=response.code)
539
540
541
542

        return Response(status_code=200, content=response)


543
def build_app(args: Namespace) -> FastAPI:
544
545
546
547
548
549
550
    if args.disable_fastapi_docs:
        app = FastAPI(openapi_url=None,
                      docs_url=None,
                      redoc_url=None,
                      lifespan=lifespan)
    else:
        app = FastAPI(lifespan=lifespan)
Ethan Xu's avatar
Ethan Xu committed
551
552
    app.include_router(router)
    app.root_path = args.root_path
Zhuohan Li's avatar
Zhuohan Li committed
553

554
555
    mount_metrics(app)

Zhuohan Li's avatar
Zhuohan Li committed
556
557
558
559
560
561
562
563
    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

Ethan Xu's avatar
Ethan Xu committed
564
565
    @app.exception_handler(RequestValidationError)
    async def validation_exception_handler(_, exc):
566
567
568
        err = ErrorResponse(message=str(exc),
                            type="BadRequestError",
                            code=HTTPStatus.BAD_REQUEST)
Ethan Xu's avatar
Ethan Xu committed
569
570
571
        return JSONResponse(err.model_dump(),
                            status_code=HTTPStatus.BAD_REQUEST)

572
    if token := envs.VLLM_API_KEY or args.api_key:
573
574
575

        @app.middleware("http")
        async def authentication(request: Request, call_next):
576
577
            if request.method == "OPTIONS":
                return await call_next(request)
578
579
580
581
            url_path = request.url.path
            if app.root_path and url_path.startswith(app.root_path):
                url_path = url_path[len(app.root_path):]
            if not url_path.startswith("/v1"):
582
583
584
585
586
587
                return await call_next(request)
            if request.headers.get("Authorization") != "Bearer " + token:
                return JSONResponse(content={"error": "Unauthorized"},
                                    status_code=401)
            return await call_next(request)

588
589
590
591
592
593
594
595
596
597
598
599
    if args.enable_request_id_headers:
        logger.warning(
            "CAUTION: Enabling X-Request-Id headers in the API Server. "
            "This can harm performance at high QPS.")

        @app.middleware("http")
        async def add_request_id(request: Request, call_next):
            request_id = request.headers.get(
                "X-Request-Id") or uuid.uuid4().hex
            response = await call_next(request)
            response.headers["X-Request-Id"] = request_id
            return response
600

601
602
603
604
605
606
607
608
    for middleware in args.middleware:
        module_path, object_name = middleware.rsplit(".", 1)
        imported = getattr(importlib.import_module(module_path), object_name)
        if inspect.isclass(imported):
            app.add_middleware(imported)
        elif inspect.iscoroutinefunction(imported):
            app.middleware("http")(imported)
        else:
609
610
            raise ValueError(f"Invalid middleware {middleware}. "
                             f"Must be a function or a class.")
611

Ethan Xu's avatar
Ethan Xu committed
612
613
614
    return app


615
def init_app_state(
616
    engine_client: EngineClient,
617
618
    model_config: ModelConfig,
    state: State,
619
    args: Namespace,
620
) -> None:
621
    if args.served_model_name is not None:
622
        served_model_names = args.served_model_name
623
    else:
624
        served_model_names = [args.model]
625

626
627
628
629
630
    if args.disable_log_requests:
        request_logger = None
    else:
        request_logger = RequestLogger(max_log_len=args.max_log_len)

631
632
633
634
635
    base_model_paths = [
        BaseModelPath(name=name, model_path=args.model)
        for name in served_model_names
    ]

636
    state.engine_client = engine_client
637
    state.log_stats = not args.disable_log_stats
Ethan Xu's avatar
Ethan Xu committed
638

639
640
641
    resolved_chat_template = load_chat_template(args.chat_template)
    logger.info("Using supplied chat template:\n%s", resolved_chat_template)

642
    state.openai_serving_chat = OpenAIServingChat(
643
        engine_client,
644
        model_config,
645
        base_model_paths,
646
647
648
649
        args.response_role,
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
        request_logger=request_logger,
650
651
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
652
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
653
        enable_auto_tools=args.enable_auto_tool_choice,
654
        tool_parser=args.tool_call_parser,
655
        enable_prompt_tokens_details=args.enable_prompt_tokens_details,
656
    ) if model_config.runner_type == "generate" else None
657
    state.openai_serving_completion = OpenAIServingCompletion(
658
        engine_client,
659
        model_config,
660
        base_model_paths,
661
662
663
        lora_modules=args.lora_modules,
        prompt_adapters=args.prompt_adapters,
        request_logger=request_logger,
664
        return_tokens_as_token_ids=args.return_tokens_as_token_ids,
665
    ) if model_config.runner_type == "generate" else None
666
    state.openai_serving_pooling = OpenAIServingPooling(
667
        engine_client,
668
        model_config,
669
        base_model_paths,
670
        request_logger=request_logger,
671
672
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
673
    ) if model_config.runner_type == "pooling" else None
674
675
676
677
678
679
680
681
    state.openai_serving_embedding = OpenAIServingEmbedding(
        engine_client,
        model_config,
        base_model_paths,
        request_logger=request_logger,
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
    ) if model_config.task == "embed" else None
682
683
684
685
686
    state.openai_serving_scores = OpenAIServingScores(
        engine_client,
        model_config,
        base_model_paths,
        request_logger=request_logger
687
    ) if model_config.task == "score" else None
688
    state.openai_serving_tokenization = OpenAIServingTokenization(
689
        engine_client,
690
        model_config,
691
        base_model_paths,
692
693
        lora_modules=args.lora_modules,
        request_logger=request_logger,
694
695
        chat_template=resolved_chat_template,
        chat_template_content_format=args.chat_template_content_format,
696
    )
697
698


699
700
701
702
703
704
705
706
707
708
709
710
def create_server_socket(addr: Tuple[str, int]) -> socket.socket:
    family = socket.AF_INET
    if is_valid_ipv6_address(addr[0]):
        family = socket.AF_INET6

    sock = socket.socket(family=family, type=socket.SOCK_STREAM)
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
    sock.bind(addr)

    return sock


711
async def run_server(args, **uvicorn_kwargs) -> None:
712
713
714
    logger.info("vLLM API server version %s", VLLM_VERSION)
    logger.info("args: %s", args)

715
716
717
718
719
720
721
722
723
    if args.tool_parser_plugin and len(args.tool_parser_plugin) > 3:
        ToolParserManager.import_tool_parser(args.tool_parser_plugin)

    valide_tool_parses = ToolParserManager.tool_parsers.keys()
    if args.enable_auto_tool_choice \
        and args.tool_call_parser not in valide_tool_parses:
        raise KeyError(f"invalid tool call parser: {args.tool_call_parser} "
                       f"(chose from {{ {','.join(valide_tool_parses)} }})")

724
725
726
    # workaround to make sure that we bind the port before the engine is set up.
    # This avoids race conditions with ray.
    # see https://github.com/vllm-project/vllm/issues/8204
727
728
    sock_addr = (args.host or "", args.port)
    sock = create_server_socket(sock_addr)
729

730
731
732
733
    # workaround to avoid footguns where uvicorn drops requests with too
    # many concurrent requests active
    set_ulimit()

734
735
736
737
738
739
    def signal_handler(*_) -> None:
        # Interrupt server on sigterm while initializing
        raise KeyboardInterrupt("terminated")

    signal.signal(signal.SIGTERM, signal_handler)

740
    async with build_async_engine_client(args) as engine_client:
741
742
        app = build_app(args)

743
744
        model_config = await engine_client.get_model_config()
        init_app_state(engine_client, model_config, app.state, args)
745
746
747
748
749
750
751
752
753
754
755

        shutdown_task = await serve_http(
            app,
            host=args.host,
            port=args.port,
            log_level=args.uvicorn_log_level,
            timeout_keep_alive=TIMEOUT_KEEP_ALIVE,
            ssl_keyfile=args.ssl_keyfile,
            ssl_certfile=args.ssl_certfile,
            ssl_ca_certs=args.ssl_ca_certs,
            ssl_cert_reqs=args.ssl_cert_reqs,
756
757
758
            **uvicorn_kwargs,
        )

759
760
    # NB: Await server shutdown only after the backend context is exited
    await shutdown_task
761

762
763
    sock.close()

Ethan Xu's avatar
Ethan Xu committed
764
765
766
767
768
769
770
771

if __name__ == "__main__":
    # NOTE(simon):
    # This section should be in sync with vllm/scripts.py for CLI entrypoints.
    parser = FlexibleArgumentParser(
        description="vLLM OpenAI-Compatible RESTful API server.")
    parser = make_arg_parser(parser)
    args = parser.parse_args()
772
    validate_parsed_serve_args(args)
773

774
    uvloop.run(run_server(args))