api_server.py 30.2 KB
Newer Older
1
2
# Adapted from
# https://github.com/lm-sys/FastChat/blob/168ccc29d3f7edc50823016105c024fe2282732a/fastchat/serve/openai_api_server.py
Zhuohan Li's avatar
Zhuohan Li committed
3
4

import argparse
5
import asyncio
6
import codecs
Zhuohan Li's avatar
Zhuohan Li committed
7
8
import json
import time
9
from contextlib import asynccontextmanager
10
11
from http import HTTPStatus
from typing import AsyncGenerator, Dict, List, Optional, Tuple, Union
Zhuohan Li's avatar
Zhuohan Li committed
12

13
14
from aioprometheus import MetricsMiddleware
from aioprometheus.asgi.starlette import metrics
Zhuohan Li's avatar
Zhuohan Li committed
15
import fastapi
16
import uvicorn
17
from fastapi import Request
Zhuohan Li's avatar
Zhuohan Li committed
18
19
from fastapi.exceptions import RequestValidationError
from fastapi.middleware.cors import CORSMiddleware
20
from fastapi.responses import JSONResponse, StreamingResponse, Response
Zhuohan Li's avatar
Zhuohan Li committed
21

Woosuk Kwon's avatar
Woosuk Kwon committed
22
23
from vllm.engine.arg_utils import AsyncEngineArgs
from vllm.engine.async_llm_engine import AsyncLLMEngine
24
from vllm.engine.metrics import add_global_metrics_labels
Woosuk Kwon's avatar
Woosuk Kwon committed
25
from vllm.entrypoints.openai.protocol import (
Zhuohan Li's avatar
Zhuohan Li committed
26
    CompletionRequest, CompletionResponse, CompletionResponseChoice,
27
    CompletionResponseStreamChoice, CompletionStreamResponse,
28
29
30
31
    ChatCompletionRequest, ChatCompletionResponse,
    ChatCompletionResponseChoice, ChatCompletionResponseStreamChoice,
    ChatCompletionStreamResponse, ChatMessage, DeltaMessage, ErrorResponse,
    LogProbs, ModelCard, ModelList, ModelPermission, UsageInfo)
Woosuk Kwon's avatar
Woosuk Kwon committed
32
33
34
from vllm.logger import init_logger
from vllm.outputs import RequestOutput
from vllm.sampling_params import SamplingParams
35
from vllm.transformers_utils.tokenizer import get_tokenizer
Woosuk Kwon's avatar
Woosuk Kwon committed
36
from vllm.utils import random_uuid
Zhuohan Li's avatar
Zhuohan Li committed
37

38
TIMEOUT_KEEP_ALIVE = 5  # seconds
Zhuohan Li's avatar
Zhuohan Li committed
39
40
41

logger = init_logger(__name__)
served_model = None
42
engine_args = None
43
engine = None
44
45
46
response_role = None


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@asynccontextmanager
async def lifespan(app: fastapi.FastAPI):

    async def _force_log():
        while True:
            await asyncio.sleep(10)
            await engine.do_log_stats()

    if not engine_args.disable_log_stats:
        asyncio.create_task(_force_log())

    yield


app = fastapi.FastAPI(lifespan=lifespan)


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
def parse_args():
    parser = argparse.ArgumentParser(
        description="vLLM OpenAI-Compatible RESTful API server.")
    parser.add_argument("--host", type=str, default=None, help="host name")
    parser.add_argument("--port", type=int, default=8000, help="port number")
    parser.add_argument("--allow-credentials",
                        action="store_true",
                        help="allow credentials")
    parser.add_argument("--allowed-origins",
                        type=json.loads,
                        default=["*"],
                        help="allowed origins")
    parser.add_argument("--allowed-methods",
                        type=json.loads,
                        default=["*"],
                        help="allowed methods")
    parser.add_argument("--allowed-headers",
                        type=json.loads,
                        default=["*"],
                        help="allowed headers")
    parser.add_argument("--served-model-name",
                        type=str,
                        default=None,
                        help="The model name used in the API. If not "
                        "specified, the model name will be the same as "
                        "the huggingface name.")
    parser.add_argument("--chat-template",
                        type=str,
                        default=None,
                        help="The file path to the chat template, "
                        "or the template in single-line form "
                        "for the specified model")
    parser.add_argument("--response-role",
                        type=str,
                        default="assistant",
                        help="The role name to return if "
                        "`request.add_generation_prompt=true`.")
101
102
103
104
105
106
107
108
    parser.add_argument("--ssl-keyfile",
                        type=str,
                        default=None,
                        help="The file path to the SSL key file")
    parser.add_argument("--ssl-certfile",
                        type=str,
                        default=None,
                        help="The file path to the SSL cert file")
109
110
111

    parser = AsyncEngineArgs.add_cli_args(parser)
    return parser.parse_args()
Zhuohan Li's avatar
Zhuohan Li committed
112
113


114
115
116
117
app.add_middleware(MetricsMiddleware)  # Trace HTTP server metrics
app.add_route("/metrics", metrics)  # Exposes HTTP metrics


Zhuohan Li's avatar
Zhuohan Li committed
118
119
def create_error_response(status_code: HTTPStatus,
                          message: str) -> JSONResponse:
120
121
122
    return JSONResponse(ErrorResponse(message=message,
                                      type="invalid_request_error").dict(),
                        status_code=status_code.value)
Zhuohan Li's avatar
Zhuohan Li committed
123
124


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
def load_chat_template(args, tokenizer):
    if args.chat_template is not None:
        try:
            with open(args.chat_template, "r") as f:
                chat_template = f.read()
        except OSError:
            # If opening a file fails, set chat template to be args to
            # ensure we decode so our escape are interpreted correctly
            chat_template = codecs.decode(args.chat_template, "unicode_escape")

        tokenizer.chat_template = chat_template
        logger.info(
            f"Using supplied chat template:\n{tokenizer.chat_template}")
    elif tokenizer.chat_template is not None:
        logger.info(f"Using default chat template:\n{tokenizer.chat_template}")
    else:
        logger.warning("No chat template provided. Chat API will not work.")


Zhuohan Li's avatar
Zhuohan Li committed
144
@app.exception_handler(RequestValidationError)
145
async def validation_exception_handler(_, exc):
Zhuohan Li's avatar
Zhuohan Li committed
146
147
148
149
150
151
152
153
154
155
156
157
158
    return create_error_response(HTTPStatus.BAD_REQUEST, str(exc))


async def check_model(request) -> Optional[JSONResponse]:
    if request.model == served_model:
        return
    ret = create_error_response(
        HTTPStatus.NOT_FOUND,
        f"The model `{request.model}` does not exist.",
    )
    return ret


159
160
161
162
163
164
165
166
async def check_length(
    request: Union[ChatCompletionRequest, CompletionRequest],
    prompt: Optional[str] = None,
    prompt_ids: Optional[List[int]] = None
) -> Tuple[List[int], Optional[JSONResponse]]:
    assert (not (prompt is None and prompt_ids is None)
            and not (prompt is not None and prompt_ids is not None)
            ), "Either prompt or prompt_ids should be provided."
167
168
    input_ids = prompt_ids if prompt_ids is not None else tokenizer(
        prompt).input_ids
169
170
    token_num = len(input_ids)

171
172
    if request.max_tokens is None:
        request.max_tokens = max_model_len - token_num
173
    if token_num + request.max_tokens > max_model_len:
174
        return input_ids, create_error_response(
175
            HTTPStatus.BAD_REQUEST,
176
            f"This model's maximum context length is {max_model_len} tokens. "
177
178
179
180
181
182
            f"However, you requested {request.max_tokens + token_num} tokens "
            f"({token_num} in the messages, "
            f"{request.max_tokens} in the completion). "
            f"Please reduce the length of the messages or completion.",
        )
    else:
183
        return input_ids, None
184
185


186
187
188
189
190
191
@app.get("/health")
async def health() -> Response:
    """Health check."""
    return Response(status_code=200)


Zhuohan Li's avatar
Zhuohan Li committed
192
193
194
@app.get("/v1/models")
async def show_available_models():
    """Show available models. Right now we only have one model."""
195
196
197
198
199
    model_cards = [
        ModelCard(id=served_model,
                  root=served_model,
                  permission=[ModelPermission()])
    ]
Zhuohan Li's avatar
Zhuohan Li committed
200
201
202
    return ModelList(data=model_cards)


203
204
205
206
207
208
def create_logprobs(
    token_ids: List[int],
    top_logprobs: Optional[List[Optional[Dict[int, float]]]] = None,
    num_output_top_logprobs: Optional[int] = None,
    initial_text_offset: int = 0,
) -> LogProbs:
Zhuohan Li's avatar
Zhuohan Li committed
209
210
211
    """Create OpenAI-style logprobs."""
    logprobs = LogProbs()
    last_token_len = 0
212
213
214
215
216
217
218
219
    if num_output_top_logprobs:
        logprobs.top_logprobs = []
    for i, token_id in enumerate(token_ids):
        step_top_logprobs = top_logprobs[i]
        if step_top_logprobs is not None:
            token_logprob = step_top_logprobs[token_id]
        else:
            token_logprob = None
Zhuohan Li's avatar
Zhuohan Li committed
220
221
        token = tokenizer.convert_ids_to_tokens(token_id)
        logprobs.tokens.append(token)
222
        logprobs.token_logprobs.append(token_logprob)
Zhuohan Li's avatar
Zhuohan Li committed
223
224
225
        if len(logprobs.text_offset) == 0:
            logprobs.text_offset.append(initial_text_offset)
        else:
226
227
            logprobs.text_offset.append(logprobs.text_offset[-1] +
                                        last_token_len)
Zhuohan Li's avatar
Zhuohan Li committed
228
229
        last_token_len = len(token)

230
231
232
233
234
        if num_output_top_logprobs:
            logprobs.top_logprobs.append({
                tokenizer.convert_ids_to_tokens(i): p
                for i, p in step_top_logprobs.items()
            } if step_top_logprobs else None)
Zhuohan Li's avatar
Zhuohan Li committed
235
236
237
    return logprobs


238
@app.post("/v1/chat/completions")
239
240
async def create_chat_completion(request: ChatCompletionRequest,
                                 raw_request: Request):
241
242
243
244
245
246
247
248
249
250
251
252
253
    """Completion API similar to OpenAI's API.

    See  https://platform.openai.com/docs/api-reference/chat/create
    for the API specification. This API mimics the OpenAI ChatCompletion API.

    NOTE: Currently we do not support the following features:
        - function_call (Users should implement this by themselves)
        - logit_bias (to be supported by vLLM engine)
    """
    error_check_ret = await check_model(request)
    if error_check_ret is not None:
        return error_check_ret

254
    if request.logit_bias is not None and len(request.logit_bias) > 0:
255
256
257
258
        # TODO: support logit_bias in vLLM engine.
        return create_error_response(HTTPStatus.BAD_REQUEST,
                                     "logit_bias is not currently supported")

259
260
261
262
263
264
265
266
267
    try:
        prompt = tokenizer.apply_chat_template(
            conversation=request.messages,
            tokenize=False,
            add_generation_prompt=request.add_generation_prompt)
    except Exception as e:
        logger.error(f"Error in applying chat template from request: {str(e)}")
        return create_error_response(HTTPStatus.BAD_REQUEST, str(e))

268
    token_ids, error_check_ret = await check_length(request, prompt=prompt)
269
270
271
272
273
    if error_check_ret is not None:
        return error_check_ret

    model_name = request.model
    request_id = f"cmpl-{random_uuid()}"
274
    created_time = int(time.monotonic())
275
    chunk_object_type = "chat.completion.chunk"
276
    try:
277
        spaces_between_special_tokens = request.spaces_between_special_tokens
278
279
280
281
        sampling_params = SamplingParams(
            n=request.n,
            presence_penalty=request.presence_penalty,
            frequency_penalty=request.frequency_penalty,
Roy's avatar
Roy committed
282
            repetition_penalty=request.repetition_penalty,
283
284
            temperature=request.temperature,
            top_p=request.top_p,
Roy's avatar
Roy committed
285
            min_p=request.min_p,
286
            stop=request.stop,
287
            stop_token_ids=request.stop_token_ids,
288
289
290
291
292
            max_tokens=request.max_tokens,
            best_of=request.best_of,
            top_k=request.top_k,
            ignore_eos=request.ignore_eos,
            use_beam_search=request.use_beam_search,
293
            skip_special_tokens=request.skip_special_tokens,
294
            spaces_between_special_tokens=spaces_between_special_tokens,
295
296
297
298
        )
    except ValueError as e:
        return create_error_response(HTTPStatus.BAD_REQUEST, str(e))

299
300
    result_generator = engine.generate(prompt, sampling_params, request_id,
                                       token_ids)
301

302
303
304
305
306
    def get_role() -> str:
        if request.add_generation_prompt:
            return response_role
        else:
            return request.messages[-1]["role"]
307
308

    async def completion_stream_generator() -> AsyncGenerator[str, None]:
309
310
        # Send first response for each request.n (index) with the role
        role = get_role()
311
312
        for i in range(request.n):
            choice_data = ChatCompletionResponseStreamChoice(
313
                index=i, delta=DeltaMessage(role=role), finish_reason=None)
314
            chunk = ChatCompletionStreamResponse(id=request_id,
315
316
                                                 object=chunk_object_type,
                                                 created=created_time,
317
318
319
320
                                                 choices=[choice_data],
                                                 model=model_name)
            data = chunk.json(exclude_unset=True, ensure_ascii=False)
            yield f"data: {data}\n\n"
321

322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
        # Send response to echo the input portion of the last message
        if request.echo:
            last_msg_content = ""
            if request.messages and isinstance(
                    request.messages, list) and request.messages[-1].get(
                        "content") and request.messages[-1].get(
                            "role") == role:
                last_msg_content = request.messages[-1]["content"]
            if last_msg_content:
                for i in range(request.n):
                    choice_data = ChatCompletionResponseStreamChoice(
                        index=i,
                        delta=DeltaMessage(content=last_msg_content),
                        finish_reason=None)
                    chunk = ChatCompletionStreamResponse(
                        id=request_id,
                        object=chunk_object_type,
                        created=created_time,
                        choices=[choice_data],
                        model=model_name)
                    data = chunk.json(exclude_unset=True, ensure_ascii=False)
                    yield f"data: {data}\n\n"

        # Send response for each token for each request.n (index)
346
347
        previous_texts = [""] * request.n
        previous_num_tokens = [0] * request.n
348
        finish_reason_sent = [False] * request.n
349
350
351
352
        async for res in result_generator:
            res: RequestOutput
            for output in res.outputs:
                i = output.index
353
354
355
356
357
358
359
360

                if finish_reason_sent[i]:
                    continue

                if output.finish_reason is None:
                    # Send token-by-token response for each request.n
                    delta_text = output.text[len(previous_texts[i]):]
                    previous_texts[i] = output.text
361
                    previous_num_tokens[i] = len(output.token_ids)
362
363
364
365
366
367
368
369
370
371
372
373
374
375
                    choice_data = ChatCompletionResponseStreamChoice(
                        index=i,
                        delta=DeltaMessage(content=delta_text),
                        finish_reason=None)
                    chunk = ChatCompletionStreamResponse(
                        id=request_id,
                        object=chunk_object_type,
                        created=created_time,
                        choices=[choice_data],
                        model=model_name)
                    data = chunk.json(exclude_unset=True, ensure_ascii=False)
                    yield f"data: {data}\n\n"
                else:
                    # Send the finish response for each request.n only once
376
377
378
                    prompt_tokens = len(res.prompt_token_ids)
                    final_usage = UsageInfo(
                        prompt_tokens=prompt_tokens,
379
380
                        completion_tokens=previous_num_tokens[i],
                        total_tokens=prompt_tokens + previous_num_tokens[i],
381
                    )
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
                    choice_data = ChatCompletionResponseStreamChoice(
                        index=i, delta=[], finish_reason=output.finish_reason)
                    chunk = ChatCompletionStreamResponse(
                        id=request_id,
                        object=chunk_object_type,
                        created=created_time,
                        choices=[choice_data],
                        model=model_name)
                    if final_usage is not None:
                        chunk.usage = final_usage
                    data = chunk.json(exclude_unset=True,
                                      exclude_none=True,
                                      ensure_ascii=False)
                    yield f"data: {data}\n\n"
                    finish_reason_sent[i] = True
        # Send the final done message after all response.n are finished
398
        yield "data: [DONE]\n\n"
399

400
401
402
403
404
405
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
435
436
437
438
439
440
441
442
443
444
445
446
    async def completion_full_generator():
        final_res: RequestOutput = None
        async for res in result_generator:
            if await raw_request.is_disconnected():
                # Abort the request if the client disconnects.
                await engine.abort(request_id)
                return create_error_response(HTTPStatus.BAD_REQUEST,
                                             "Client disconnected")
            final_res = res
        assert final_res is not None

        choices = []
        role = get_role()
        for output in final_res.outputs:
            choice_data = ChatCompletionResponseChoice(
                index=output.index,
                message=ChatMessage(role=role, content=output.text),
                finish_reason=output.finish_reason,
            )
            choices.append(choice_data)

        if request.echo:
            last_msg_content = ""
            if request.messages and isinstance(
                    request.messages, list) and request.messages[-1].get(
                        "content") and request.messages[-1].get(
                            "role") == role:
                last_msg_content = request.messages[-1]["content"]

            for choice in choices:
                full_message = last_msg_content + choice.message.content
                choice.message.content = full_message

        num_prompt_tokens = len(final_res.prompt_token_ids)
        num_generated_tokens = sum(
            len(output.token_ids) for output in final_res.outputs)
        usage = UsageInfo(
            prompt_tokens=num_prompt_tokens,
            completion_tokens=num_generated_tokens,
            total_tokens=num_prompt_tokens + num_generated_tokens,
        )
        response = ChatCompletionResponse(
            id=request_id,
            created=created_time,
            model=model_name,
            choices=choices,
            usage=usage,
447
448
        )

449
        return response
450

451
    # Streaming response
452
    if request.stream:
453
        return StreamingResponse(completion_stream_generator(),
454
                                 media_type="text/event-stream")
455
456
    else:
        return await completion_full_generator()
457
458


Zhuohan Li's avatar
Zhuohan Li committed
459
@app.post("/v1/completions")
460
async def create_completion(request: CompletionRequest, raw_request: Request):
461
462
463
464
465
466
467
468
    """Completion API similar to OpenAI's API.

    See https://platform.openai.com/docs/api-reference/completions/create
    for the API specification. This API mimics the OpenAI Completion API.

    NOTE: Currently we do not support the following features:
        - suffix (the language models we currently support do not support
          suffix)
Woosuk Kwon's avatar
Woosuk Kwon committed
469
        - logit_bias (to be supported by vLLM engine)
470
    """
Zhuohan Li's avatar
Zhuohan Li committed
471
472
473
474
475

    error_check_ret = await check_model(request)
    if error_check_ret is not None:
        return error_check_ret

476
477
    # OpenAI API supports echoing the prompt when max_tokens is 0.
    echo_without_generation = request.echo and request.max_tokens == 0
Zhuohan Li's avatar
Zhuohan Li committed
478
479
480
481

    if request.suffix is not None:
        # The language models we currently support do not support suffix.
        return create_error_response(HTTPStatus.BAD_REQUEST,
482
                                     "suffix is not currently supported")
Zhuohan Li's avatar
Zhuohan Li committed
483

484
    if request.logit_bias is not None and len(request.logit_bias) > 0:
Woosuk Kwon's avatar
Woosuk Kwon committed
485
        # TODO: support logit_bias in vLLM engine.
Zhuohan Li's avatar
Zhuohan Li committed
486
487
488
489
490
        return create_error_response(HTTPStatus.BAD_REQUEST,
                                     "logit_bias is not currently supported")

    model_name = request.model
    request_id = f"cmpl-{random_uuid()}"
491
492

    use_token_ids = False
493
    if isinstance(request.prompt, list):
494
495
496
        if len(request.prompt) == 0:
            return create_error_response(HTTPStatus.BAD_REQUEST,
                                         "please provide at least one prompt")
497
498
499
500
501
502
503
504
505
506
507
508
        first_element = request.prompt[0]
        if isinstance(first_element, int):
            use_token_ids = True
            prompt = request.prompt
        elif isinstance(first_element, (str, list)):
            # TODO: handles multiple prompt case in list[list[int]]
            if len(request.prompt) > 1:
                return create_error_response(
                    HTTPStatus.BAD_REQUEST,
                    "multiple prompts in a batch is not currently supported")
            use_token_ids = not isinstance(first_element, str)
            prompt = request.prompt[0]
509
510
    else:
        prompt = request.prompt
511

512
513
514
515
    if use_token_ids:
        _, error_check_ret = await check_length(request, prompt_ids=prompt)
    else:
        token_ids, error_check_ret = await check_length(request, prompt=prompt)
516
517
518
    if error_check_ret is not None:
        return error_check_ret

519
    created_time = int(time.monotonic())
Zhuohan Li's avatar
Zhuohan Li committed
520
    try:
521
        spaces_between_special_tokens = request.spaces_between_special_tokens
Zhuohan Li's avatar
Zhuohan Li committed
522
523
524
525
526
        sampling_params = SamplingParams(
            n=request.n,
            best_of=request.best_of,
            presence_penalty=request.presence_penalty,
            frequency_penalty=request.frequency_penalty,
Roy's avatar
Roy committed
527
            repetition_penalty=request.repetition_penalty,
Zhuohan Li's avatar
Zhuohan Li committed
528
529
530
            temperature=request.temperature,
            top_p=request.top_p,
            top_k=request.top_k,
Roy's avatar
Roy committed
531
            min_p=request.min_p,
Zhuohan Li's avatar
Zhuohan Li committed
532
            stop=request.stop,
533
            stop_token_ids=request.stop_token_ids,
Zhuohan Li's avatar
Zhuohan Li committed
534
            ignore_eos=request.ignore_eos,
535
536
            max_tokens=request.max_tokens
            if not echo_without_generation else 1,
Zhuohan Li's avatar
Zhuohan Li committed
537
538
            logprobs=request.logprobs,
            use_beam_search=request.use_beam_search,
539
            prompt_logprobs=request.logprobs if request.echo else None,
540
            skip_special_tokens=request.skip_special_tokens,
541
            spaces_between_special_tokens=spaces_between_special_tokens,
Zhuohan Li's avatar
Zhuohan Li committed
542
543
544
545
        )
    except ValueError as e:
        return create_error_response(HTTPStatus.BAD_REQUEST, str(e))

546
547
548
549
550
551
552
553
    if use_token_ids:
        result_generator = engine.generate(None,
                                           sampling_params,
                                           request_id,
                                           prompt_token_ids=prompt)
    else:
        result_generator = engine.generate(prompt, sampling_params, request_id,
                                           token_ids)
Zhuohan Li's avatar
Zhuohan Li committed
554
555
556

    # Similar to the OpenAI API, when n != best_of, we do not stream the
    # results. In addition, we do not stream the results when use beam search.
557
558
559
    stream = (request.stream
              and (request.best_of is None or request.n == request.best_of)
              and not request.use_beam_search)
Zhuohan Li's avatar
Zhuohan Li committed
560

561
562
563
564
565
    def create_stream_response_json(
        index: int,
        text: str,
        logprobs: Optional[LogProbs] = None,
        finish_reason: Optional[str] = None,
566
        usage: Optional[UsageInfo] = None,
567
    ) -> str:
Zhuohan Li's avatar
Zhuohan Li committed
568
569
570
571
572
573
574
575
576
577
578
579
        choice_data = CompletionResponseStreamChoice(
            index=index,
            text=text,
            logprobs=logprobs,
            finish_reason=finish_reason,
        )
        response = CompletionStreamResponse(
            id=request_id,
            created=created_time,
            model=model_name,
            choices=[choice_data],
        )
580
581
582
        if usage is not None:
            response.usage = usage
        response_json = response.json(exclude_unset=True, ensure_ascii=False)
Zhuohan Li's avatar
Zhuohan Li committed
583
584
585
586
587
588

        return response_json

    async def completion_stream_generator() -> AsyncGenerator[str, None]:
        previous_texts = [""] * request.n
        previous_num_tokens = [0] * request.n
589
        has_echoed = [False] * request.n
Zhuohan Li's avatar
Zhuohan Li committed
590
591
592
593
594
        async for res in result_generator:
            res: RequestOutput
            for output in res.outputs:
                i = output.index
                delta_text = output.text[len(previous_texts[i]):]
595
                token_ids = output.token_ids[previous_num_tokens[i]:]
596
597
598
599
                if request.logprobs is not None:
                    top_logprobs = output.logprobs[previous_num_tokens[i]:]
                else:
                    top_logprobs = None
600
601
602
603
604
                offsets = len(previous_texts[i])
                if request.echo and not has_echoed[i]:
                    if not echo_without_generation:
                        delta_text = res.prompt + delta_text
                        token_ids = res.prompt_token_ids + token_ids
605
606
607
                        if top_logprobs:
                            top_logprobs = res.prompt_logprobs + top_logprobs
                    else:  # only just return the prompt
608
609
                        delta_text = res.prompt
                        token_ids = res.prompt_token_ids
610
611
                        if top_logprobs:
                            top_logprobs = res.prompt_logprobs
612
                    has_echoed[i] = True
Zhuohan Li's avatar
Zhuohan Li committed
613
614
                if request.logprobs is not None:
                    logprobs = create_logprobs(
615
616
617
618
619
                        token_ids=token_ids,
                        top_logprobs=top_logprobs,
                        num_output_top_logprobs=request.logprobs,
                        initial_text_offset=offsets,
                    )
Zhuohan Li's avatar
Zhuohan Li committed
620
621
622
623
                else:
                    logprobs = None
                previous_texts[i] = output.text
                previous_num_tokens[i] = len(output.token_ids)
624
                finish_reason = output.finish_reason
Zhuohan Li's avatar
Zhuohan Li committed
625
626
627
628
                response_json = create_stream_response_json(
                    index=i,
                    text=delta_text,
                    logprobs=logprobs,
629
                    finish_reason=finish_reason,
Zhuohan Li's avatar
Zhuohan Li committed
630
631
632
                )
                yield f"data: {response_json}\n\n"
                if output.finish_reason is not None:
633
634
                    logprobs = (LogProbs()
                                if request.logprobs is not None else None)
635
636
637
638
639
640
641
                    prompt_tokens = len(res.prompt_token_ids)
                    completion_tokens = len(output.token_ids)
                    final_usage = UsageInfo(
                        prompt_tokens=prompt_tokens,
                        completion_tokens=completion_tokens,
                        total_tokens=prompt_tokens + completion_tokens,
                    )
Zhuohan Li's avatar
Zhuohan Li committed
642
643
644
645
646
                    response_json = create_stream_response_json(
                        index=i,
                        text="",
                        logprobs=logprobs,
                        finish_reason=output.finish_reason,
647
                        usage=final_usage,
Zhuohan Li's avatar
Zhuohan Li committed
648
649
                    )
                    yield f"data: {response_json}\n\n"
650
        yield "data: [DONE]\n\n"
Zhuohan Li's avatar
Zhuohan Li committed
651
652
653
654

    # Streaming response
    if stream:
        return StreamingResponse(completion_stream_generator(),
655
                                 media_type="text/event-stream")
Zhuohan Li's avatar
Zhuohan Li committed
656
657
658
659

    # Non-streaming response
    final_res: RequestOutput = None
    async for res in result_generator:
660
661
        if await raw_request.is_disconnected():
            # Abort the request if the client disconnects.
662
            await engine.abort(request_id)
663
664
            return create_error_response(HTTPStatus.BAD_REQUEST,
                                         "Client disconnected")
Zhuohan Li's avatar
Zhuohan Li committed
665
666
667
        final_res = res
    assert final_res is not None
    choices = []
668
669
670
    prompt_token_ids = final_res.prompt_token_ids
    prompt_logprobs = final_res.prompt_logprobs
    prompt_text = final_res.prompt
Zhuohan Li's avatar
Zhuohan Li committed
671
672
    for output in final_res.outputs:
        if request.logprobs is not None:
673
674
675
676
677
678
679
680
681
682
683
684
685
686
            if not echo_without_generation:
                token_ids = output.token_ids
                top_logprobs = output.logprobs
                if request.echo:
                    token_ids = prompt_token_ids + token_ids
                    top_logprobs = prompt_logprobs + top_logprobs
            else:
                token_ids = prompt_token_ids
                top_logprobs = prompt_logprobs
            logprobs = create_logprobs(
                token_ids=token_ids,
                top_logprobs=top_logprobs,
                num_output_top_logprobs=request.logprobs,
            )
Zhuohan Li's avatar
Zhuohan Li committed
687
688
        else:
            logprobs = None
689
690
691
692
693
694
        if not echo_without_generation:
            output_text = output.text
            if request.echo:
                output_text = prompt_text + output_text
        else:
            output_text = prompt_text
Zhuohan Li's avatar
Zhuohan Li committed
695
696
        choice_data = CompletionResponseChoice(
            index=output.index,
697
            text=output_text,
Zhuohan Li's avatar
Zhuohan Li committed
698
699
700
701
702
703
            logprobs=logprobs,
            finish_reason=output.finish_reason,
        )
        choices.append(choice_data)

    num_prompt_tokens = len(final_res.prompt_token_ids)
704
705
    num_generated_tokens = sum(
        len(output.token_ids) for output in final_res.outputs)
Zhuohan Li's avatar
Zhuohan Li committed
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
    usage = UsageInfo(
        prompt_tokens=num_prompt_tokens,
        completion_tokens=num_generated_tokens,
        total_tokens=num_prompt_tokens + num_generated_tokens,
    )
    response = CompletionResponse(
        id=request_id,
        created=created_time,
        model=model_name,
        choices=choices,
        usage=usage,
    )

    if request.stream:
        # When user requests streaming but we don't stream, we still need to
        # return a streaming response with a single event.
        response_json = response.json(ensure_ascii=False)
723

Zhuohan Li's avatar
Zhuohan Li committed
724
725
726
        async def fake_stream_generator() -> AsyncGenerator[str, None]:
            yield f"data: {response_json}\n\n"
            yield "data: [DONE]\n\n"
727

Zhuohan Li's avatar
Zhuohan Li committed
728
729
730
731
732
733
734
        return StreamingResponse(fake_stream_generator(),
                                 media_type="text/event-stream")

    return response


if __name__ == "__main__":
735
    args = parse_args()
Zhuohan Li's avatar
Zhuohan Li committed
736
737
738
739
740
741
742
743
744
745
746

    app.add_middleware(
        CORSMiddleware,
        allow_origins=args.allowed_origins,
        allow_credentials=args.allow_credentials,
        allow_methods=args.allowed_methods,
        allow_headers=args.allowed_headers,
    )

    logger.info(f"args: {args}")

747
748
749
750
751
    if args.served_model_name is not None:
        served_model = args.served_model_name
    else:
        served_model = args.model

752
753
    response_role = args.response_role

Zhuohan Li's avatar
Zhuohan Li committed
754
    engine_args = AsyncEngineArgs.from_cli_args(args)
755
    engine = AsyncLLMEngine.from_engine_args(engine_args)
756
    engine_model_config = asyncio.run(engine.get_model_config())
757
    max_model_len = engine_model_config.max_model_len
Zhuohan Li's avatar
Zhuohan Li committed
758
759

    # A separate tokenizer to map token IDs to strings.
760
761
762
763
    tokenizer = get_tokenizer(
        engine_model_config.tokenizer,
        tokenizer_mode=engine_model_config.tokenizer_mode,
        trust_remote_code=engine_model_config.trust_remote_code)
764
    load_chat_template(args, tokenizer)
Zhuohan Li's avatar
Zhuohan Li committed
765

766
767
768
    # Register labels for metrics
    add_global_metrics_labels(model_name=engine_args.model)

769
770
771
772
    uvicorn.run(app,
                host=args.host,
                port=args.port,
                log_level="info",
773
774
775
                timeout_keep_alive=TIMEOUT_KEEP_ALIVE,
                ssl_keyfile=args.ssl_keyfile,
                ssl_certfile=args.ssl_certfile)