serving.py 8.07 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4

from http import HTTPStatus
zhuwenwen's avatar
zhuwenwen committed
5
from typing import cast
6

7
import jinja2
8
9
10
11
import numpy as np
from fastapi import Request

from vllm.engine.protocol import EngineClient
12
from vllm.entrypoints.chat_utils import ChatTemplateContentFormatOption
13
from vllm.entrypoints.logger import RequestLogger
zhuwenwen's avatar
zhuwenwen committed
14
15
16
17
18
19
20
21
22
23
24
25
from vllm.entrypoints.openai.chat_completion.protocol import (
    ChatCompletionRequest,
)
from vllm.entrypoints.openai.engine.protocol import (
    ErrorResponse,
    UsageInfo,
)
from vllm.entrypoints.openai.engine.serving import (
    ClassificationServeContext,
    OpenAIServing,
    ServeContext,
)
26
from vllm.entrypoints.openai.models.serving import OpenAIServingModels
27
28
29
30
31
32
33
from vllm.entrypoints.pooling.classify.protocol import (
    ClassificationChatRequest,
    ClassificationCompletionRequest,
    ClassificationData,
    ClassificationRequest,
    ClassificationResponse,
)
34
from vllm.entrypoints.renderer import RenderConfig
35
36
from vllm.logger import init_logger
from vllm.outputs import ClassificationOutput, PoolingRequestOutput
37
from vllm.pooling_params import PoolingParams
38
39
40
41

logger = init_logger(__name__)


zhuwenwen's avatar
zhuwenwen committed
42
43
44
45
class ClassificationMixin(OpenAIServing):
    chat_template: str | None
    chat_template_content_format: ChatTemplateContentFormatOption
    trust_request_chat_template: bool
46

47
48
    async def _preprocess(
        self,
zhuwenwen's avatar
zhuwenwen committed
49
        ctx: ServeContext,
50
    ) -> ErrorResponse | None:
51
52
53
54
        """
        Process classification inputs: tokenize text, resolve adapters,
        and prepare model-specific inputs.
        """
zhuwenwen's avatar
zhuwenwen committed
55
        ctx = cast(ClassificationServeContext, ctx)
56
        try:
zhuwenwen's avatar
zhuwenwen committed
57
58
59
60
61
62
63
64
65
            request_obj = ctx.request

            if isinstance(request_obj, ClassificationChatRequest):
                chat_request = request_obj
                messages = chat_request.messages
                trust_request_chat_template = getattr(
                    self,
                    "trust_request_chat_template",
                    False,
66
                )
zhuwenwen's avatar
zhuwenwen committed
67
68
69
70
71
72
73
                ret = self._validate_chat_template(
                    request_chat_template=chat_request.chat_template,
                    chat_template_kwargs=chat_request.chat_template_kwargs,
                    trust_request_chat_template=trust_request_chat_template,
                )
                if ret:
                    return ret
74

75
                _, engine_prompts = await self._preprocess_chat(
zhuwenwen's avatar
zhuwenwen committed
76
                    cast(ChatCompletionRequest, chat_request),
77
                    self.renderer,
zhuwenwen's avatar
zhuwenwen committed
78
79
80
81
82
83
84
85
86
87
88
89
                    messages,
                    chat_template=(
                        chat_request.chat_template
                        or getattr(self, "chat_template", None)
                    ),
                    chat_template_content_format=cast(
                        ChatTemplateContentFormatOption,
                        getattr(self, "chat_template_content_format", "auto"),
                    ),
                    add_generation_prompt=chat_request.add_generation_prompt,
                    continue_final_message=chat_request.continue_final_message,
                    add_special_tokens=chat_request.add_special_tokens,
90
91
92
                )
                ctx.engine_prompts = engine_prompts

zhuwenwen's avatar
zhuwenwen committed
93
94
95
            elif isinstance(request_obj, ClassificationCompletionRequest):
                completion_request = request_obj
                input_data = completion_request.input
96
97
98
99
100
101
102
103
104
                if input_data in (None, ""):
                    return self.create_error_response(
                        "Input or messages must be provided",
                        status_code=HTTPStatus.BAD_REQUEST,
                    )
                if isinstance(input_data, list) and not input_data:
                    ctx.engine_prompts = []
                    return None

105
                renderer = self._get_completion_renderer()
106
107
108
                prompt_input = cast(str | list[str], input_data)
                ctx.engine_prompts = await renderer.render_prompt(
                    prompt_or_prompts=prompt_input,
zhuwenwen's avatar
zhuwenwen committed
109
                    config=self._build_render_config(completion_request),
110
111
                )
            else:
zhuwenwen's avatar
zhuwenwen committed
112
113
114
115
                return self.create_error_response(
                    "Invalid classification request type",
                    status_code=HTTPStatus.BAD_REQUEST,
                )
116
117
118

            return None

119
        except (ValueError, TypeError, jinja2.TemplateError) as e:
120
121
122
123
124
            logger.exception("Error in preprocessing prompt inputs")
            return self.create_error_response(str(e))

    def _build_response(
        self,
zhuwenwen's avatar
zhuwenwen committed
125
        ctx: ServeContext,
126
    ) -> ClassificationResponse | ErrorResponse:
127
128
129
130
        """
        Convert model outputs to a formatted classification response
        with probabilities and labels.
        """
zhuwenwen's avatar
zhuwenwen committed
131
        ctx = cast(ClassificationServeContext, ctx)
132
133
134
        items: list[ClassificationData] = []
        num_prompt_tokens = 0

135
        final_res_batch_checked = cast(list[PoolingRequestOutput], ctx.final_res_batch)
136
137
138
139
140
141

        for idx, final_res in enumerate(final_res_batch_checked):
            classify_res = ClassificationOutput.from_base(final_res.outputs)

            probs = classify_res.probs
            predicted_index = int(np.argmax(probs))
zhuwenwen's avatar
zhuwenwen committed
142
143
144
            label = getattr(self.model_config.hf_config, "id2label", {}).get(
                predicted_index
            )
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

            item = ClassificationData(
                index=idx,
                label=label,
                probs=probs,
                num_classes=len(probs),
            )

            items.append(item)
            prompt_token_ids = final_res.prompt_token_ids
            num_prompt_tokens += len(prompt_token_ids)

        usage = UsageInfo(
            prompt_tokens=num_prompt_tokens,
            total_tokens=num_prompt_tokens,
        )

        return ClassificationResponse(
            id=ctx.request_id,
            created=ctx.created_time,
            model=ctx.model_name,
            data=items,
            usage=usage,
        )

170
    def _build_render_config(self, request: ClassificationRequest) -> RenderConfig:
171
172
        return RenderConfig(
            max_length=self.max_model_len,
173
            truncate_prompt_tokens=request.truncate_prompt_tokens,
174
            add_special_tokens=request.add_special_tokens,
175
        )
176

zhuwenwen's avatar
zhuwenwen committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

class ServingClassification(ClassificationMixin):
    request_id_prefix = "classify"

    def __init__(
        self,
        engine_client: EngineClient,
        models: OpenAIServingModels,
        *,
        request_logger: RequestLogger | None,
        chat_template: str | None = None,
        chat_template_content_format: ChatTemplateContentFormatOption = "auto",
        trust_request_chat_template: bool = False,
        log_error_stack: bool = False,
    ) -> None:
        super().__init__(
            engine_client=engine_client,
            models=models,
            request_logger=request_logger,
            log_error_stack=log_error_stack,
        )

        self.chat_template = chat_template
        self.chat_template_content_format = chat_template_content_format
        self.trust_request_chat_template = trust_request_chat_template

203
204
205
206
    async def create_classify(
        self,
        request: ClassificationRequest,
        raw_request: Request,
207
    ) -> ClassificationResponse | ErrorResponse:
208
        model_name = self.models.model_name()
209
        request_id = f"{self.request_id_prefix}-{self._base_request_id(raw_request)}"
210
211
212
213
214
215
216
217

        ctx = ClassificationServeContext(
            request=request,
            raw_request=raw_request,
            model_name=model_name,
            request_id=request_id,
        )

zhuwenwen's avatar
zhuwenwen committed
218
        return await super().handle(ctx)  # type: ignore
219
220
221

    def _create_pooling_params(
        self,
zhuwenwen's avatar
zhuwenwen committed
222
        ctx: ServeContext[ClassificationRequest],
223
    ) -> PoolingParams | ErrorResponse:
224
225
226
227
228
229
230
231
232
        pooling_params = super()._create_pooling_params(ctx)
        if isinstance(pooling_params, ErrorResponse):
            return pooling_params

        try:
            pooling_params.verify("classify", self.model_config)
        except ValueError as e:
            return self.create_error_response(str(e))

zhuwenwen's avatar
zhuwenwen committed
233
        return pooling_params