llm_engine.py 92.7 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

3
import os
4
import copy
Antoni Baum's avatar
Antoni Baum committed
5
import time
6
from collections import Counter as collectionsCounter
7
from collections import deque
8
from contextlib import contextmanager
9
from dataclasses import dataclass
10
from functools import partial
11
12
from typing import (TYPE_CHECKING, Any, Callable, ClassVar, Deque, Dict,
                    Iterable, List, Mapping, NamedTuple, Optional)
13
from typing import Sequence as GenericSequence
14
from typing import Set, Type, Union, cast, overload
15

16
import torch
17
from typing_extensions import TypeVar, deprecated
18

19
import vllm.envs as envs
20
21
22
from vllm.config import (DecodingConfig, LoRAConfig, ModelConfig,
                         ObservabilityConfig, ParallelConfig, SchedulerConfig,
                         VllmConfig)
23
from vllm.core.scheduler import ScheduledSequenceGroup, SchedulerOutputs
Woosuk Kwon's avatar
Woosuk Kwon committed
24
from vllm.engine.arg_utils import EngineArgs
25
from vllm.engine.metrics_types import StatLoggerBase, Stats
26
27
28
29
from vllm.engine.output_processor.interfaces import (
    SequenceGroupOutputProcessor)
from vllm.engine.output_processor.stop_checker import StopChecker
from vllm.engine.output_processor.util import create_output_by_sequence_group
30
31
from vllm.entrypoints.openai.logits_processors import (
    get_logits_processors as get_openai_logits_processors)
32
from vllm.executor.executor_base import ExecutorBase
33
from vllm.inputs import (INPUT_REGISTRY, InputRegistry, ProcessorInputs,
34
35
                         PromptType)
from vllm.inputs.parse import is_token_prompt, split_enc_dec_inputs
36
from vllm.inputs.preprocess import InputPreprocessor
Woosuk Kwon's avatar
Woosuk Kwon committed
37
from vllm.logger import init_logger
38
from vllm.logits_process import get_bad_words_logits_processors
39
from vllm.lora.request import LoRARequest
40
41
from vllm.model_executor.guided_decoding import (
    get_local_guided_decoding_logits_processor)
42
from vllm.model_executor.layers.sampler import SamplerOutput
43
from vllm.multimodal import MULTIMODAL_REGISTRY, MultiModalRegistry
44
from vllm.outputs import (PoolingRequestOutput, RequestOutput,
45
46
                          RequestOutputFactory)
from vllm.pooling_params import PoolingParams
47
from vllm.prompt_adapter.request import PromptAdapterRequest
48
from vllm.sampling_params import RequestOutputKind, SamplingParams
49
50
51
from vllm.sequence import (ExecuteModelRequest, ParallelSampleSequenceGroup,
                           PoolingSequenceGroupOutput, Sequence, SequenceGroup,
                           SequenceGroupBase, SequenceGroupMetadata,
zhuwenwen's avatar
zhuwenwen committed
52
                           SequenceGroupOutput, SequenceStatus, CompletionSequenceGroupOutput, VLLM_INVALID_TOKEN_ID)
53
54
from vllm.tracing import (SpanAttributes, SpanKind, extract_trace_context,
                          init_tracer)
55
from vllm.transformers_utils.detokenizer import Detokenizer
56
from vllm.transformers_utils.tokenizer import AnyTokenizer
57
from vllm.transformers_utils.tokenizer_group import (
58
    BaseTokenizerGroup, init_tokenizer_from_configs)
yhu422's avatar
yhu422 committed
59
60
from vllm.usage.usage_lib import (UsageContext, is_usage_stats_enabled,
                                  usage_message)
61
62
from vllm.utils import (Counter, Device, deprecate_kwargs,
                        resolve_obj_by_qualname, weak_bind)
63
from vllm.version import __version__ as VLLM_VERSION
64
from vllm.worker.model_runner_base import InputProcessingError
65
66

logger = init_logger(__name__)
67
_LOCAL_LOGGING_INTERVAL_SEC = 5
Woosuk Kwon's avatar
Woosuk Kwon committed
68

69
_G = TypeVar("_G", bound=BaseTokenizerGroup, default=BaseTokenizerGroup)
70
_O = TypeVar("_O", RequestOutput, PoolingRequestOutput)
71
_R = TypeVar("_R", default=Any)
72
73


74
75
76
77
78
@dataclass
class SchedulerOutputState:
    """Caches the scheduler outputs for a virtual engine. Used for Multi-Step"""
    seq_group_metadata_list: Optional[List[SequenceGroupMetadata]] = None
    scheduler_outputs: Optional[SchedulerOutputs] = None
79
80
    allow_async_output_proc: bool = False
    last_output: Optional[SamplerOutput] = None
81
82


83
84
85
86
87
88
class OutputData(NamedTuple):
    outputs: List[SamplerOutput]
    seq_group_metadata_list: List[SequenceGroupMetadata]
    scheduler_outputs: SchedulerOutputs
    is_async: bool
    is_last_step: bool
89
90
91
92
93
94
    # Indicates if this output is from the first step of the
    # multi-step. When multi-step is disabled, this is always
    # set to True.
    # is_first_step_output is invalid when `outputs` has
    # outputs from multiple steps.
    is_first_step_output: Optional[bool]
95
96
97
    skip: List[int]


98
class SchedulerContext:
99

100
    def __init__(self, multi_step_stream_outputs: bool = False):
101
102
        self.output_queue: Deque[OutputData] = deque()
        self.request_outputs: List[Union[RequestOutput,
103
                                         PoolingRequestOutput]] = []
104
105
106
107
        self.seq_group_metadata_list: Optional[
            List[SequenceGroupMetadata]] = None
        self.scheduler_outputs: Optional[SchedulerOutputs] = None

108
109
        self.multi_step_stream_outputs: bool = multi_step_stream_outputs

110
111
112
    def append_output(self, outputs: List[SamplerOutput],
                      seq_group_metadata_list: List[SequenceGroupMetadata],
                      scheduler_outputs: SchedulerOutputs, is_async: bool,
113
114
                      is_last_step: bool,
                      is_first_step_output: Optional[bool]):
115
116
117
118
119
120
        self.output_queue.append(
            OutputData(outputs=outputs,
                       seq_group_metadata_list=seq_group_metadata_list,
                       scheduler_outputs=scheduler_outputs,
                       is_async=is_async,
                       is_last_step=is_last_step,
121
                       is_first_step_output=is_first_step_output,
122
                       skip=[]))
123
124


125
class LLMEngine:
Zhuohan Li's avatar
Zhuohan Li committed
126
    """An LLM engine that receives requests and generates texts.
127

Woosuk Kwon's avatar
Woosuk Kwon committed
128
    This is the main class for the vLLM engine. It receives requests
129
130
131
132
133
134
    from clients and generates texts from the LLM. It includes a tokenizer, a
    language model (possibly distributed across multiple GPUs), and GPU memory
    space allocated for intermediate states (aka KV cache). This class utilizes
    iteration-level scheduling and efficient memory management to maximize the
    serving throughput.

135
136
    The :class:`~vllm.LLM` class wraps this class for offline batched inference
    and the :class:`AsyncLLMEngine` class wraps this class for online serving.
137

138
    The config arguments are derived from :class:`~vllm.EngineArgs`. (See
139
    :ref:`engine-args`)
140
141
142
143
144
145
146

    Args:
        model_config: The configuration related to the LLM model.
        cache_config: The configuration related to the KV cache memory
            management.
        parallel_config: The configuration related to distributed execution.
        scheduler_config: The configuration related to the request scheduler.
147
        device_config: The configuration related to the device.
148
149
150
        lora_config (Optional): The configuration related to serving multi-LoRA.
        speculative_config (Optional): The configuration related to speculative
            decoding.
151
152
        executor_class: The model executor class for managing distributed
            execution.
153
        prompt_adapter_config (Optional): The configuration related to serving
154
            prompt adapters.
155
        log_stats: Whether to log statistics.
156
        usage_context: Specified entry point, used for usage info collection.
157
    """
158

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
    DO_VALIDATE_OUTPUT: ClassVar[bool] = False
    """A flag to toggle whether to validate the type of request output."""

    @classmethod
    @contextmanager
    def enable_output_validation(cls):
        cls.DO_VALIDATE_OUTPUT = True

        yield

        cls.DO_VALIDATE_OUTPUT = False

    @classmethod
    def validate_output(
        cls,
        output: object,
        output_type: Type[_O],
    ) -> _O:
        do_validate = cls.DO_VALIDATE_OUTPUT

        if ((TYPE_CHECKING or do_validate)
                and not isinstance(output, output_type)):
            raise TypeError(f"Expected output of type {output_type}, "
                            f"but found type {type(output)}")

184
        return cast(_O, output)
185
186
187

    @classmethod
    def validate_outputs(
zhuwenwen's avatar
zhuwenwen committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
        cls,
        outputs: GenericSequence[object],
        output_type: Type[_O],
    ) -> List[_O]:
        do_validate = cls.DO_VALIDATE_OUTPUT

        outputs_: List[_O]
        if TYPE_CHECKING or do_validate:
            outputs_ = []
            for output in outputs:
                if not isinstance(output, output_type):
                    raise TypeError(f"Expected output of type {output_type}, "
                                    f"but found type {type(output)}")

                outputs_.append(output)
        else:
            outputs_ = outputs

206
207
208
209
        return outputs_

    tokenizer: Optional[BaseTokenizerGroup]

210
211
    def __init__(
        self,
212
        vllm_config: VllmConfig,
213
        executor_class: Type[ExecutorBase],
214
        log_stats: bool,
yhu422's avatar
yhu422 committed
215
        usage_context: UsageContext = UsageContext.ENGINE_CONTEXT,
216
        stat_loggers: Optional[Dict[str, StatLoggerBase]] = None,
217
        input_registry: InputRegistry = INPUT_REGISTRY,
218
        mm_registry: MultiModalRegistry = MULTIMODAL_REGISTRY,
219
        use_cached_outputs: bool = False,
220
    ) -> None:
221
222
223
224
225
226
        if envs.VLLM_USE_V1:
            raise ValueError(
                "Using V0 LLMEngine, but envs.VLLM_USE_V1=True. "
                "This should not happen. As a workaround, try using "
                "LLMEngine.from_vllm_config(...) or explicitly set "
                "VLLM_USE_V1=0 or 1 and report this issue on Github.")
227

228
        self.vllm_config = vllm_config
229
230
231
232
233
234
235
236
237
        self.model_config = vllm_config.model_config
        self.cache_config = vllm_config.cache_config
        self.lora_config = vllm_config.lora_config
        self.parallel_config = vllm_config.parallel_config
        self.scheduler_config = vllm_config.scheduler_config
        self.device_config = vllm_config.device_config
        self.speculative_config = vllm_config.speculative_config  # noqa
        self.load_config = vllm_config.load_config
        self.decoding_config = vllm_config.decoding_config or DecodingConfig(  # noqa
238
        )
239
240
        self.prompt_adapter_config = vllm_config.prompt_adapter_config  # noqa
        self.observability_config = vllm_config.observability_config or ObservabilityConfig(  # noqa
241
242
        )

243
        logger.info(
244
            "Initializing a V0 LLM engine (v%s) with config: %s, "
245
            "use_cached_outputs=%s, ",
246
            VLLM_VERSION,
247
            vllm_config,
248
            use_cached_outputs,
249
        )
250

251
        self.log_stats = log_stats
252
        self.use_cached_outputs = use_cached_outputs
253

254
        if not self.model_config.skip_tokenizer_init:
255
            self.tokenizer = self._init_tokenizer()
256
            self.detokenizer = Detokenizer(self.tokenizer)
257
            tokenizer_group = self.get_tokenizer_group()
258
259
        else:
            self.tokenizer = None
260
            self.detokenizer = None
261
262
263
264
265
266
267
268
            tokenizer_group = None

        # Ensure that the function doesn't contain a reference to self,
        # to avoid engine GC issues
        def get_tokenizer_for_seq(sequence: Sequence) -> AnyTokenizer:
            assert tokenizer_group, ("tokenizer_group cannot be None, "
                                     "make sure skip_tokenizer_init is False")
            return tokenizer_group.get_lora_tokenizer(sequence.lora_request)
269

270
        self.seq_counter = Counter()
271
272
        self.generation_config_fields = (
            self.model_config.try_get_generation_config())
273

274
        self.input_preprocessor = InputPreprocessor(self.model_config,
275
276
                                                    self.tokenizer,
                                                    mm_registry)
277

278
279
        self.input_registry = input_registry
        self.input_processor = input_registry.create_input_processor(
280
            self.model_config)
281

282
        self.model_executor = executor_class(vllm_config=vllm_config, )
283

284
        if self.model_config.runner_type != "pooling":
285
            self._initialize_kv_caches()
286

yhu422's avatar
yhu422 committed
287
288
        # If usage stat is enabled, collect relevant info.
        if is_usage_stats_enabled():
289
290
            from vllm.model_executor.model_loader import (
                get_architecture_class_name)
yhu422's avatar
yhu422 committed
291
            usage_message.report_usage(
292
                get_architecture_class_name(self.model_config),
yhu422's avatar
yhu422 committed
293
294
295
296
                usage_context,
                extra_kvs={
                    # Common configuration
                    "dtype":
297
                    str(self.model_config.dtype),
yhu422's avatar
yhu422 committed
298
                    "tensor_parallel_size":
299
                    self.parallel_config.tensor_parallel_size,
yhu422's avatar
yhu422 committed
300
                    "block_size":
301
                    self.cache_config.block_size,
yhu422's avatar
yhu422 committed
302
                    "gpu_memory_utilization":
303
                    self.cache_config.gpu_memory_utilization,
yhu422's avatar
yhu422 committed
304
305
306

                    # Quantization
                    "quantization":
307
                    self.model_config.quantization,
yhu422's avatar
yhu422 committed
308
                    "kv_cache_dtype":
309
                    str(self.cache_config.cache_dtype),
yhu422's avatar
yhu422 committed
310
311
312

                    # Feature flags
                    "enable_lora":
313
                    bool(self.lora_config),
314
                    "enable_prompt_adapter":
315
                    bool(self.prompt_adapter_config),
yhu422's avatar
yhu422 committed
316
                    "enable_prefix_caching":
317
                    self.cache_config.enable_prefix_caching,
yhu422's avatar
yhu422 committed
318
                    "enforce_eager":
319
                    self.model_config.enforce_eager,
yhu422's avatar
yhu422 committed
320
                    "disable_custom_all_reduce":
321
                    self.parallel_config.disable_custom_all_reduce,
yhu422's avatar
yhu422 committed
322
                })
zhuwenwen's avatar
zhuwenwen committed
323

324
325
326
327
        if self.tokenizer:
            # Ping the tokenizer to ensure liveness if it runs in a
            # different process.
            self.tokenizer.ping()
328

329
330
331
332
333
334
        self.cached_scheduler_outputs = [
            SchedulerOutputState()
            for _ in range(self.parallel_config.pipeline_parallel_size)
        ]

        self.scheduler_contexts = [
335
336
            SchedulerContext(multi_step_stream_outputs=self.scheduler_config.
                             multi_step_stream_outputs)
337
338
339
            for _ in range(self.parallel_config.pipeline_parallel_size)
        ]

340
        if self.model_config.use_async_output_proc:
341
            process_model_outputs = weak_bind(self._process_model_outputs)
zhuwenwen's avatar
zhuwenwen committed
342
343

            self.async_callbacks = [
344
345
                partial(process_model_outputs,
                        ctx=self.scheduler_contexts[v_id])
zhuwenwen's avatar
zhuwenwen committed
346
347
                for v_id in range(self.parallel_config.pipeline_parallel_size)
            ]
348
349
        else:
            self.async_callbacks = []
350
351
352

        # Currently used by AsyncLLMEngine to ensure quick append
        # of request outputs to asyncio queues
353
        self.process_request_outputs_callback: Optional[Callable] = None
354

355
        # Create the scheduler.
356
357
        # NOTE: the cache_config here have been updated with the numbers of
        # GPU and CPU blocks, which are profiled in the distributed executor.
358
359
360
361
362
        if isinstance(self.vllm_config.scheduler_config.scheduler_cls, str):
            Scheduler = resolve_obj_by_qualname(
                self.vllm_config.scheduler_config.scheduler_cls)
        else:
            Scheduler = self.vllm_config.scheduler_config.scheduler_cls
363
        self.scheduler = [
364
            Scheduler(
365
366
                self.scheduler_config, self.cache_config, self.lora_config,
                self.parallel_config.pipeline_parallel_size,
367
                self.async_callbacks[v_id]
368
369
                if self.model_config.use_async_output_proc else None)
            for v_id in range(self.parallel_config.pipeline_parallel_size)
370
        ]
zhuwenwen's avatar
zhuwenwen committed
371

372
373
        # Metric Logging.
        if self.log_stats:
374
375
376
            if stat_loggers is not None:
                self.stat_loggers = stat_loggers
            else:
377
378
379
380
381
382
383
                # 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 vllm.engine.metrics import (LoggingStatLogger,
                                                 PrometheusStatLogger)

384
385
386
                self.stat_loggers = {
                    "logging":
                    LoggingStatLogger(
387
388
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC,
                        vllm_config=vllm_config),
389
390
391
                    "prometheus":
                    PrometheusStatLogger(
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC,
392
393
                        labels=dict(
                            model_name=self.model_config.served_model_name),
394
                        vllm_config=vllm_config),
395
396
397
                }
                self.stat_loggers["prometheus"].info("cache_config",
                                                     self.cache_config)
398

399
400
401
402
403
404
        self.tracer = None
        if self.observability_config.otlp_traces_endpoint:
            self.tracer = init_tracer(
                "vllm.llm_engine",
                self.observability_config.otlp_traces_endpoint)

405
406
407
408
409
410
411
412
        # Create sequence output processor, e.g. for beam search or
        # speculative decoding.
        self.output_processor = (
            SequenceGroupOutputProcessor.create_output_processor(
                self.scheduler_config,
                self.detokenizer,
                self.scheduler,
                self.seq_counter,
413
                get_tokenizer_for_seq,
414
415
                stop_checker=StopChecker(
                    self.scheduler_config.max_model_len,
416
                    get_tokenizer_for_seq,
417
418
                ),
            ))
419
420
        
        self.tree_decoding = os.environ.get('VLLM_TREE_DECODING') == '1'
421

422
423
        self.seq_id_to_seq_group: Dict[str, SequenceGroupBase] = {}

424
425
426
427
        # Flag to set when an input fails to process and the engine should run
        # the next step without re-scheduling.
        self._skip_scheduling_next_step = False

428
429
430
431
432
433
    def _initialize_kv_caches(self) -> None:
        """Initialize the KV cache in the worker(s).

        The workers will determine the number of blocks in both the GPU cache
        and the swap CPU cache.
        """
434
        start = time.time()
435
436
437
438
439
        num_gpu_blocks, num_cpu_blocks = (
            self.model_executor.determine_num_available_blocks())

        if self.cache_config.num_gpu_blocks_override is not None:
            num_gpu_blocks_override = self.cache_config.num_gpu_blocks_override
440
441
442
443
            logger.info(
                "Overriding num_gpu_blocks=%d with "
                "num_gpu_blocks_override=%d", num_gpu_blocks,
                num_gpu_blocks_override)
444
445
446
447
448
449
            num_gpu_blocks = num_gpu_blocks_override

        self.cache_config.num_gpu_blocks = num_gpu_blocks
        self.cache_config.num_cpu_blocks = num_cpu_blocks

        self.model_executor.initialize_cache(num_gpu_blocks, num_cpu_blocks)
450
451
452
        elapsed = time.time() - start
        logger.info(("init engine (profile, create kv cache, "
                     "warmup model) took %.2f seconds"), elapsed)
453

454
    @classmethod
455
    def _get_executor_cls(cls,
456
                          engine_config: VllmConfig) -> Type[ExecutorBase]:
457
        # distributed_executor_backend must be set in VllmConfig.__post_init__
458
459
        distributed_executor_backend = (
            engine_config.parallel_config.distributed_executor_backend)
460
        # Initialize the cluster and specify the executor class.
461
462
463
464
465
466
        if isinstance(distributed_executor_backend, type):
            if not issubclass(distributed_executor_backend, ExecutorBase):
                raise TypeError(
                    "distributed_executor_backend must be a subclass of "
                    f"ExecutorBase. Got {distributed_executor_backend}.")
            executor_class = distributed_executor_backend
467
468
469
470
471
472
473
474
475
476
477
478
479
        elif distributed_executor_backend == "ray":
            from vllm.executor.ray_distributed_executor import (
                RayDistributedExecutor)
            executor_class = RayDistributedExecutor
        elif distributed_executor_backend == "mp":
            from vllm.executor.mp_distributed_executor import (
                MultiprocessingDistributedExecutor)
            assert not envs.VLLM_USE_RAY_SPMD_WORKER, (
                "multiprocessing distributed executor backend does not "
                "support VLLM_USE_RAY_SPMD_WORKER=1")
            executor_class = MultiprocessingDistributedExecutor
        elif distributed_executor_backend == "uni":
            # JAX-style, single-process, multi-device executor.
480
481
            from vllm.executor.uniproc_executor import UniProcExecutor
            executor_class = UniProcExecutor
482
483
484
485
486
487
488
489
        elif distributed_executor_backend == "external_launcher":
            # executor with external launcher
            from vllm.executor.uniproc_executor import (  # noqa
                ExecutorWithExternalLauncher)
            executor_class = ExecutorWithExternalLauncher
        else:
            raise ValueError("unrecognized distributed_executor_backend: "
                             f"{distributed_executor_backend}")
490
491
        return executor_class

492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
    @classmethod
    def from_vllm_config(
        cls,
        vllm_config: VllmConfig,
        usage_context: UsageContext = UsageContext.ENGINE_CONTEXT,
        stat_loggers: Optional[Dict[str, StatLoggerBase]] = None,
        disable_log_stats: bool = False,
    ) -> "LLMEngine":
        return cls(
            vllm_config=vllm_config,
            executor_class=cls._get_executor_cls(vllm_config),
            log_stats=(not disable_log_stats),
            usage_context=usage_context,
            stat_loggers=stat_loggers,
        )

508
509
510
511
512
513
514
515
516
    @classmethod
    def from_engine_args(
        cls,
        engine_args: EngineArgs,
        usage_context: UsageContext = UsageContext.ENGINE_CONTEXT,
        stat_loggers: Optional[Dict[str, StatLoggerBase]] = None,
    ) -> "LLMEngine":
        """Creates an LLM engine from the engine arguments."""
        # Create the engine configs.
517
518
519
520
521
522
523
524
525
        vllm_config = engine_args.create_engine_config(usage_context)

        engine_cls = cls
        if envs.VLLM_USE_V1:
            from vllm.v1.engine.llm_engine import LLMEngine as V1LLMEngine
            engine_cls = V1LLMEngine

        return engine_cls.from_vllm_config(
            vllm_config=vllm_config,
yhu422's avatar
yhu422 committed
526
            usage_context=usage_context,
527
            stat_loggers=stat_loggers,
528
            disable_log_stats=engine_args.disable_log_stats,
yhu422's avatar
yhu422 committed
529
        )
530

531
532
533
534
535
    def __reduce__(self):
        # This is to ensure that the LLMEngine is not referenced in
        # the closure used to initialize Ray worker actors
        raise RuntimeError("LLMEngine should not be pickled!")

536
537
538
539
540
541
    def __del__(self):
        # Shutdown model executor when engine is garbage collected
        # Use getattr since __init__ can fail before the field is set
        if model_executor := getattr(self, "model_executor", None):
            model_executor.shutdown()

542
    def get_tokenizer_group(
543
544
545
546
547
548
        self,
        group_type: Type[_G] = BaseTokenizerGroup,
    ) -> _G:
        tokenizer_group = self.tokenizer

        if tokenizer_group is None:
549
550
            raise ValueError("Unable to get tokenizer because "
                             "skip_tokenizer_init is True")
551
552
553
554
        if not isinstance(tokenizer_group, group_type):
            raise TypeError("Invalid type of tokenizer group. "
                            f"Expected type: {group_type}, but "
                            f"found type: {type(tokenizer_group)}")
555

556
        return tokenizer_group
557

558
    def get_tokenizer(
559
560
561
        self,
        lora_request: Optional[LoRARequest] = None,
    ) -> AnyTokenizer:
562
        return self.get_tokenizer_group().get_lora_tokenizer(lora_request)
563

564
565
566
567
568
    def _init_tokenizer(self) -> BaseTokenizerGroup:
        return init_tokenizer_from_configs(
            model_config=self.model_config,
            scheduler_config=self.scheduler_config,
            parallel_config=self.parallel_config,
569
            lora_config=self.lora_config)
570

571
572
    def _verify_args(self) -> None:
        self.model_config.verify_with_parallel_config(self.parallel_config)
573
        self.cache_config.verify_with_parallel_config(self.parallel_config)
574
575
576
577
        if self.lora_config:
            self.lora_config.verify_with_model_config(self.model_config)
            self.lora_config.verify_with_scheduler_config(
                self.scheduler_config)
578
579
580
        if self.prompt_adapter_config:
            self.prompt_adapter_config.verify_with_model_config(
                self.model_config)
581

582
583
584
    def _add_processed_request(
        self,
        request_id: str,
585
        processed_inputs: ProcessorInputs,
586
587
588
        params: Union[SamplingParams, PoolingParams],
        arrival_time: float,
        lora_request: Optional[LoRARequest],
589
        prompt_adapter_request: Optional[PromptAdapterRequest],
590
        trace_headers: Optional[Mapping[str, str]] = None,
591
        priority: int = 0,
592
    ) -> Optional[SequenceGroup]:
593
594
595
        """Add a processed request to the engine's request pool.
        return the created sequence group.
        """
596
597
598
599
600
601
602
603
604
605
606
607
608
609
        if isinstance(params, SamplingParams) and params.n > 1:
            ParallelSampleSequenceGroup.add_request(
                request_id,
                self,
                params,
                processed_inputs=processed_inputs,
                arrival_time=arrival_time,
                lora_request=lora_request,
                trace_headers=trace_headers,
                prompt_adapter_request=prompt_adapter_request,
                priority=priority,
            )
            return None

610
        self._validate_model_inputs(processed_inputs, lora_request)
611
612
613
        # Create the sequences.
        block_size = self.cache_config.block_size
        seq_id = next(self.seq_counter)
614
        eos_token_id = self.input_preprocessor.get_eos_token_id(lora_request)
615

616
        encoder_inputs, decoder_inputs = split_enc_dec_inputs(processed_inputs)
617
618

        seq = Sequence(seq_id, decoder_inputs, block_size, eos_token_id,
619
                       lora_request, prompt_adapter_request)
620

621
622
623
        encoder_seq = (None if encoder_inputs is None else Sequence(
            seq_id, encoder_inputs, block_size, eos_token_id, lora_request,
            prompt_adapter_request))
624

625
626
627
628
629
630
631
632
        # Create a SequenceGroup based on SamplingParams or PoolingParams
        if isinstance(params, SamplingParams):
            seq_group = self._create_sequence_group_with_sampling(
                request_id,
                seq,
                params,
                arrival_time=arrival_time,
                lora_request=lora_request,
633
                trace_headers=trace_headers,
634
                prompt_adapter_request=prompt_adapter_request,
635
636
                encoder_seq=encoder_seq,
                priority=priority)
637
638
639
640
641
642
643
        elif isinstance(params, PoolingParams):
            seq_group = self._create_sequence_group_with_pooling(
                request_id,
                seq,
                params,
                arrival_time=arrival_time,
                lora_request=lora_request,
644
                prompt_adapter_request=prompt_adapter_request,
645
646
                encoder_seq=encoder_seq,
                priority=priority)
647
648
649
650
        else:
            raise ValueError(
                "Either SamplingParams or PoolingParams must be provided.")

651
652
653
654
655
656
657
658
        # Add the sequence group to the scheduler with least unfinished seqs.
        costs = [
            scheduler.get_num_unfinished_seq_groups()
            for scheduler in self.scheduler
        ]
        min_cost_scheduler = self.scheduler[costs.index(min(costs))]
        min_cost_scheduler.add_seq_group(seq_group)

659
660
        return seq_group

661
662
    def stop_remote_worker_execution_loop(self) -> None:
        self.model_executor.stop_remote_worker_execution_loop()
663

664
    @overload
665
666
667
    def add_request(
        self,
        request_id: str,
668
        prompt: PromptType,
669
        params: Union[SamplingParams, PoolingParams],
670
        arrival_time: Optional[float] = None,
671
        lora_request: Optional[LoRARequest] = None,
672
        trace_headers: Optional[Mapping[str, str]] = None,
673
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
674
        priority: int = 0,
675
    ) -> None:
676
677
678
        ...

    @overload
679
    @deprecated("'inputs' will be renamed to 'prompt")
680
681
682
    def add_request(
        self,
        request_id: str,
683
684
        *,
        inputs: PromptType,
685
        params: Union[SamplingParams, PoolingParams],
686
        arrival_time: Optional[float] = None,
687
        lora_request: Optional[LoRARequest] = None,
688
        trace_headers: Optional[Mapping[str, str]] = None,
689
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
690
        priority: int = 0,
691
    ) -> None:
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
        ...

    @deprecate_kwargs(
        "inputs",
        additional_message="Please use the 'prompt' parameter instead.",
    )
    def add_request(
            self,
            request_id: str,
            prompt: Optional[PromptType] = None,
            params: Optional[Union[SamplingParams, PoolingParams]] = None,
            arrival_time: Optional[float] = None,
            lora_request: Optional[LoRARequest] = None,
            trace_headers: Optional[Mapping[str, str]] = None,
            prompt_adapter_request: Optional[PromptAdapterRequest] = None,
            priority: int = 0,
            *,
            inputs: Optional[PromptType] = None,  # DEPRECATED
710
    ) -> None:
Zhuohan Li's avatar
Zhuohan Li committed
711
        """Add a request to the engine's request pool.
712
713

        The request is added to the request pool and will be processed by the
Zhuohan Li's avatar
Zhuohan Li committed
714
        scheduler as `engine.step()` is called. The exact scheduling policy is
715
716
717
718
        determined by the scheduler.

        Args:
            request_id: The unique ID of the request.
719
            prompt: The prompt to the LLM. See :class:`~vllm.inputs.PromptType`
720
721
722
723
                for more details about the format of each input.
            params: Parameters for sampling or pooling.
                :class:`~vllm.SamplingParams` for text generation.
                :class:`~vllm.PoolingParams` for pooling.
724
            arrival_time: The arrival time of the request. If None, we use
725
                the current monotonic time.
726
            lora_request: The LoRA request to add.
727
            trace_headers: OpenTelemetry trace headers.
728
            prompt_adapter_request: The prompt adapter request to add.
729
730
            priority: The priority of the request.
                Only applicable with priority scheduling.
731
732
733
734

        Details:
            - Set arrival_time to the current time if it is None.
            - Set prompt_token_ids to the encoded prompt if it is None.
735
            - Create `n` number of :class:`~vllm.Sequence` objects.
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
            - Create a :class:`~vllm.SequenceGroup` object
              from the list of :class:`~vllm.Sequence`.
            - Add the :class:`~vllm.SequenceGroup` object to the scheduler.

        Example:
            >>> # initialize engine
            >>> engine = LLMEngine.from_engine_args(engine_args)
            >>> # set request arguments
            >>> example_prompt = "Who is the president of the United States?"
            >>> sampling_params = SamplingParams(temperature=0.0)
            >>> request_id = 0
            >>>
            >>> # add the request to the engine
            >>> engine.add_request(
            >>>    str(request_id),
            >>>    example_prompt,
            >>>    SamplingParams(temperature=0.0))
            >>> # continue the request processing
            >>> ...
755
        """
756
757
758
759
        if inputs is not None:
            prompt = inputs
        assert prompt is not None and params is not None

760
761
762
        if lora_request is not None and not self.lora_config:
            raise ValueError(f"Got lora_request {lora_request} but LoRA is "
                             "not enabled!")
763

764
        if priority != 0 and not self.scheduler_config.policy == "priority":
765
766
767
            raise ValueError(f"Got priority {priority} but "
                             "Priority scheduling is not enabled.")

768
769
770
771
772
773
774
        if isinstance(params, SamplingParams) \
            and (params.guided_decoding or params.logits_processors) \
            and self.scheduler_config.num_scheduler_steps > 1:
            raise ValueError(
                "Guided decoding and logits processors are not supported "
                "in multi-step decoding")

775
        if arrival_time is None:
776
            arrival_time = time.time()
777

778
779
780
781
782
        if self.tokenizer is not None:
            self._validate_token_prompt(
                prompt,
                tokenizer=self.get_tokenizer(lora_request=lora_request))

783
        preprocessed_inputs = self.input_preprocessor.preprocess(
784
            prompt,
785
            lora_request=lora_request,
786
787
            prompt_adapter_request=prompt_adapter_request,
        )
788
        processed_inputs = self.input_processor(preprocessed_inputs)
789

790
791
792
793
794
795
        self._add_processed_request(
            request_id=request_id,
            processed_inputs=processed_inputs,
            params=params,
            arrival_time=arrival_time,
            lora_request=lora_request,
796
            prompt_adapter_request=prompt_adapter_request,
797
            trace_headers=trace_headers,
798
            priority=priority,
799
        )
800

801
802
803
804
805
806
807
808
809
810
811
    def _validate_token_prompt(self, prompt: PromptType,
                               tokenizer: AnyTokenizer):
        # Guard against out-of-vocab tokens.
        # For some tokenizers, tokenizer.decode will happily return empty text
        # for token ids that are out of vocab, and we don't detect token ids
        # that are greater than the max token id before running the model.
        # However, these token ids will later crash a cuda kernel at runtime
        # with an index out of bounds error. This will crash the entire engine.
        # This needs to happen before multimodal input pre-processing, which
        # may add dummy <image> tokens that aren't part of the tokenizer's
        # vocabulary.
812
        if is_token_prompt(prompt):
813
814
815
816
817
818
819
820
821
            prompt_ids = prompt["prompt_token_ids"]
            if len(prompt_ids) == 0:
                # Empty prompt check is handled later
                return
            max_input_id = max(prompt_ids)
            if max_input_id > tokenizer.max_token_id:
                raise ValueError(
                    "Token id {} is out of vocabulary".format(max_input_id))

822
823
824
825
826
    def _create_sequence_group_with_sampling(
        self,
        request_id: str,
        seq: Sequence,
        sampling_params: SamplingParams,
827
828
        arrival_time: float,
        lora_request: Optional[LoRARequest],
829
        trace_headers: Optional[Mapping[str, str]] = None,
830
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
831
        encoder_seq: Optional[Sequence] = None,
832
        priority: int = 0,
833
834
835
836
837
838
839
840
841
842
    ) -> SequenceGroup:
        """Creates a SequenceGroup with SamplingParams."""
        max_logprobs = self.get_model_config().max_logprobs
        if (sampling_params.logprobs
                and sampling_params.logprobs > max_logprobs) or (
                    sampling_params.prompt_logprobs
                    and sampling_params.prompt_logprobs > max_logprobs):
            raise ValueError(f"Cannot request more than "
                             f"{max_logprobs} logprobs.")

843
844
845
        sampling_params = self._build_logits_processors(
            sampling_params, lora_request)

846
847
848
        # Defensive copy of SamplingParams, which are used by the sampler,
        # this doesn't deep-copy LogitsProcessor objects
        sampling_params = sampling_params.clone()
849

850
        sampling_params.update_from_generation_config(
851
            self.generation_config_fields, seq.eos_token_id)
852

853
        # Create the sequence group.
854
855
856
857
        draft_size = 1
        if self.vllm_config.speculative_config is not None:
            draft_size = \
                self.vllm_config.speculative_config.num_speculative_tokens + 1
858
859
860
861
862
863
864
        seq_group = SequenceGroup(
            request_id=request_id,
            seqs=[seq],
            arrival_time=arrival_time,
            sampling_params=sampling_params,
            lora_request=lora_request,
            trace_headers=trace_headers,
865
            prompt_adapter_request=prompt_adapter_request,
866
            encoder_seq=encoder_seq,
867
868
            priority=priority,
            draft_size=draft_size)
869

870
871
872
873
874
875
876
        return seq_group

    def _create_sequence_group_with_pooling(
        self,
        request_id: str,
        seq: Sequence,
        pooling_params: PoolingParams,
877
878
        arrival_time: float,
        lora_request: Optional[LoRARequest],
879
        prompt_adapter_request: Optional[PromptAdapterRequest],
880
        encoder_seq: Optional[Sequence] = None,
881
        priority: int = 0,
882
883
884
885
886
    ) -> SequenceGroup:
        """Creates a SequenceGroup with PoolingParams."""
        # Defensive copy of PoolingParams, which are used by the pooler
        pooling_params = pooling_params.clone()
        # Create the sequence group.
887
888
889
890
891
892
        seq_group = SequenceGroup(
            request_id=request_id,
            seqs=[seq],
            arrival_time=arrival_time,
            lora_request=lora_request,
            pooling_params=pooling_params,
893
            prompt_adapter_request=prompt_adapter_request,
894
895
            encoder_seq=encoder_seq,
            priority=priority)
896
        return seq_group
897

Antoni Baum's avatar
Antoni Baum committed
898
899
    def abort_request(self, request_id: Union[str, Iterable[str]]) -> None:
        """Aborts a request(s) with the given ID.
900
901

        Args:
Antoni Baum's avatar
Antoni Baum committed
902
            request_id: The ID(s) of the request to abort.
903
904
905
906
907
908
909
910
911
912
913

        Details:
            - Refer to the
              :meth:`~vllm.core.scheduler.Scheduler.abort_seq_group`
              from class :class:`~vllm.core.scheduler.Scheduler`.

        Example:
            >>> # initialize engine and add a request with request_id
            >>> request_id = str(0)
            >>> # abort the request
            >>> engine.abort_request(request_id)
914
        """
915
        for scheduler in self.scheduler:
916
917
            scheduler.abort_seq_group(
                request_id, seq_id_to_seq_group=self.seq_id_to_seq_group)
918

919
920
921
922
    def get_model_config(self) -> ModelConfig:
        """Gets the model configuration."""
        return self.model_config

923
924
925
926
    def get_parallel_config(self) -> ParallelConfig:
        """Gets the parallel configuration."""
        return self.parallel_config

927
928
929
930
    def get_decoding_config(self) -> DecodingConfig:
        """Gets the decoding configuration."""
        return self.decoding_config

931
932
933
934
935
936
937
938
    def get_scheduler_config(self) -> SchedulerConfig:
        """Gets the scheduler configuration."""
        return self.scheduler_config

    def get_lora_config(self) -> LoRAConfig:
        """Gets the LoRA configuration."""
        return self.lora_config

939
    def get_num_unfinished_requests(self) -> int:
940
        """Gets the number of unfinished requests."""
941
942
        return sum(scheduler.get_num_unfinished_seq_groups()
                   for scheduler in self.scheduler)
943

944
    def has_unfinished_requests(self) -> bool:
945
        """Returns True if there are unfinished requests."""
946
947
948
949
950
951
952
953
954
        return any(scheduler.has_unfinished_seqs()
                   for scheduler in self.scheduler)

    def has_unfinished_requests_for_virtual_engine(
            self, virtual_engine: int) -> bool:
        """
        Returns True if there are unfinished requests for the virtual engine.
        """
        return self.scheduler[virtual_engine].has_unfinished_seqs()
955

956
    def reset_prefix_cache(self, device: Optional[Device] = None) -> bool:
957
958
959
960
        """Reset prefix cache for all devices."""

        success = True
        for scheduler in self.scheduler:
961
            success = success and scheduler.reset_prefix_cache(device)
962
963
        return success

964
    @staticmethod
965
966
    def _process_sequence_group_outputs(
        seq_group: SequenceGroup,
967
        outputs: List[PoolingSequenceGroupOutput],
968
    ) -> None:
969
        seq_group.pooled_data = outputs[0].data
970
971
972
973
974
975

        for seq in seq_group.get_seqs():
            seq.status = SequenceStatus.FINISHED_STOPPED

        return

976
977
978
979
980
981
982
983
    def _update_num_computed_tokens_for_multi_step_prefill(
            self, seq_group: SequenceGroup,
            seq_group_meta: SequenceGroupMetadata,
            is_first_step_output: Optional[bool]):
        """
        This function updates num_computed_tokens for prompt sequences
        when Multi-Step is enabled.

984
        seq_group: SequenceGroup to update the num_computed_tokens for.
985
        seq_group_meta: Metadata of the given SequenceGroup.
986
        is_first_step_output: Optional[bool] -
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
            When available, is_first_step_output indicates if the appended
            output token is the output of the first-step in multi-step.
            A value of None indicates that outputs from all steps in
            in multi-step are submitted in a single burst.
        """

        assert self.scheduler_config.is_multi_step

        if not seq_group_meta.is_prompt:
            # num_computed_token updates for multi-step decodes happen after
            # the tokens are appended to the sequence.
            return

        do_update: bool = False
        if self.scheduler_config.chunked_prefill_enabled:
            # In multi-step + chunked-prefill case, the prompt sequences
            # that are scheduled are fully processed in the first step.
            do_update = is_first_step_output is None or is_first_step_output
        else:
            # Normal multi-step decoding case. In this case prompt-sequences
            # are actually single-stepped. Always update in this case.
            assert seq_group.state.num_steps == 1
            do_update = True

        if do_update:
            seq_group.update_num_computed_tokens(
                seq_group_meta.token_chunk_size)

1015
1016
1017
1018
1019
    def _process_model_outputs(self,
                               ctx: SchedulerContext,
                               request_id: Optional[str] = None) -> None:
        """Apply the model output to the sequences in the scheduled seq groups
        and return responses.
1020

1021
1022
        ctx: The virtual engine context to work on
        request_id: If provided, then only this request is going to be processed
1023
        """
1024

1025
        now = time.time()
1026

1027
        if len(ctx.output_queue) == 0:
1028
1029
            return None

1030
        # Get pending async postprocessor
1031
1032
1033
1034
        if request_id:
            # When we process only one request, no pop is required
            # (since later we will process all of the rest)
            (outputs, seq_group_metadata_list, scheduler_outputs, is_async,
1035
             is_last_step, is_first_step_output, skip) = ctx.output_queue[0]
1036
1037
        else:
            (outputs, seq_group_metadata_list, scheduler_outputs, is_async,
1038
1039
             is_last_step, is_first_step_output,
             skip) = ctx.output_queue.popleft()
1040
1041
1042
1043
1044

        # Sanity check
        assert len(seq_group_metadata_list) == len(
            scheduler_outputs.scheduled_seq_groups)

1045
        has_multiple_outputs: bool = len(outputs) > 1
1046
        outputs_by_sequence_group: List[List[SequenceGroupOutput]]
1047
1048
1049
1050
1051
        if has_multiple_outputs:
            assert self.scheduler_config.is_multi_step or \
                     self.speculative_config
            # Organize outputs by [step][sequence group] instead of
            # [sequence group][step].
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
            if self.scheduler_config.is_multi_step:
                outputs_by_sequence_group = create_output_by_sequence_group(
                    outputs, len(seq_group_metadata_list))
            elif self.speculative_config:
                # Decodes are multi-steps while prefills are not, outputting at
                # most 1 token. Separate them so that we can trigger chunk
                # processing without having to pad or copy over prompts K times
                # to match decodes structure (costly with prompt_logprobs).
                num_prefills = sum(sg.is_prompt
                                   for sg in seq_group_metadata_list)
                prefills, decodes = outputs[:num_prefills], outputs[
                    num_prefills:]
                outputs_by_sequence_group = create_output_by_sequence_group(
                    decodes,
                    num_seq_groups=len(seq_group_metadata_list) - num_prefills)
                outputs_by_sequence_group = [p.outputs for p in prefills
                                             ] + outputs_by_sequence_group
1069
1070
1071
            # We have outputs for multiple steps submitted in a single burst,
            # so invalidate is_first_step_output.
            is_first_step_output = None
1072
        elif len(outputs) == 1:
1073
            outputs_by_sequence_group = outputs
1074
1075
        else:
            return None
1076

1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
        # Determine the requests we need to operate on
        if request_id:
            indices = []
            for i, seq_group_meta in enumerate(seq_group_metadata_list):
                if seq_group_meta.request_id == request_id:
                    assert i not in skip  # Cannot be called twice
                    indices.append(i)
                    break

            # If the request_id was not found, then it means that
            # this is a new request that has no pending async
            # postprocessor
            if not indices:
                return
        else:
            indices = range(len(seq_group_metadata_list))  # type: ignore

1094
        finished_before: List[int] = []
1095
        finished_now: List[int] = []
1096
        empty_seq_indices: List[int] = []
1097
1098
1099
1100
1101
        for i in indices:
            if i in skip:
                continue

            seq_group_meta = seq_group_metadata_list[i]
1102
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1103

1104
            seq_group: SequenceGroup = scheduled_seq_group.seq_group
1105
1106
1107
1108
1109

            if seq_group.is_finished():
                finished_before.append(i)
                continue

1110
            output: List[SequenceGroupOutput]
1111
            if has_multiple_outputs:
1112
1113
1114
1115
                output = outputs_by_sequence_group[i]
            else:
                output = [outputs_by_sequence_group[0][i]]

1116
            # tree style speculative decoding may generate empty output in first step
1117
1118
1119
1120
1121
1122
1123
1124
1125
            if self.tree_decoding and outputs and isinstance(output[0], CompletionSequenceGroupOutput):
                samples = [o.samples[0] for o in output]
                valid_samples = [
                    sample for sample in samples
                    if sample.output_token != VLLM_INVALID_TOKEN_ID
                ]
                if len(valid_samples) == 0:
                    empty_seq_indices.append(i)
                    continue
1126

1127
            if not is_async:
1128
1129
1130
1131
1132
1133
                if self.scheduler_config.is_multi_step:
                    # Updates happen only if the sequence is prefill
                    self._update_num_computed_tokens_for_multi_step_prefill(
                        seq_group, seq_group_meta, is_first_step_output)
                else:
                    seq_group.update_num_computed_tokens(
1134
                        seq_group_meta.token_chunk_size or 0)
1135
1136
1137

            if outputs:
                for o in outputs:
1138
1139
1140
1141
                    if (isinstance(o, SamplerOutput)
                            and seq_group.metrics is not None):
                        if seq_group.metrics.model_forward_time is not None:
                            seq_group.metrics.model_forward_time += (
1142
                                o.model_forward_time or 0)
1143
1144
1145
1146
1147
                        else:
                            seq_group.metrics.model_forward_time = (
                                o.model_forward_time)
                        if seq_group.metrics.model_execute_time is not None:
                            seq_group.metrics.model_execute_time += (
1148
                                o.model_execute_time or 0)
1149
1150
1151
                        else:
                            seq_group.metrics.model_execute_time = (
                                o.model_execute_time)
1152

1153
            if self.model_config.runner_type == "pooling":
1154
                self._process_sequence_group_outputs(seq_group, output)
1155
1156
1157
1158
1159
            else:
                self.output_processor.process_prompt_logprob(seq_group, output)
                if seq_group_meta.do_sample:
                    self.output_processor.process_outputs(
                        seq_group, output, is_async)
1160

1161
1162
            if seq_group.is_finished():
                finished_now.append(i)
1163

1164
1165
1166
        # Generate outputs for the requests that finished this iteration
        for i in finished_now:
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1167

1168
            seq_group = scheduled_seq_group.seq_group
1169
            seq_group.maybe_set_first_token_time(now)
1170
1171
            if not seq_group.is_prefill():
                seq_group.set_last_token_time(now)
1172
            request_output = RequestOutputFactory.create(
1173
1174
1175
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs)
1176
1177
            if request_output:
                ctx.request_outputs.append(request_output)
1178

1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
        # When we process a single request, we skip it for the next time,
        # and invoke the request output callback (if there was final output)
        if request_id:
            assert len(indices) == 1
            skip.append(indices[0])

            if (finished_now
                    and self.process_request_outputs_callback is not None):
                self.process_request_outputs_callback(ctx.request_outputs)
                ctx.request_outputs.clear()
            return

1191
1192
1193
1194
1195
        # Free currently finished requests
        if finished_now:
            for scheduler in self.scheduler:
                scheduler.free_finished_seq_groups()

1196
1197
        # For multi-step without streaming, don't create outputs each iteration
        if not is_last_step and not ctx.multi_step_stream_outputs:
1198
1199
1200
1201
            # Immediately process request outputs here (if callback is given)
            if (finished_now
                    and self.process_request_outputs_callback is not None):
                self.process_request_outputs_callback(ctx.request_outputs)
1202
                ctx.request_outputs.clear()
1203
1204
1205
            return

        # Create the outputs
1206
        for i in indices:
1207
            if i in skip or i in finished_before or i in finished_now or i in empty_seq_indices:
1208
1209
                continue  # Avoids double processing

1210
1211
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]

1212
            seq_group = scheduled_seq_group.seq_group
1213
            seq_group.maybe_set_first_token_time(now)
1214
1215
            if not seq_group.is_prefill():
                seq_group.set_last_token_time(now)
1216
            request_output = RequestOutputFactory.create(
1217
1218
1219
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs)
1220
            if request_output:
1221
                ctx.request_outputs.append(request_output)
1222

1223
1224
1225
1226
1227
1228
1229
1230
        # For multi-step with streaming, create outputs each iteration
        if not is_last_step and ctx.multi_step_stream_outputs:
            # Immediately process request outputs here (if callback is given)
            if self.process_request_outputs_callback is not None:
                self.process_request_outputs_callback(ctx.request_outputs)
                ctx.request_outputs.clear()
            return

1231
        for seq_group in scheduler_outputs.ignored_seq_groups:
1232
1233
1234
1235
1236
            params = seq_group.sampling_params
            if params is not None and params.output_kind == (
                    RequestOutputKind.DELTA) and not seq_group.is_finished():
                continue

1237
            request_output = RequestOutputFactory.create(
1238
1239
1240
1241
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs,
            )
1242
1243
            if request_output:
                ctx.request_outputs.append(request_output)
1244

1245
1246
1247
1248
        # Immediately process request outputs here (if callback is given)
        if (ctx.request_outputs
                and self.process_request_outputs_callback is not None):
            self.process_request_outputs_callback(ctx.request_outputs)
1249
            ctx.request_outputs.clear()
1250

1251
1252
1253
1254
        # For async case, we need to record the stats here.
        # For non-async case, the stats are done in the
        # LLMEngine/AsyncLLMEngine directly
        if is_async:
1255
            # Log stats.
1256
1257
            self.do_log_stats(scheduler_outputs, outputs, finished_before,
                              skip)
1258
1259

            # Tracing
1260
            self.do_tracing(scheduler_outputs, finished_before)
1261
1262
1263
1264

        return None

    def _advance_to_next_step(
1265
            self, output: SamplerOutput,
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
            seq_group_metadata_list: List[SequenceGroupMetadata],
            scheduled_seq_groups: List[ScheduledSequenceGroup]) -> None:
        """Given model output from a single run, append the tokens to the
        sequences. This is normally done inside output processor, but it is
        required if the worker is to perform async forward pass to next step.
        """
        for seq_group_metadata, sequence_group_outputs, scheduled_seq_group in \
            zip(seq_group_metadata_list, output, scheduled_seq_groups):
            seq_group = scheduled_seq_group.seq_group

            if seq_group.is_finished():
                continue

1279
1280
1281
1282
1283
            if self.scheduler_config.is_multi_step:
                # Updates happen only if the sequence is prefill
                self._update_num_computed_tokens_for_multi_step_prefill(
                    seq_group, seq_group_metadata,
                    seq_group.state.num_steps == 1)
1284
            else:
1285
1286
1287
1288
                token_chunk_size = (seq_group_metadata.token_chunk_size
                                    if seq_group_metadata.token_chunk_size
                                    is not None else 0)
                seq_group.update_num_computed_tokens(token_chunk_size)
1289
1290
1291
1292

            if seq_group_metadata.do_sample:
                assert len(sequence_group_outputs.samples) == 1, (
                    "Async output processor expects a single sample"
1293
                    " (i.e sampling_params.n == 1)")
1294
1295
1296
1297
                sample = sequence_group_outputs.samples[0]

                assert len(seq_group.seqs) == 1
                seq = seq_group.seqs[0]
1298

1299
1300
1301
1302
1303
1304
1305
1306
                if self.scheduler_config.is_multi_step:
                    is_prefill_append = seq.data.get_num_uncomputed_tokens(
                    ) == 0
                    seq.append_token_id(sample.output_token, sample.logprobs)
                    if not is_prefill_append:
                        seq_group.update_num_computed_tokens(1)
                else:
                    seq.append_token_id(sample.output_token, sample.logprobs)
1307

1308
    def step(self) -> List[Union[RequestOutput, PoolingRequestOutput]]:
Antoni Baum's avatar
Antoni Baum committed
1309
1310
        """Performs one decoding iteration and returns newly generated results.

1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
        .. figure:: https://i.imgur.com/sv2HssD.png
            :alt: Overview of the step function
            :align: center

            Overview of the step function.

        Details:
            - Step 1: Schedules the sequences to be executed in the next
              iteration and the token blocks to be swapped in/out/copy.

                - Depending on the scheduling policy,
                  sequences may be `preempted/reordered`.
                - A Sequence Group (SG) refer to a group of sequences
                  that are generated from the same prompt.

1326
            - Step 2: Calls the distributed executor to execute the model.
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
            - Step 3: Processes the model output. This mainly includes:

                - Decodes the relevant outputs.
                - Updates the scheduled sequence groups with model outputs
                  based on its `sampling parameters` (`use_beam_search` or not).
                - Frees the finished sequence groups.

            - Finally, it creates and returns the newly generated results.

        Example:
            >>> # Please see the example/ folder for more detailed examples.
            >>>
            >>> # initialize engine and request arguments
            >>> engine = LLMEngine.from_engine_args(engine_args)
            >>> example_inputs = [(0, "What is LLM?",
            >>>    SamplingParams(temperature=0.0))]
            >>>
            >>> # Start the engine with an event loop
            >>> while True:
            >>>     if example_inputs:
            >>>         req_id, prompt, sampling_params = example_inputs.pop(0)
1348
            >>>         engine.add_request(str(req_id),prompt,sampling_params)
1349
1350
1351
1352
1353
1354
1355
1356
1357
            >>>
            >>>     # continue the request processing
            >>>     request_outputs = engine.step()
            >>>     for request_output in request_outputs:
            >>>         if request_output.finished:
            >>>             # return or show the request output
            >>>
            >>>     if not (engine.has_unfinished_requests() or example_inputs):
            >>>         break
Antoni Baum's avatar
Antoni Baum committed
1358
        """
1359
1360
1361
1362
        if self.parallel_config.pipeline_parallel_size > 1:
            raise NotImplementedError(
                "Pipeline parallelism is only supported through AsyncLLMEngine "
                "as performance will be severely degraded otherwise.")
1363

1364
        # For llm_engine, there is no pipeline parallel support, so the engine
1365
        # used is always 0.
1366
1367
        virtual_engine = 0

1368
1369
        # These are cached outputs from previous iterations. None if on first
        # iteration
1370
        cached_outputs = self.cached_scheduler_outputs[virtual_engine]
1371
1372
        seq_group_metadata_list = cached_outputs.seq_group_metadata_list
        scheduler_outputs = cached_outputs.scheduler_outputs
1373
        allow_async_output_proc = cached_outputs.allow_async_output_proc
1374

1375
1376
        ctx = self.scheduler_contexts[virtual_engine]

1377
1378
1379
        # Clear outputs for each new scheduler iteration
        ctx.request_outputs.clear()

1380
1381
1382
        # Skip the scheduler if there are any remaining steps in the seq groups.
        # This ensures that the scheduler is only called again when the current
        # batch has completed.
1383
1384
1385
1386
1387
        # The scheduler is also skipped if a single request caused the last
        # engine step to fail, and the previous schedule needs to be rerun.
        if not self._has_remaining_steps(
                seq_group_metadata_list
        ) and not self._skip_scheduling_next_step:
1388
            # Schedule iteration
1389
            (seq_group_metadata_list, scheduler_outputs,
1390
1391
             allow_async_output_proc
             ) = self.scheduler[virtual_engine].schedule()
1392

1393
1394
            ctx.seq_group_metadata_list = seq_group_metadata_list
            ctx.scheduler_outputs = scheduler_outputs
1395

1396
1397
            finished_requests_ids = self.scheduler[
                virtual_engine].get_and_reset_finished_requests_ids()
1398
1399
1400
1401
1402
            # When n>1, elements in self.seq_id_to_seq_group should be deleted
            # here, otherwise memory leaks.
            for finished_request_id in finished_requests_ids:
                if finished_request_id in self.seq_id_to_seq_group:
                    del self.seq_id_to_seq_group[finished_request_id]
1403

1404
1405
            # Maybe switch from async mode to sync mode
            if not allow_async_output_proc and len(ctx.output_queue) > 0:
1406
                self._process_model_outputs(ctx=ctx)
1407

1408
1409
1410
1411
1412
            if (self.scheduler_config.is_multi_step
                    and scheduler_outputs.num_lookahead_slots > 0):
                # cache the scheduler outputs for the next iteration if we have
                # lookahead slots
                self._cache_scheduler_outputs_for_multi_step(
1413
                    virtual_engine, seq_group_metadata_list, scheduler_outputs,
1414
                    allow_async_output_proc)
1415
1416
        else:
            finished_requests_ids = list()
1417
1418
1419

        assert seq_group_metadata_list is not None
        assert scheduler_outputs is not None
Antoni Baum's avatar
Antoni Baum committed
1420

1421
        if not scheduler_outputs.is_empty():
1422
1423
1424
1425
1426
1427

            # Check if we have a cached last_output from the previous iteration.
            # For supporting PP this is probably the best way to pass the
            # sampled_token_ids, as a separate broadcast over all the PP stages
            # will cause one virtual engine's microbatch to block the pipeline.
            last_sampled_token_ids = \
1428
                self._get_last_sampled_token_ids(virtual_engine)
1429

1430
            execute_model_req = ExecuteModelRequest(
1431
1432
1433
1434
                seq_group_metadata_list=seq_group_metadata_list,
                blocks_to_swap_in=scheduler_outputs.blocks_to_swap_in,
                blocks_to_swap_out=scheduler_outputs.blocks_to_swap_out,
                blocks_to_copy=scheduler_outputs.blocks_to_copy,
1435
1436
                num_lookahead_slots=scheduler_outputs.num_lookahead_slots,
                running_queue_size=scheduler_outputs.running_queue_size,
1437
1438
1439
1440
1441
                finished_requests_ids=finished_requests_ids,
                # We use ExecuteModelRequest to pass the last sampled_token_ids
                # to each of the non-last PP stages for in-place prepare_input.
                last_sampled_token_ids=last_sampled_token_ids)

1442
            if allow_async_output_proc:
1443
1444
                execute_model_req.async_callback = self.async_callbacks[
                    virtual_engine]
1445

1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
            try:
                outputs = self.model_executor.execute_model(
                    execute_model_req=execute_model_req)
                self._skip_scheduling_next_step = False
            except InputProcessingError as e:
                # The input for this request cannot be processed, so we must
                # abort it. If there are remaining requests in the batch that
                # have been scheduled, they will be retried on the next step.
                invalid_request_id = e.request_id
                self._abort_and_cache_schedule(
                    request_id=invalid_request_id,
                    virtual_engine=virtual_engine,
                    seq_group_metadata_list=seq_group_metadata_list,
                    scheduler_outputs=scheduler_outputs,
                    allow_async_output_proc=allow_async_output_proc)
                # Raise so the caller is notified that this request failed
                raise
1463

1464
            # We need to do this here so that last step's sampled_token_ids can
1465
1466
            # be passed to the next iteration for PP.
            if self.scheduler_config.is_multi_step:
1467
                self._update_cached_scheduler_output(virtual_engine, outputs)
1468
        else:
1469
1470
            # Nothing scheduled => If there is pending async postprocessor,
            # then finish it here.
1471
1472
            if len(ctx.output_queue) > 0:
                self._process_model_outputs(ctx=ctx)
1473
            # No outputs in this case
1474
            outputs = []
Antoni Baum's avatar
Antoni Baum committed
1475

1476
1477
1478
1479
1480
1481
        # Finish the current step for all the sequence groups.
        if self.scheduler_config.is_multi_step:
            for seq_group in seq_group_metadata_list:
                seq_group.finish_step()

        if not self._has_remaining_steps(seq_group_metadata_list):
1482
            # clear the cache if we have finished all the steps.
1483
1484
1485
            if self.scheduler_config.is_multi_step:
                self.cached_scheduler_outputs[0] = SchedulerOutputState()

1486
1487
1488
1489
1490
1491
            # is_first_step_output is True only when the num_steps of all
            # the sequences are 1. When the num_steps > 1,
            # multi_step_model_runner does the first-step output append.
            is_first_step_output: bool = False if not seq_group_metadata_list \
                else seq_group_metadata_list[0].state.num_steps == 1

1492
            # Add results to the output_queue
1493
1494
1495
1496
            ctx.append_output(outputs=outputs,
                              seq_group_metadata_list=seq_group_metadata_list,
                              scheduler_outputs=scheduler_outputs,
                              is_async=allow_async_output_proc,
1497
1498
                              is_last_step=True,
                              is_first_step_output=is_first_step_output)
1499
1500
1501

            if outputs and allow_async_output_proc:
                assert len(outputs) == 1, (
1502
                    "Async postprocessor expects only a single output set")
1503

1504
                self._advance_to_next_step(
1505
                    outputs[0], seq_group_metadata_list,
1506
                    scheduler_outputs.scheduled_seq_groups)
1507

1508
            # Check if need to run the usual non-async path
1509
            if not allow_async_output_proc:
1510
                self._process_model_outputs(ctx=ctx)
1511

1512
                # Log stats.
1513
                self.do_log_stats(scheduler_outputs, outputs)
1514

1515
1516
1517
                # Tracing
                self.do_tracing(scheduler_outputs)
        else:
1518
            # Multi-step case
1519
            return ctx.request_outputs
1520

1521
        if not self.has_unfinished_requests():
1522
1523
            # Drain async postprocessor (if exists)
            if len(ctx.output_queue) > 0:
1524
                self._process_model_outputs(ctx=ctx)
1525
            assert len(ctx.output_queue) == 0
1526

1527
1528
1529
1530
1531
            # Stop the execute model loop in parallel workers until there are
            # more requests to process. This avoids waiting indefinitely in
            # torch.distributed ops which may otherwise timeout, and unblocks
            # the RPC thread in the workers so that they can process any other
            # queued control plane messages, such as add/remove lora adapters.
1532
            logger.debug("Stopping remote worker execution loop.")
1533
1534
            self.model_executor.stop_remote_worker_execution_loop()

1535
        return ctx.request_outputs
Antoni Baum's avatar
Antoni Baum committed
1536

1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
    def _abort_and_cache_schedule(
            self, request_id: str, virtual_engine: int,
            seq_group_metadata_list: List[SequenceGroupMetadata],
            scheduler_outputs: SchedulerOutputs,
            allow_async_output_proc: bool) -> None:
        """Aborts a single request, and caches the scheduler outputs minus that
        request. This allows the next step to continue processing the remaining
        requests without having to re-run the scheduler."""

        # Abort the request and remove its sequence group from the current
        # schedule
        self.abort_request(request_id)
        for i, metadata in enumerate(seq_group_metadata_list):
            if metadata.request_id == request_id:
                del seq_group_metadata_list[i]
                break
        for i, group in enumerate(scheduler_outputs.scheduled_seq_groups):
            if group.seq_group.request_id == request_id:
                del scheduler_outputs.scheduled_seq_groups[i]
                break

        # If there are still other sequence groups left in the schedule, cache
        # them and flag the engine to reuse the schedule.
        if len(seq_group_metadata_list) > 0:
            self._skip_scheduling_next_step = True
            # Reuse multi-step caching logic
            self._cache_scheduler_outputs_for_multi_step(
                virtual_engine=virtual_engine,
                scheduler_outputs=scheduler_outputs,
                seq_group_metadata_list=seq_group_metadata_list,
                allow_async_output_proc=allow_async_output_proc)

1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
    def _has_remaining_steps(
        self, seq_group_metadata_list: Optional[List[SequenceGroupMetadata]]
    ) -> bool:
        if (not self.scheduler_config.is_multi_step
                or not seq_group_metadata_list):
            return False

        # TODO(will) this is a sanity check for nowto make sure that all the
        # seqs are on the same steps. Eventually we will want to do some sort of
        # dynamic scheduling when doing multi-step decoding.
        ref_remaining_steps = seq_group_metadata_list[0].state.remaining_steps
        if any([
                seq_group.state.remaining_steps != ref_remaining_steps
                for seq_group in seq_group_metadata_list[1:]
        ]):
1584
1585
            raise AssertionError("All running sequence groups should "
                                 "have the same remaining steps.")
1586
1587
1588
1589
1590
1591

        return ref_remaining_steps > 0

    def _cache_scheduler_outputs_for_multi_step(
            self, virtual_engine: int,
            seq_group_metadata_list: Optional[List[SequenceGroupMetadata]],
1592
1593
1594
1595
1596
1597
1598
1599
            scheduler_outputs: SchedulerOutputs,
            allow_async_output_proc: bool) -> None:
        co = self.cached_scheduler_outputs[virtual_engine]

        co.seq_group_metadata_list = seq_group_metadata_list
        co.scheduler_outputs = scheduler_outputs
        co.allow_async_output_proc = allow_async_output_proc
        co.last_output = None
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623

    def _update_cached_scheduler_output(
            self, virtual_engine: int,
            output: List[Optional[SamplerOutput]]) -> None:
        if (self.parallel_config.pipeline_parallel_size > 1 and len(output) > 0
                and output[0] is not None):
            last_output = output[-1]
            assert last_output is not None
            assert last_output.sampled_token_ids_cpu is not None
            assert last_output.sampled_token_ids is None
            assert last_output.sampled_token_probs is None
            self.cached_scheduler_outputs[
                virtual_engine].last_output = last_output

    def _get_last_sampled_token_ids(
            self, virtual_engine: int) -> Optional[torch.Tensor]:
        cached_last_output = self.cached_scheduler_outputs[
            virtual_engine].last_output
        if (self.scheduler_config.is_multi_step
                and self.parallel_config.pipeline_parallel_size > 1
                and cached_last_output is not None
                and cached_last_output.sampled_token_ids_cpu is not None):
            return cached_last_output.sampled_token_ids_cpu
        return None
Antoni Baum's avatar
Antoni Baum committed
1624

1625
    def add_logger(self, logger_name: str, logger: StatLoggerBase) -> None:
1626
1627
1628
1629
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1630
1631
1632
1633
1634
        if logger_name in self.stat_loggers:
            raise KeyError(f"Logger with name {logger_name} already exists.")
        self.stat_loggers[logger_name] = logger

    def remove_logger(self, logger_name: str) -> None:
1635
1636
1637
1638
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1639
1640
1641
1642
        if logger_name not in self.stat_loggers:
            raise KeyError(f"Logger with name {logger_name} does not exist.")
        del self.stat_loggers[logger_name]

1643
1644
1645
    def do_log_stats(self,
                     scheduler_outputs: Optional[SchedulerOutputs] = None,
                     model_output: Optional[List[SamplerOutput]] = None,
1646
1647
                     finished_before: Optional[List[int]] = None,
                     skip: Optional[List[int]] = None) -> None:
1648
1649
        """Forced log when no requests active."""
        if self.log_stats:
1650
            stats = self._get_stats(scheduler_outputs, model_output,
1651
                                    finished_before, skip)
1652
            for logger in self.stat_loggers.values():
1653
                logger.log(stats)
1654

1655
1656
1657
    def _get_stats(self,
                   scheduler_outputs: Optional[SchedulerOutputs],
                   model_output: Optional[List[SamplerOutput]] = None,
1658
1659
                   finished_before: Optional[List[int]] = None,
                   skip: Optional[List[int]] = None) -> Stats:
1660
1661
1662
1663
1664
1665
1666
        """Get Stats to be Logged to Prometheus.

        Args:
            scheduler_outputs: Optional, used to populate metrics related to
                the scheduled batch,
            model_output: Optional, used to emit speculative decoding metrics
                which are created by the workers.
1667
1668
1669
1670
            finished_before: Optional, indices of sequences that were finished
                before. These sequences will be ignored.
            skip: Optional, indices of sequences that were preempted. These
                sequences will be ignored.
1671
        """
1672
        now = time.time()
Woosuk Kwon's avatar
Woosuk Kwon committed
1673

1674
1675
        # System State
        #   Scheduler State
1676
1677
1678
1679
1680
1681
        num_running_sys = sum(
            len(scheduler.running) for scheduler in self.scheduler)
        num_swapped_sys = sum(
            len(scheduler.swapped) for scheduler in self.scheduler)
        num_waiting_sys = sum(
            len(scheduler.waiting) for scheduler in self.scheduler)
1682
1683

        # KV Cache Usage in %
1684
        num_total_gpu = self.cache_config.num_gpu_blocks
1685
        gpu_cache_usage_sys = 0.
1686
        if num_total_gpu:  # Guard against both None and 0
1687
1688
1689
            num_free_gpu = sum(
                scheduler.block_manager.get_num_free_gpu_blocks()
                for scheduler in self.scheduler)
1690
            gpu_cache_usage_sys = 1.0 - (num_free_gpu / num_total_gpu)
Woosuk Kwon's avatar
Woosuk Kwon committed
1691

1692
        num_total_cpu = self.cache_config.num_cpu_blocks
1693
        cpu_cache_usage_sys = 0.
1694
        if num_total_cpu:  # Guard against both None and 0
1695
1696
1697
            num_free_cpu = sum(
                scheduler.block_manager.get_num_free_cpu_blocks()
                for scheduler in self.scheduler)
1698
1699
            cpu_cache_usage_sys = 1.0 - (num_free_cpu / num_total_cpu)

1700
1701
1702
1703
1704
1705
1706
        # Prefix Cache Hit Rate. Note that we always use
        # the cache hit rate of the first virtual engine.
        cpu_prefix_cache_hit_rate = self.scheduler[
            0].get_prefix_cache_hit_rate(Device.CPU)
        gpu_prefix_cache_hit_rate = self.scheduler[
            0].get_prefix_cache_hit_rate(Device.GPU)

1707
1708
1709
        # Iteration stats
        num_prompt_tokens_iter = 0
        num_generation_tokens_iter = 0
harrywu's avatar
harrywu committed
1710
        num_tokens_iter = 0
1711
1712
        time_to_first_tokens_iter: List[float] = []
        time_per_output_tokens_iter: List[float] = []
1713
1714
        num_preemption_iter = (0 if scheduler_outputs is None else
                               scheduler_outputs.preempted)
1715
1716
1717
1718

        # Request stats
        #   Latency
        time_e2e_requests: List[float] = []
harrywu's avatar
harrywu committed
1719
1720
1721
1722
        time_queue_requests: List[float] = []
        time_inference_requests: List[float] = []
        time_prefill_requests: List[float] = []
        time_decode_requests: List[float] = []
1723
1724
1725
        time_in_queue_requests: List[float] = []
        model_forward_time_requests: List[float] = []
        model_execute_time_requests: List[float] = []
1726
1727
1728
1729
        #   Metadata
        num_prompt_tokens_requests: List[int] = []
        num_generation_tokens_requests: List[int] = []
        n_requests: List[int] = []
harrywu's avatar
harrywu committed
1730
        max_num_generation_tokens_requests: List[int] = []
1731
        max_tokens_requests: List[int] = []
1732
1733
        finished_reason_requests: List[str] = []

1734
        # LoRA requests
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
        running_lora_adapters = dict(
            collectionsCounter([
                running_request.lora_request.lora_name
                for scheduler in self.scheduler
                for running_request in scheduler.running
                if running_request.lora_request
            ]))
        waiting_lora_adapters = dict(
            collectionsCounter([
                waiting_request.lora_request.lora_name
                for scheduler in self.scheduler
                for waiting_request in scheduler.waiting
                if waiting_request.lora_request
            ]))
        max_lora_stat = "0"
        if self.lora_config:
            max_lora_stat = str(self.lora_config.max_loras)

1753
1754
        # NOTE: This loop assumes prefill seq_groups are before
        # decode seq_groups in scheduled_seq_groups.
1755
        if scheduler_outputs is not None:
1756
1757
1758
1759
            # For async postprocessor, already finished sequences need to be
            # not counted (to avoid double counting)
            actual_num_batched_tokens = scheduler_outputs.num_batched_tokens  # type: ignore

1760
            num_generation_tokens_from_prefill_groups = 0
1761
1762
1763
1764
            # NOTE: if scheduler_outputs.num_prefill_groups > 0 and
            # the len of scheduler_outputs.scheduled_seq_groups is !=
            # scheduler_outputs.num_prefill_groups, this means that
            # chunked prefills have been detected.
1765
1766
1767

            for idx, scheduled_seq_group in enumerate(
                    scheduler_outputs.scheduled_seq_groups):
1768
1769
1770
1771
1772
                # Skip double logging when using async output proc
                if finished_before and idx in finished_before:
                    actual_num_batched_tokens -= 1
                    continue

1773
1774
1775
1776
                # Currently, skip == preempted sequences, so we need to skip
                # their log stats
                if skip and idx in skip:
                    continue
1777

1778
                group_was_prefill = idx < scheduler_outputs.num_prefill_groups
1779
                seq_group = scheduled_seq_group.seq_group
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791

                # NOTE: a seq_group that completed all of its prefill tokens
                # in the last iteration will have seq_group.is_prefill() = False
                # with group_was_prefill = True
                if group_was_prefill:
                    # Number of prompt tokens.
                    num_prompt_tokens_iter += (
                        scheduled_seq_group.token_chunk_size)

                    # If the seq_group just finished the prefill state
                    # get TTFT.
                    if not seq_group.is_prefill():
1792
                        latency = seq_group.get_last_token_latency()
1793
1794
1795
1796
1797
1798
1799
                        time_to_first_tokens_iter.append(latency)

                        # One generation token per finished prefill.
                        num_generation_tokens_from_prefill_groups += (
                            seq_group.num_seqs())
                else:
                    # TPOTs.
1800
                    latency = seq_group.get_last_token_latency()
1801
                    time_per_output_tokens_iter.append(latency)
1802
1803
1804
1805
1806
1807
1808
1809
1810
                    if seq_group.state.current_step == 0:
                        # For async_output_proc, the do_log_stats()
                        # is called following init_multi_step(), which
                        # sets the current_step to zero.
                        actual_num_batched_tokens +=\
                            seq_group.state.num_steps - 1
                    else:
                        actual_num_batched_tokens +=\
                            seq_group.state.current_step - 1
1811
1812
1813
1814
1815
1816

                # Because of chunked prefill, we can have a single sequence
                # group that does multiple prompt_runs. To prevent logging
                # the same metadata more than once per request, we standardize
                # on logging request level information for finished requests,
                # which can only happen once.
1817
                if seq_group.is_finished():
1818
                    # Latency timings
1819
1820
                    time_e2e_requests.append(now -
                                             seq_group.metrics.arrival_time)
harrywu's avatar
harrywu committed
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
                    if (seq_group.metrics.first_scheduled_time is not None and
                            seq_group.metrics.first_token_time is not None):
                        time_queue_requests.append(
                            seq_group.metrics.first_scheduled_time -
                            seq_group.metrics.arrival_time)
                        time_prefill_requests.append(
                            seq_group.metrics.first_token_time -
                            seq_group.metrics.first_scheduled_time)
                        time_decode_requests.append(
                            now - seq_group.metrics.first_token_time)
                        time_inference_requests.append(
                            now - seq_group.metrics.first_scheduled_time)
1833
1834
1835
1836
1837
1838
1839
1840
1841
                    if seq_group.metrics.time_in_queue is not None:
                        time_in_queue_requests.append(
                            seq_group.metrics.time_in_queue)
                    if seq_group.metrics.model_forward_time is not None:
                        model_forward_time_requests.append(
                            seq_group.metrics.model_forward_time)
                    if seq_group.metrics.model_execute_time is not None:
                        model_execute_time_requests.append(
                            seq_group.metrics.model_execute_time * 1000)
1842
1843
1844
1845
1846
1847
1848
                    # Metadata
                    num_prompt_tokens_requests.append(
                        len(seq_group.prompt_token_ids))
                    num_generation_tokens_requests.extend([
                        seq.get_output_len()
                        for seq in seq_group.get_finished_seqs()
                    ])
harrywu's avatar
harrywu committed
1849
1850
1851
                    max_num_generation_tokens_requests.append(
                        max(seq.get_output_len()
                            for seq in seq_group.get_seqs()))
1852
1853
                    if seq_group.sampling_params is not None:
                        n_requests.append(seq_group.sampling_params.n)
1854
1855
                        max_tokens_requests.append(
                            seq_group.sampling_params.max_tokens)
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
                    finished_reason_requests.extend([
                        SequenceStatus.get_finished_reason(seq.status)
                        for seq in seq_group.get_finished_seqs()
                    ])

            # Number of generation tokens.
            #   num_batched_tokens equals the number of prompt_tokens plus the
            #   number of decode_tokens in a single iteration. So,
            #   num_generation_tokens = num_batched_tokens - num_prompt_tokens
            #   + num_generation_tokens_from_prefill_groups (since we generate
            #   one token on prefills on iters where the prefill finishes).
            num_generation_tokens_iter = (
1868
                actual_num_batched_tokens - num_prompt_tokens_iter +
1869
                num_generation_tokens_from_prefill_groups)
harrywu's avatar
harrywu committed
1870
1871
            num_tokens_iter = (num_generation_tokens_iter +
                               num_prompt_tokens_iter)
1872
1873
        # Spec decode, if enabled, emits specialized metrics from the worker in
        # sampler output.
1874
1875
        if model_output and isinstance(model_output[0], SamplerOutput) and (
                model_output[0].spec_decode_worker_metrics is not None):
1876
1877
1878
1879
            spec_decode_metrics = model_output[0].spec_decode_worker_metrics
        else:
            spec_decode_metrics = None

1880
1881
        return Stats(
            now=now,
1882
1883
1884
1885
1886
1887
1888
1889
            # System stats
            #   Scheduler State
            num_running_sys=num_running_sys,
            num_swapped_sys=num_swapped_sys,
            num_waiting_sys=num_waiting_sys,
            #   KV Cache Usage in %
            gpu_cache_usage_sys=gpu_cache_usage_sys,
            cpu_cache_usage_sys=cpu_cache_usage_sys,
1890
1891
1892
            #   Prefix Cache Hit Rate
            cpu_prefix_cache_hit_rate=cpu_prefix_cache_hit_rate,
            gpu_prefix_cache_hit_rate=gpu_prefix_cache_hit_rate,
1893
1894
1895
1896

            # Iteration stats
            num_prompt_tokens_iter=num_prompt_tokens_iter,
            num_generation_tokens_iter=num_generation_tokens_iter,
harrywu's avatar
harrywu committed
1897
            num_tokens_iter=num_tokens_iter,
1898
1899
            time_to_first_tokens_iter=time_to_first_tokens_iter,
            time_per_output_tokens_iter=time_per_output_tokens_iter,
1900
            spec_decode_metrics=spec_decode_metrics,
1901
            num_preemption_iter=num_preemption_iter,
1902
1903
1904
1905

            # Request stats
            #   Latency
            time_e2e_requests=time_e2e_requests,
harrywu's avatar
harrywu committed
1906
1907
1908
1909
            time_queue_requests=time_queue_requests,
            time_inference_requests=time_inference_requests,
            time_prefill_requests=time_prefill_requests,
            time_decode_requests=time_decode_requests,
1910
1911
1912
            time_in_queue_requests=time_in_queue_requests,
            model_forward_time_requests=model_forward_time_requests,
            model_execute_time_requests=model_execute_time_requests,
1913
1914
1915
            #   Metadata
            num_prompt_tokens_requests=num_prompt_tokens_requests,
            num_generation_tokens_requests=num_generation_tokens_requests,
harrywu's avatar
harrywu committed
1916
1917
            max_num_generation_tokens_requests=
            max_num_generation_tokens_requests,
1918
            n_requests=n_requests,
1919
            max_tokens_requests=max_tokens_requests,
1920
            finished_reason_requests=finished_reason_requests,
1921
1922
1923
            max_lora=str(max_lora_stat),
            waiting_lora_adapters=list(waiting_lora_adapters.keys()),
            running_lora_adapters=list(running_lora_adapters.keys()))
1924

1925
    def add_lora(self, lora_request: LoRARequest) -> bool:
1926
        return self.model_executor.add_lora(lora_request)
1927
1928

    def remove_lora(self, lora_id: int) -> bool:
1929
        return self.model_executor.remove_lora(lora_id)
1930

1931
    def list_loras(self) -> Set[int]:
1932
        return self.model_executor.list_loras()
1933

1934
1935
1936
    def pin_lora(self, lora_id: int) -> bool:
        return self.model_executor.pin_lora(lora_id)

1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
    def add_prompt_adapter(
            self, prompt_adapter_request: PromptAdapterRequest) -> bool:
        return self.model_executor.add_prompt_adapter(prompt_adapter_request)

    def remove_prompt_adapter(self, prompt_adapter_id: int) -> bool:
        return self.model_executor.remove_prompt_adapter(prompt_adapter_id)

    def list_prompt_adapters(self) -> List[int]:
        return self.model_executor.list_prompt_adapters()

1947
1948
1949
1950
1951
1952
    def start_profile(self) -> None:
        self.model_executor.start_profile()

    def stop_profile(self) -> None:
        self.model_executor.stop_profile()

1953
1954
1955
1956
1957
    def sleep(self, level: int = 1) -> None:
        assert self.vllm_config.model_config.enable_sleep_mode, (
            "Sleep mode is not enabled in the model config")
        self.model_executor.sleep(level=level)

1958
    def wake_up(self, tags: Optional[list[str]] = None) -> None:
1959
1960
        assert self.vllm_config.model_config.enable_sleep_mode, (
            "Sleep mode is not enabled in the model config")
1961
        self.model_executor.wake_up(tags)
1962

1963
1964
1965
    def is_sleeping(self) -> bool:
        return self.model_executor.is_sleeping

1966
    def check_health(self) -> None:
1967
1968
        if self.tokenizer:
            self.tokenizer.check_health()
1969
        self.model_executor.check_health()
1970
1971
1972
1973

    def is_tracing_enabled(self) -> bool:
        return self.tracer is not None

1974
1975
1976
    def do_tracing(self,
                   scheduler_outputs: SchedulerOutputs,
                   finished_before: Optional[List[int]] = None) -> None:
1977
1978
1979
        if self.tracer is None:
            return

1980
1981
1982
1983
1984
1985
        for idx, scheduled_seq_group in enumerate(
                scheduler_outputs.scheduled_seq_groups):
            # Skip double tracing when using async output proc
            if finished_before and idx in finished_before:
                continue

1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
            seq_group = scheduled_seq_group.seq_group
            if seq_group.is_finished():
                self.create_trace_span(seq_group)

    def create_trace_span(self, seq_group: SequenceGroup) -> None:
        if self.tracer is None or seq_group.sampling_params is None:
            return
        arrival_time_nano_seconds = int(seq_group.metrics.arrival_time * 1e9)

        trace_context = extract_trace_context(seq_group.trace_headers)

        with self.tracer.start_as_current_span(
                "llm_request",
                kind=SpanKind.SERVER,
                context=trace_context,
                start_time=arrival_time_nano_seconds) as seq_span:
            metrics = seq_group.metrics
            ttft = metrics.first_token_time - metrics.arrival_time
            e2e_time = metrics.finished_time - metrics.arrival_time
2005
            seq_span.set_attribute(SpanAttributes.GEN_AI_RESPONSE_MODEL,
2006
                                   self.model_config.model)
2007
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_ID,
2008
                                   seq_group.request_id)
2009
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_TEMPERATURE,
2010
                                   seq_group.sampling_params.temperature)
2011
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_TOP_P,
2012
                                   seq_group.sampling_params.top_p)
2013
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_MAX_TOKENS,
2014
                                   seq_group.sampling_params.max_tokens)
2015
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_N,
2016
                                   seq_group.sampling_params.n)
2017
            seq_span.set_attribute(SpanAttributes.GEN_AI_USAGE_NUM_SEQUENCES,
2018
                                   seq_group.num_seqs())
2019
            seq_span.set_attribute(SpanAttributes.GEN_AI_USAGE_PROMPT_TOKENS,
2020
2021
                                   len(seq_group.prompt_token_ids))
            seq_span.set_attribute(
2022
                SpanAttributes.GEN_AI_USAGE_COMPLETION_TOKENS,
2023
2024
2025
2026
                sum([
                    seq.get_output_len()
                    for seq in seq_group.get_finished_seqs()
                ]))
2027
            seq_span.set_attribute(SpanAttributes.GEN_AI_LATENCY_TIME_IN_QUEUE,
2028
2029
                                   metrics.time_in_queue)
            seq_span.set_attribute(
2030
2031
                SpanAttributes.GEN_AI_LATENCY_TIME_TO_FIRST_TOKEN, ttft)
            seq_span.set_attribute(SpanAttributes.GEN_AI_LATENCY_E2E, e2e_time)
2032
2033
            if metrics.scheduler_time is not None:
                seq_span.set_attribute(
2034
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_SCHEDULER,
2035
2036
2037
                    metrics.scheduler_time)
            if metrics.model_forward_time is not None:
                seq_span.set_attribute(
2038
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_MODEL_FORWARD,
2039
2040
2041
                    metrics.model_forward_time / 1000.0)
            if metrics.model_execute_time is not None:
                seq_span.set_attribute(
2042
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_MODEL_EXECUTE,
2043
                    metrics.model_execute_time)
2044

2045
    def _validate_model_inputs(self, inputs: ProcessorInputs,
2046
                               lora_request: Optional[LoRARequest]):
2047
2048
2049
2050
2051
2052
        encoder_inputs, decoder_inputs = split_enc_dec_inputs(inputs)

        # For encoder-decoder multimodal models, the max_prompt_len
        # restricts the decoder prompt length
        if self.model_config.is_multimodal_model:
            prompt_inputs = decoder_inputs
2053
        else:
2054
            prompt_inputs = encoder_inputs or decoder_inputs
2055

2056
        prompt_ids = prompt_inputs["prompt_token_ids"]
2057
2058

        if prompt_ids is None or len(prompt_ids) == 0:
2059
            raise ValueError("Prompt cannot be empty")
2060

2061
        if self.model_config.is_multimodal_model:
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
            max_prompt_len = self.model_config.max_model_len

            if len(prompt_ids) > max_prompt_len:
                raise ValueError(
                    f"The prompt (total length {len(prompt_ids)}) is too long "
                    f"to fit into the model (context length {max_prompt_len}). "
                    "Make sure that `max_model_len` is no smaller than the "
                    "number of text tokens plus multimodal tokens. For image "
                    "inputs, the number of image tokens depends on the number "
                    "of images, and possibly their aspect ratios as well.")
2072
2073
2074
2075

            # TODO: Find out how many placeholder tokens are there so we can
            # check that chunked prefill does not truncate them
            # max_batch_len = self.scheduler_config.max_num_batched_tokens
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085

    def _build_logits_processors(
            self, sampling_params: SamplingParams,
            lora_request: Optional[LoRARequest]) -> SamplingParams:
        """Constructs logits processors based on the guided_decoding,
        logits_bias, and allowed_token_ids fields in sampling_params. Deletes
        those fields and adds the constructed logits processors to the
        logits_processors field. Returns the modified sampling params."""

        logits_processors = []
2086

2087
2088
2089
2090
2091
        if sampling_params.guided_decoding is not None:
            # Defensively copy sampling params since guided decoding logits
            # processors can have different state for each request
            sampling_params = copy.copy(sampling_params)
            guided_decoding = sampling_params.guided_decoding
2092
2093
2094
2095
2096
2097
2098
2099
2100

            logger.debug(
                "Building guided decoding logits processor in "
                "LLMEngine. Params: %s", guided_decoding)

            tokenizer = self.get_tokenizer(lora_request=lora_request)
            guided_decoding.backend = guided_decoding.backend or \
                self.decoding_config.guided_decoding_backend

2101
2102
2103
            if self.decoding_config.reasoning_backend is not None:
                logger.debug("Building with reasoning backend %s",
                             self.decoding_config.reasoning_backend)
2104

2105
            processor = get_local_guided_decoding_logits_processor(
2106
2107
                guided_params=guided_decoding,
                tokenizer=tokenizer,
2108
2109
2110
                model_config=self.model_config,
                reasoning_backend=self.decoding_config.reasoning_backend,
            )
2111
2112
2113
2114
2115
2116
2117
2118
2119
            if processor:
                logits_processors.append(processor)

            # Unset so this doesn't get passed down to the model
            sampling_params.guided_decoding = None

        if (sampling_params.logit_bias or sampling_params.allowed_token_ids):
            tokenizer = self.get_tokenizer(lora_request=lora_request)

2120
            processors = get_openai_logits_processors(
2121
2122
2123
2124
2125
2126
2127
2128
2129
                logit_bias=sampling_params.logit_bias,
                allowed_token_ids=sampling_params.allowed_token_ids,
                tokenizer=tokenizer)
            logits_processors.extend(processors)

            # Unset so these don't get passed down to the model
            sampling_params.logit_bias = None
            sampling_params.allowed_token_ids = None

2130
2131
2132
2133
2134
2135
        if len(sampling_params.bad_words) > 0:
            tokenizer = self.get_tokenizer(lora_request)
            processors = get_bad_words_logits_processors(
                bad_words=sampling_params.bad_words, tokenizer=tokenizer)
            logits_processors.extend(processors)

2136
2137
2138
2139
2140
2141
2142
        if logits_processors:
            if sampling_params.logits_processors is None:
                sampling_params.logits_processors = logits_processors
            else:
                sampling_params.logits_processors.extend(logits_processors)

        return sampling_params
2143

2144
2145
2146
2147
2148
2149
2150
2151
    def collective_rpc(self,
                       method: Union[str, Callable[..., _R]],
                       timeout: Optional[float] = None,
                       args: tuple = (),
                       kwargs: Optional[dict[str, Any]] = None) -> list[_R]:
        return self.model_executor.collective_rpc(method, timeout, args,
                                                  kwargs)

2152

2153
2154
2155
if envs.is_set("VLLM_USE_V1") and envs.VLLM_USE_V1:
    from vllm.v1.engine.llm_engine import LLMEngine as V1LLMEngine
    LLMEngine = V1LLMEngine  # type: ignore