"tests/vscode:/vscode.git/clone" did not exist on "bfa59be8f18512ac1b6d2764e17db25f29c75933"
llm_engine.py 93.3 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
from typing import (TYPE_CHECKING, Any, Callable, ClassVar, Deque, Dict,
12
                    Iterable, List, Literal, 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 ProcessorInputs, PromptType, SingletonInputs
34
from vllm.inputs.parse import is_token_prompt, split_enc_dec_inputs
35
from vllm.inputs.preprocess import InputPreprocessor
Woosuk Kwon's avatar
Woosuk Kwon committed
36
from vllm.logger import init_logger
37
from vllm.logits_process import get_bad_words_logits_processors
38
from vllm.lora.request import LoRARequest
39
40
from vllm.model_executor.guided_decoding import (
    get_local_guided_decoding_logits_processor)
41
from vllm.model_executor.layers.sampler import SamplerOutput
42
from vllm.multimodal import MULTIMODAL_REGISTRY, MultiModalRegistry
43
from vllm.multimodal.processing import EncDecMultiModalProcessor
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
    TokenizerGroup, 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
from vllm.profiler.prof import profile
66
67

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

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
        return outputs_

208
    tokenizer: Optional[TokenizerGroup]
209

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
        mm_registry: MultiModalRegistry = MULTIMODAL_REGISTRY,
218
        use_cached_outputs: bool = False,
219
    ) -> None:
220
221
222
223
224
225
        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.")
226

227
        self.vllm_config = vllm_config
228
229
230
231
232
233
234
235
236
        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
237
        )
238
239
        self.prompt_adapter_config = vllm_config.prompt_adapter_config  # noqa
        self.observability_config = vllm_config.observability_config or ObservabilityConfig(  # noqa
240
241
        )

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

250
        self.log_stats = log_stats
251
        self.use_cached_outputs = use_cached_outputs
252

253
        if not self.model_config.skip_tokenizer_init:
254
            self.tokenizer = self._init_tokenizer()
255
            self.detokenizer = Detokenizer(self.tokenizer)
256
            tokenizer_group = self.get_tokenizer_group()
257
258
        else:
            self.tokenizer = None
259
            self.detokenizer = None
260
261
262
263
264
265
266
267
            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)
268

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

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

277
        self.model_executor = executor_class(vllm_config=vllm_config)
278

279
        if self.model_config.runner_type != "pooling":
280
            self._initialize_kv_caches()
281

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

                    # Quantization
                    "quantization":
302
                    self.model_config.quantization,
yhu422's avatar
yhu422 committed
303
                    "kv_cache_dtype":
304
                    str(self.cache_config.cache_dtype),
yhu422's avatar
yhu422 committed
305
306
307

                    # Feature flags
                    "enable_lora":
308
                    bool(self.lora_config),
309
                    "enable_prompt_adapter":
310
                    bool(self.prompt_adapter_config),
yhu422's avatar
yhu422 committed
311
                    "enable_prefix_caching":
312
                    self.cache_config.enable_prefix_caching,
yhu422's avatar
yhu422 committed
313
                    "enforce_eager":
314
                    self.model_config.enforce_eager,
yhu422's avatar
yhu422 committed
315
                    "disable_custom_all_reduce":
316
                    self.parallel_config.disable_custom_all_reduce,
yhu422's avatar
yhu422 committed
317
                })
zhuwenwen's avatar
zhuwenwen committed
318

319
320
321
322
323
324
        self.cached_scheduler_outputs = [
            SchedulerOutputState()
            for _ in range(self.parallel_config.pipeline_parallel_size)
        ]

        self.scheduler_contexts = [
325
326
            SchedulerContext(multi_step_stream_outputs=self.scheduler_config.
                             multi_step_stream_outputs)
327
328
329
            for _ in range(self.parallel_config.pipeline_parallel_size)
        ]

330
        if self.model_config.use_async_output_proc:
331
            process_model_outputs = weak_bind(self._process_model_outputs)
zhuwenwen's avatar
zhuwenwen committed
332
333

            self.async_callbacks = [
334
335
                partial(process_model_outputs,
                        ctx=self.scheduler_contexts[v_id])
zhuwenwen's avatar
zhuwenwen committed
336
337
                for v_id in range(self.parallel_config.pipeline_parallel_size)
            ]
338
339
        else:
            self.async_callbacks = []
340
341
342

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

345
        # Create the scheduler.
346
347
        # NOTE: the cache_config here have been updated with the numbers of
        # GPU and CPU blocks, which are profiled in the distributed executor.
348
349
350
351
352
        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
353
        self.scheduler = [
354
            Scheduler(
355
356
                self.scheduler_config, self.cache_config, self.lora_config,
                self.parallel_config.pipeline_parallel_size,
357
                self.async_callbacks[v_id]
358
359
                if self.model_config.use_async_output_proc else None)
            for v_id in range(self.parallel_config.pipeline_parallel_size)
360
        ]
zhuwenwen's avatar
zhuwenwen committed
361

362
363
        # Metric Logging.
        if self.log_stats:
364
365
366
            if stat_loggers is not None:
                self.stat_loggers = stat_loggers
            else:
367
368
369
370
371
372
373
                # 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)

374
375
376
                self.stat_loggers = {
                    "logging":
                    LoggingStatLogger(
377
378
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC,
                        vllm_config=vllm_config),
379
380
381
                    "prometheus":
                    PrometheusStatLogger(
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC,
382
383
                        labels=dict(
                            model_name=self.model_config.served_model_name),
384
                        vllm_config=vllm_config),
385
386
387
                }
                self.stat_loggers["prometheus"].info("cache_config",
                                                     self.cache_config)
388

389
390
391
392
393
394
        self.tracer = None
        if self.observability_config.otlp_traces_endpoint:
            self.tracer = init_tracer(
                "vllm.llm_engine",
                self.observability_config.otlp_traces_endpoint)

395
396
397
398
399
400
401
402
        # 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,
403
                get_tokenizer_for_seq,
404
405
                stop_checker=StopChecker(
                    self.scheduler_config.max_model_len,
406
                    get_tokenizer_for_seq,
407
408
                ),
            ))
409
410
        
        self.tree_decoding = os.environ.get('VLLM_TREE_DECODING') == '1'
411

412
413
        self.seq_id_to_seq_group: Dict[str, SequenceGroupBase] = {}

414
415
416
        # 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
417
        profile.StartTracer()
418

419
420
421
422
423
424
    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.
        """
425
        start = time.time()
426
427
428
429
430
        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
431
432
433
434
            logger.info(
                "Overriding num_gpu_blocks=%d with "
                "num_gpu_blocks_override=%d", num_gpu_blocks,
                num_gpu_blocks_override)
435
436
437
438
439
440
            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)
441
442
443
        elapsed = time.time() - start
        logger.info(("init engine (profile, create kv cache, "
                     "warmup model) took %.2f seconds"), elapsed)
444

445
    @classmethod
446
    def _get_executor_cls(cls,
447
                          engine_config: VllmConfig) -> Type[ExecutorBase]:
448
        # distributed_executor_backend must be set in VllmConfig.__post_init__
449
450
        distributed_executor_backend = (
            engine_config.parallel_config.distributed_executor_backend)
451
        # Initialize the cluster and specify the executor class.
452
453
454
455
456
457
        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
458
459
460
461
462
463
464
465
466
467
468
469
470
        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.
471
472
            from vllm.executor.uniproc_executor import UniProcExecutor
            executor_class = UniProcExecutor
473
474
475
476
477
478
479
480
        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}")
481
482
        return executor_class

483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
    @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,
        )

499
500
501
502
503
504
505
506
507
    @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.
508
509
510
511
512
513
514
515
516
        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
517
            usage_context=usage_context,
518
            stat_loggers=stat_loggers,
519
            disable_log_stats=engine_args.disable_log_stats,
yhu422's avatar
yhu422 committed
520
        )
521

522
523
524
525
526
    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!")

527
528
529
530
531
532
    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()

533
534
    def get_tokenizer_group(self) -> TokenizerGroup:
        if self.tokenizer is None:
535
536
            raise ValueError("Unable to get tokenizer because "
                             "skip_tokenizer_init is True")
537

538
        return self.tokenizer
539

540
    def get_tokenizer(
541
542
543
        self,
        lora_request: Optional[LoRARequest] = None,
    ) -> AnyTokenizer:
544
        return self.get_tokenizer_group().get_lora_tokenizer(lora_request)
545

546
    def _init_tokenizer(self) -> TokenizerGroup:
547
548
549
        return init_tokenizer_from_configs(
            model_config=self.model_config,
            scheduler_config=self.scheduler_config,
550
            lora_config=self.lora_config)
551

552
553
    def _verify_args(self) -> None:
        self.model_config.verify_with_parallel_config(self.parallel_config)
554
        self.cache_config.verify_with_parallel_config(self.parallel_config)
555
556
557
558
        if self.lora_config:
            self.lora_config.verify_with_model_config(self.model_config)
            self.lora_config.verify_with_scheduler_config(
                self.scheduler_config)
559
560
561
        if self.prompt_adapter_config:
            self.prompt_adapter_config.verify_with_model_config(
                self.model_config)
562

563
564
565
    def _add_processed_request(
        self,
        request_id: str,
566
        processed_inputs: ProcessorInputs,
567
568
569
        params: Union[SamplingParams, PoolingParams],
        arrival_time: float,
        lora_request: Optional[LoRARequest],
570
        prompt_adapter_request: Optional[PromptAdapterRequest],
571
        trace_headers: Optional[Mapping[str, str]] = None,
572
        priority: int = 0,
573
    ) -> Optional[SequenceGroup]:
574
575
576
        """Add a processed request to the engine's request pool.
        return the created sequence group.
        """
577
578
579
580
581
582
583
584
585
586
587
588
589
590
        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

591
        self._validate_model_inputs(processed_inputs, lora_request)
592
593
594
        # Create the sequences.
        block_size = self.cache_config.block_size
        seq_id = next(self.seq_counter)
595
        eos_token_id = self.input_preprocessor.get_eos_token_id(lora_request)
596

597
        encoder_inputs, decoder_inputs = split_enc_dec_inputs(processed_inputs)
598
599

        seq = Sequence(seq_id, decoder_inputs, block_size, eos_token_id,
600
                       lora_request, prompt_adapter_request)
601

602
603
604
        encoder_seq = (None if encoder_inputs is None else Sequence(
            seq_id, encoder_inputs, block_size, eos_token_id, lora_request,
            prompt_adapter_request))
605

606
607
608
609
610
611
612
613
        # 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,
614
                trace_headers=trace_headers,
615
                prompt_adapter_request=prompt_adapter_request,
616
617
                encoder_seq=encoder_seq,
                priority=priority)
618
619
620
621
622
623
624
        elif isinstance(params, PoolingParams):
            seq_group = self._create_sequence_group_with_pooling(
                request_id,
                seq,
                params,
                arrival_time=arrival_time,
                lora_request=lora_request,
625
                prompt_adapter_request=prompt_adapter_request,
626
627
                encoder_seq=encoder_seq,
                priority=priority)
628
629
630
631
        else:
            raise ValueError(
                "Either SamplingParams or PoolingParams must be provided.")

632
633
634
635
636
637
638
639
        # 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)

640
641
        return seq_group

642
643
    def stop_remote_worker_execution_loop(self) -> None:
        self.model_executor.stop_remote_worker_execution_loop()
644

645
    @overload
646
647
648
    def add_request(
        self,
        request_id: str,
649
        prompt: PromptType,
650
        params: Union[SamplingParams, PoolingParams],
651
        arrival_time: Optional[float] = None,
652
        lora_request: Optional[LoRARequest] = None,
653
        trace_headers: Optional[Mapping[str, str]] = None,
654
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
655
        priority: int = 0,
656
    ) -> None:
657
658
659
        ...

    @overload
660
    @deprecated("'inputs' will be renamed to 'prompt")
661
662
663
    def add_request(
        self,
        request_id: str,
664
665
        *,
        inputs: PromptType,
666
        params: Union[SamplingParams, PoolingParams],
667
        arrival_time: Optional[float] = None,
668
        lora_request: Optional[LoRARequest] = None,
669
        trace_headers: Optional[Mapping[str, str]] = None,
670
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
671
        priority: int = 0,
672
    ) -> None:
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
        ...

    @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
691
    ) -> None:
Zhuohan Li's avatar
Zhuohan Li committed
692
        """Add a request to the engine's request pool.
693
694

        The request is added to the request pool and will be processed by the
Zhuohan Li's avatar
Zhuohan Li committed
695
        scheduler as `engine.step()` is called. The exact scheduling policy is
696
697
698
699
        determined by the scheduler.

        Args:
            request_id: The unique ID of the request.
700
            prompt: The prompt to the LLM. See :class:`~vllm.inputs.PromptType`
701
702
703
704
                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.
705
            arrival_time: The arrival time of the request. If None, we use
706
                the current monotonic time.
707
            lora_request: The LoRA request to add.
708
            trace_headers: OpenTelemetry trace headers.
709
            prompt_adapter_request: The prompt adapter request to add.
710
711
            priority: The priority of the request.
                Only applicable with priority scheduling.
712
713
714
715

        Details:
            - Set arrival_time to the current time if it is None.
            - Set prompt_token_ids to the encoded prompt if it is None.
716
            - Create `n` number of :class:`~vllm.Sequence` objects.
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
            - 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
            >>> ...
736
        """
737
738
739
740
        if inputs is not None:
            prompt = inputs
        assert prompt is not None and params is not None

741
742
743
        if lora_request is not None and not self.lora_config:
            raise ValueError(f"Got lora_request {lora_request} but LoRA is "
                             "not enabled!")
744

745
        if priority != 0 and not self.scheduler_config.policy == "priority":
746
747
748
            raise ValueError(f"Got priority {priority} but "
                             "Priority scheduling is not enabled.")

749
750
751
752
753
754
755
        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")

756
        if arrival_time is None:
757
            arrival_time = time.time()
758

759
760
761
762
763
        if self.tokenizer is not None:
            self._validate_token_prompt(
                prompt,
                tokenizer=self.get_tokenizer(lora_request=lora_request))

764
        processed_inputs = self.input_preprocessor.preprocess(
765
            prompt,
766
            lora_request=lora_request,
767
768
            prompt_adapter_request=prompt_adapter_request,
        )
769

770
771
772
773
774
775
        self._add_processed_request(
            request_id=request_id,
            processed_inputs=processed_inputs,
            params=params,
            arrival_time=arrival_time,
            lora_request=lora_request,
776
            prompt_adapter_request=prompt_adapter_request,
777
            trace_headers=trace_headers,
778
            priority=priority,
779
        )
780

781
782
783
784
785
786
787
788
789
790
791
    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.
792
        if is_token_prompt(prompt):
793
794
795
796
797
798
799
800
801
            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))

802
803
804
805
806
    def _create_sequence_group_with_sampling(
        self,
        request_id: str,
        seq: Sequence,
        sampling_params: SamplingParams,
807
808
        arrival_time: float,
        lora_request: Optional[LoRARequest],
809
        trace_headers: Optional[Mapping[str, str]] = None,
810
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
811
        encoder_seq: Optional[Sequence] = None,
812
        priority: int = 0,
813
814
815
816
817
818
819
820
821
822
    ) -> 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.")

823
824
825
        sampling_params = self._build_logits_processors(
            sampling_params, lora_request)

826
827
828
        # Defensive copy of SamplingParams, which are used by the sampler,
        # this doesn't deep-copy LogitsProcessor objects
        sampling_params = sampling_params.clone()
829

830
        sampling_params.update_from_generation_config(
831
            self.generation_config_fields, seq.eos_token_id)
832

833
        # Create the sequence group.
834
835
836
837
        draft_size = 1
        if self.vllm_config.speculative_config is not None:
            draft_size = \
                self.vllm_config.speculative_config.num_speculative_tokens + 1
838
839
840
841
842
843
844
        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,
845
            prompt_adapter_request=prompt_adapter_request,
846
            encoder_seq=encoder_seq,
847
848
            priority=priority,
            draft_size=draft_size)
849

850
851
852
853
854
855
856
        return seq_group

    def _create_sequence_group_with_pooling(
        self,
        request_id: str,
        seq: Sequence,
        pooling_params: PoolingParams,
857
858
        arrival_time: float,
        lora_request: Optional[LoRARequest],
859
        prompt_adapter_request: Optional[PromptAdapterRequest],
860
        encoder_seq: Optional[Sequence] = None,
861
        priority: int = 0,
862
863
864
865
866
    ) -> 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.
867
868
869
870
871
872
        seq_group = SequenceGroup(
            request_id=request_id,
            seqs=[seq],
            arrival_time=arrival_time,
            lora_request=lora_request,
            pooling_params=pooling_params,
873
            prompt_adapter_request=prompt_adapter_request,
874
875
            encoder_seq=encoder_seq,
            priority=priority)
876
        return seq_group
877

Antoni Baum's avatar
Antoni Baum committed
878
879
    def abort_request(self, request_id: Union[str, Iterable[str]]) -> None:
        """Aborts a request(s) with the given ID.
880
881

        Args:
Antoni Baum's avatar
Antoni Baum committed
882
            request_id: The ID(s) of the request to abort.
883
884
885
886
887
888
889
890
891
892
893

        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)
894
        """
895
        for scheduler in self.scheduler:
896
897
            scheduler.abort_seq_group(
                request_id, seq_id_to_seq_group=self.seq_id_to_seq_group)
898

899
900
901
902
    def get_vllm_config(self) -> VllmConfig:
        """Gets the vllm configuration."""
        return self.vllm_config

903
904
905
906
    def get_model_config(self) -> ModelConfig:
        """Gets the model configuration."""
        return self.model_config

907
908
909
910
    def get_parallel_config(self) -> ParallelConfig:
        """Gets the parallel configuration."""
        return self.parallel_config

911
912
913
914
    def get_decoding_config(self) -> DecodingConfig:
        """Gets the decoding configuration."""
        return self.decoding_config

915
916
917
918
919
920
921
922
    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

923
    def get_num_unfinished_requests(self) -> int:
924
        """Gets the number of unfinished requests."""
925
926
        return sum(scheduler.get_num_unfinished_seq_groups()
                   for scheduler in self.scheduler)
927

928
    def has_unfinished_requests(self) -> bool:
929
        """Returns True if there are unfinished requests."""
930
931
932
933
934
935
936
937
938
        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()
939

940
    def reset_prefix_cache(self, device: Optional[Device] = None) -> bool:
941
942
943
944
        """Reset prefix cache for all devices."""

        success = True
        for scheduler in self.scheduler:
945
            success = success and scheduler.reset_prefix_cache(device)
946
947
        return success

948
    @staticmethod
949
950
    def _process_sequence_group_outputs(
        seq_group: SequenceGroup,
951
        outputs: List[PoolingSequenceGroupOutput],
952
    ) -> None:
953
        seq_group.pooled_data = outputs[0].data
954
955
956
957
958
959

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

        return

960
961
962
963
964
965
966
967
    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.

968
        seq_group: SequenceGroup to update the num_computed_tokens for.
969
        seq_group_meta: Metadata of the given SequenceGroup.
970
        is_first_step_output: Optional[bool] -
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
            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)

999
1000
1001
1002
1003
    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.
1004

1005
1006
        ctx: The virtual engine context to work on
        request_id: If provided, then only this request is going to be processed
1007
        """
1008

1009
        now = time.time()
1010

1011
        if len(ctx.output_queue) == 0:
1012
1013
            return None

1014
        # Get pending async postprocessor
1015
1016
1017
1018
        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,
1019
             is_last_step, is_first_step_output, skip) = ctx.output_queue[0]
1020
1021
        else:
            (outputs, seq_group_metadata_list, scheduler_outputs, is_async,
1022
1023
             is_last_step, is_first_step_output,
             skip) = ctx.output_queue.popleft()
1024
1025
1026
1027
1028

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

1029
        has_multiple_outputs: bool = len(outputs) > 1
1030
        outputs_by_sequence_group: List[List[SequenceGroupOutput]]
1031
1032
1033
1034
1035
        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].
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
            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
1053
1054
1055
            # We have outputs for multiple steps submitted in a single burst,
            # so invalidate is_first_step_output.
            is_first_step_output = None
1056
        elif len(outputs) == 1:
1057
            outputs_by_sequence_group = outputs
1058
1059
        else:
            return None
1060

1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
        # 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

1078
        finished_before: List[int] = []
1079
        finished_now: List[int] = []
1080
        empty_seq_indices: List[int] = []
1081
1082
1083
1084
1085
        for i in indices:
            if i in skip:
                continue

            seq_group_meta = seq_group_metadata_list[i]
1086
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1087

1088
            seq_group: SequenceGroup = scheduled_seq_group.seq_group
1089
1090
1091
1092
1093

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

1094
            output: List[SequenceGroupOutput]
1095
            if has_multiple_outputs:
1096
1097
1098
1099
                output = outputs_by_sequence_group[i]
            else:
                output = [outputs_by_sequence_group[0][i]]

1100
            # tree style speculative decoding may generate empty output in first step
1101
1102
1103
1104
1105
1106
1107
1108
1109
            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
1110

1111
            if not is_async:
1112
1113
1114
1115
1116
1117
                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(
1118
                        seq_group_meta.token_chunk_size or 0)
1119
1120
1121

            if outputs:
                for o in outputs:
1122
1123
1124
1125
                    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 += (
1126
                                o.model_forward_time or 0)
1127
1128
1129
1130
1131
                        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 += (
1132
                                o.model_execute_time or 0)
1133
1134
1135
                        else:
                            seq_group.metrics.model_execute_time = (
                                o.model_execute_time)
1136

1137
            if self.model_config.runner_type == "pooling":
1138
                self._process_sequence_group_outputs(seq_group, output)
1139
1140
1141
1142
1143
            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)
1144

1145
1146
            if seq_group.is_finished():
                finished_now.append(i)
1147

1148
1149
1150
        # Generate outputs for the requests that finished this iteration
        for i in finished_now:
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1151

1152
            seq_group = scheduled_seq_group.seq_group
1153
            seq_group.maybe_set_first_token_time(now)
1154
1155
            if not seq_group.is_prefill():
                seq_group.set_last_token_time(now)
1156
            request_output = RequestOutputFactory.create(
1157
1158
1159
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs)
1160
1161
            if request_output:
                ctx.request_outputs.append(request_output)
1162

1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
        # 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

1175
1176
1177
1178
1179
        # Free currently finished requests
        if finished_now:
            for scheduler in self.scheduler:
                scheduler.free_finished_seq_groups()

1180
1181
        # For multi-step without streaming, don't create outputs each iteration
        if not is_last_step and not ctx.multi_step_stream_outputs:
1182
1183
1184
1185
            # 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)
1186
                ctx.request_outputs.clear()
1187
1188
1189
            return

        # Create the outputs
1190
        for i in indices:
1191
            if i in skip or i in finished_before or i in finished_now or i in empty_seq_indices:
1192
1193
                continue  # Avoids double processing

1194
1195
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]

1196
            seq_group = scheduled_seq_group.seq_group
1197
            seq_group.maybe_set_first_token_time(now)
1198
1199
            if not seq_group.is_prefill():
                seq_group.set_last_token_time(now)
1200
            request_output = RequestOutputFactory.create(
1201
1202
1203
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs)
1204
            if request_output:
1205
                ctx.request_outputs.append(request_output)
1206

1207
1208
1209
1210
1211
1212
1213
1214
        # 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

1215
        for seq_group in scheduler_outputs.ignored_seq_groups:
1216
1217
1218
1219
1220
            params = seq_group.sampling_params
            if params is not None and params.output_kind == (
                    RequestOutputKind.DELTA) and not seq_group.is_finished():
                continue

1221
            request_output = RequestOutputFactory.create(
1222
1223
1224
1225
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs,
            )
1226
1227
            if request_output:
                ctx.request_outputs.append(request_output)
1228

1229
1230
1231
1232
        # 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)
1233
            ctx.request_outputs.clear()
1234

1235
1236
1237
1238
        # 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:
1239
            # Log stats.
1240
1241
            self.do_log_stats(scheduler_outputs, outputs, finished_before,
                              skip)
1242
1243

            # Tracing
1244
            self.do_tracing(scheduler_outputs, finished_before)
1245
1246
1247
1248

        return None

    def _advance_to_next_step(
1249
            self, output: SamplerOutput,
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
            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

1263
1264
1265
1266
1267
            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)
1268
            else:
1269
1270
1271
1272
                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)
1273
1274
1275
1276

            if seq_group_metadata.do_sample:
                assert len(sequence_group_outputs.samples) == 1, (
                    "Async output processor expects a single sample"
1277
                    " (i.e sampling_params.n == 1)")
1278
1279
1280
1281
                sample = sequence_group_outputs.samples[0]

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

1283
1284
1285
1286
1287
1288
1289
1290
                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)
1291

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

1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
        .. 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.

1310
            - Step 2: Calls the distributed executor to execute the model.
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
            - 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)
1332
            >>>         engine.add_request(str(req_id),prompt,sampling_params)
1333
1334
1335
1336
1337
1338
1339
1340
1341
            >>>
            >>>     # 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
1342
        """
1343
1344
1345
1346
        if self.parallel_config.pipeline_parallel_size > 1:
            raise NotImplementedError(
                "Pipeline parallelism is only supported through AsyncLLMEngine "
                "as performance will be severely degraded otherwise.")
1347

1348
        # For llm_engine, there is no pipeline parallel support, so the engine
1349
        # used is always 0.
1350
1351
        virtual_engine = 0

1352
1353
        # These are cached outputs from previous iterations. None if on first
        # iteration
1354
        cached_outputs = self.cached_scheduler_outputs[virtual_engine]
1355
1356
        seq_group_metadata_list = cached_outputs.seq_group_metadata_list
        scheduler_outputs = cached_outputs.scheduler_outputs
1357
        allow_async_output_proc = cached_outputs.allow_async_output_proc
1358

1359
1360
        ctx = self.scheduler_contexts[virtual_engine]

1361
1362
1363
        # Clear outputs for each new scheduler iteration
        ctx.request_outputs.clear()

1364
1365
1366
        # 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.
1367
1368
1369
1370
1371
        # 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:
1372
            # Schedule iteration
1373
            (seq_group_metadata_list, scheduler_outputs,
1374
1375
             allow_async_output_proc
             ) = self.scheduler[virtual_engine].schedule()
1376

1377
1378
            ctx.seq_group_metadata_list = seq_group_metadata_list
            ctx.scheduler_outputs = scheduler_outputs
1379

1380
1381
            finished_requests_ids = self.scheduler[
                virtual_engine].get_and_reset_finished_requests_ids()
1382
1383
1384
1385
1386
            # 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]
1387

1388
1389
            # Maybe switch from async mode to sync mode
            if not allow_async_output_proc and len(ctx.output_queue) > 0:
1390
                self._process_model_outputs(ctx=ctx)
1391

1392
1393
1394
1395
1396
            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(
1397
                    virtual_engine, seq_group_metadata_list, scheduler_outputs,
1398
                    allow_async_output_proc)
1399
1400
        else:
            finished_requests_ids = list()
1401
1402
1403

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

1405
        if not scheduler_outputs.is_empty():
1406
1407
1408
1409
1410
1411

            # 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 = \
1412
                self._get_last_sampled_token_ids(virtual_engine)
1413

1414
            execute_model_req = ExecuteModelRequest(
1415
1416
1417
1418
                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,
1419
1420
                num_lookahead_slots=scheduler_outputs.num_lookahead_slots,
                running_queue_size=scheduler_outputs.running_queue_size,
1421
1422
1423
1424
1425
                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)

1426
            if allow_async_output_proc:
1427
1428
                execute_model_req.async_callback = self.async_callbacks[
                    virtual_engine]
1429

1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
            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
1447

1448
            # We need to do this here so that last step's sampled_token_ids can
1449
1450
            # be passed to the next iteration for PP.
            if self.scheduler_config.is_multi_step:
1451
                self._update_cached_scheduler_output(virtual_engine, outputs)
1452
        else:
1453
1454
            # Nothing scheduled => If there is pending async postprocessor,
            # then finish it here.
1455
1456
            if len(ctx.output_queue) > 0:
                self._process_model_outputs(ctx=ctx)
1457
            # No outputs in this case
1458
            outputs = []
Antoni Baum's avatar
Antoni Baum committed
1459

1460
1461
1462
1463
1464
1465
        # 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):
1466
            # clear the cache if we have finished all the steps.
1467
1468
1469
            if self.scheduler_config.is_multi_step:
                self.cached_scheduler_outputs[0] = SchedulerOutputState()

1470
1471
1472
1473
1474
1475
            # 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

1476
            # Add results to the output_queue
1477
1478
1479
1480
            ctx.append_output(outputs=outputs,
                              seq_group_metadata_list=seq_group_metadata_list,
                              scheduler_outputs=scheduler_outputs,
                              is_async=allow_async_output_proc,
1481
1482
                              is_last_step=True,
                              is_first_step_output=is_first_step_output)
1483
1484
1485

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

1488
                self._advance_to_next_step(
1489
                    outputs[0], seq_group_metadata_list,
1490
                    scheduler_outputs.scheduled_seq_groups)
1491

1492
            # Check if need to run the usual non-async path
1493
            if not allow_async_output_proc:
1494
                self._process_model_outputs(ctx=ctx)
1495

1496
                # Log stats.
1497
                self.do_log_stats(scheduler_outputs, outputs)
1498

1499
1500
1501
                # Tracing
                self.do_tracing(scheduler_outputs)
        else:
1502
            # Multi-step case
1503
            return ctx.request_outputs
1504

1505
        if not self.has_unfinished_requests():
1506
1507
            # Drain async postprocessor (if exists)
            if len(ctx.output_queue) > 0:
1508
                self._process_model_outputs(ctx=ctx)
1509
            assert len(ctx.output_queue) == 0
1510

1511
1512
1513
1514
1515
            # 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.
1516
            logger.debug("Stopping remote worker execution loop.")
1517
1518
            self.model_executor.stop_remote_worker_execution_loop()

1519
        return ctx.request_outputs
Antoni Baum's avatar
Antoni Baum committed
1520

1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
    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)

1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
    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:]
        ]):
1568
1569
            raise AssertionError("All running sequence groups should "
                                 "have the same remaining steps.")
1570
1571
1572
1573
1574
1575

        return ref_remaining_steps > 0

    def _cache_scheduler_outputs_for_multi_step(
            self, virtual_engine: int,
            seq_group_metadata_list: Optional[List[SequenceGroupMetadata]],
1576
1577
1578
1579
1580
1581
1582
1583
            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
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607

    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
1608

1609
    def add_logger(self, logger_name: str, logger: StatLoggerBase) -> None:
1610
1611
1612
1613
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1614
1615
1616
1617
1618
        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:
1619
1620
1621
1622
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1623
1624
1625
1626
        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]

1627
1628
1629
    def do_log_stats(self,
                     scheduler_outputs: Optional[SchedulerOutputs] = None,
                     model_output: Optional[List[SamplerOutput]] = None,
1630
1631
                     finished_before: Optional[List[int]] = None,
                     skip: Optional[List[int]] = None) -> None:
1632
1633
        """Forced log when no requests active."""
        if self.log_stats:
1634
            stats = self._get_stats(scheduler_outputs, model_output,
1635
                                    finished_before, skip)
1636
            for logger in self.stat_loggers.values():
1637
                logger.log(stats)
1638

1639
1640
1641
    def _get_stats(self,
                   scheduler_outputs: Optional[SchedulerOutputs],
                   model_output: Optional[List[SamplerOutput]] = None,
1642
1643
                   finished_before: Optional[List[int]] = None,
                   skip: Optional[List[int]] = None) -> Stats:
1644
1645
1646
1647
1648
1649
1650
        """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.
1651
1652
1653
1654
            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.
1655
        """
1656
        now = time.time()
Woosuk Kwon's avatar
Woosuk Kwon committed
1657

1658
1659
        # System State
        #   Scheduler State
1660
1661
1662
1663
1664
1665
        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)
1666
1667

        # KV Cache Usage in %
1668
        num_total_gpu = self.cache_config.num_gpu_blocks
1669
        gpu_cache_usage_sys = 0.
1670
        if num_total_gpu:  # Guard against both None and 0
1671
1672
1673
            num_free_gpu = sum(
                scheduler.block_manager.get_num_free_gpu_blocks()
                for scheduler in self.scheduler)
1674
            gpu_cache_usage_sys = 1.0 - (num_free_gpu / num_total_gpu)
Woosuk Kwon's avatar
Woosuk Kwon committed
1675

1676
        num_total_cpu = self.cache_config.num_cpu_blocks
1677
        cpu_cache_usage_sys = 0.
1678
        if num_total_cpu:  # Guard against both None and 0
1679
1680
1681
            num_free_cpu = sum(
                scheduler.block_manager.get_num_free_cpu_blocks()
                for scheduler in self.scheduler)
1682
1683
            cpu_cache_usage_sys = 1.0 - (num_free_cpu / num_total_cpu)

1684
1685
1686
1687
1688
1689
1690
        # 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)

1691
1692
1693
        # Iteration stats
        num_prompt_tokens_iter = 0
        num_generation_tokens_iter = 0
harrywu's avatar
harrywu committed
1694
        num_tokens_iter = 0
1695
1696
        time_to_first_tokens_iter: List[float] = []
        time_per_output_tokens_iter: List[float] = []
1697
1698
        num_preemption_iter = (0 if scheduler_outputs is None else
                               scheduler_outputs.preempted)
1699
1700
1701
1702

        # Request stats
        #   Latency
        time_e2e_requests: List[float] = []
harrywu's avatar
harrywu committed
1703
1704
1705
1706
        time_queue_requests: List[float] = []
        time_inference_requests: List[float] = []
        time_prefill_requests: List[float] = []
        time_decode_requests: List[float] = []
1707
1708
1709
        time_in_queue_requests: List[float] = []
        model_forward_time_requests: List[float] = []
        model_execute_time_requests: List[float] = []
1710
1711
1712
1713
        #   Metadata
        num_prompt_tokens_requests: List[int] = []
        num_generation_tokens_requests: List[int] = []
        n_requests: List[int] = []
harrywu's avatar
harrywu committed
1714
        max_num_generation_tokens_requests: List[int] = []
1715
        max_tokens_requests: List[int] = []
1716
1717
        finished_reason_requests: List[str] = []

1718
        # LoRA requests
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
        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)

1737
1738
        # NOTE: This loop assumes prefill seq_groups are before
        # decode seq_groups in scheduled_seq_groups.
1739
        if scheduler_outputs is not None:
1740
1741
1742
1743
            # 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

1744
            num_generation_tokens_from_prefill_groups = 0
1745
1746
1747
1748
            # 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.
1749
1750
1751

            for idx, scheduled_seq_group in enumerate(
                    scheduler_outputs.scheduled_seq_groups):
1752
1753
1754
1755
1756
                # Skip double logging when using async output proc
                if finished_before and idx in finished_before:
                    actual_num_batched_tokens -= 1
                    continue

1757
1758
1759
1760
                # Currently, skip == preempted sequences, so we need to skip
                # their log stats
                if skip and idx in skip:
                    continue
1761

1762
                group_was_prefill = idx < scheduler_outputs.num_prefill_groups
1763
                seq_group = scheduled_seq_group.seq_group
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775

                # 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():
1776
                        latency = seq_group.get_last_token_latency()
1777
1778
1779
1780
1781
1782
1783
                        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.
1784
                    latency = seq_group.get_last_token_latency()
1785
                    time_per_output_tokens_iter.append(latency)
1786
1787
1788
1789
1790
1791
1792
1793
1794
                    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
1795
1796
1797
1798
1799
1800

                # 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.
1801
                if seq_group.is_finished():
1802
                    # Latency timings
1803
1804
                    time_e2e_requests.append(now -
                                             seq_group.metrics.arrival_time)
harrywu's avatar
harrywu committed
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
                    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)
1817
1818
1819
1820
1821
1822
1823
1824
1825
                    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)
1826
1827
1828
1829
1830
1831
1832
                    # 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
1833
1834
1835
                    max_num_generation_tokens_requests.append(
                        max(seq.get_output_len()
                            for seq in seq_group.get_seqs()))
1836
1837
                    if seq_group.sampling_params is not None:
                        n_requests.append(seq_group.sampling_params.n)
1838
1839
                        max_tokens_requests.append(
                            seq_group.sampling_params.max_tokens)
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
                    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 = (
1852
                actual_num_batched_tokens - num_prompt_tokens_iter +
1853
                num_generation_tokens_from_prefill_groups)
harrywu's avatar
harrywu committed
1854
1855
            num_tokens_iter = (num_generation_tokens_iter +
                               num_prompt_tokens_iter)
1856
1857
        # Spec decode, if enabled, emits specialized metrics from the worker in
        # sampler output.
1858
1859
        if model_output and isinstance(model_output[0], SamplerOutput) and (
                model_output[0].spec_decode_worker_metrics is not None):
1860
1861
1862
1863
            spec_decode_metrics = model_output[0].spec_decode_worker_metrics
        else:
            spec_decode_metrics = None

1864
1865
        return Stats(
            now=now,
1866
1867
1868
1869
1870
1871
1872
1873
            # 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,
1874
1875
1876
            #   Prefix Cache Hit Rate
            cpu_prefix_cache_hit_rate=cpu_prefix_cache_hit_rate,
            gpu_prefix_cache_hit_rate=gpu_prefix_cache_hit_rate,
1877
1878
1879
1880

            # Iteration stats
            num_prompt_tokens_iter=num_prompt_tokens_iter,
            num_generation_tokens_iter=num_generation_tokens_iter,
harrywu's avatar
harrywu committed
1881
            num_tokens_iter=num_tokens_iter,
1882
1883
            time_to_first_tokens_iter=time_to_first_tokens_iter,
            time_per_output_tokens_iter=time_per_output_tokens_iter,
1884
            spec_decode_metrics=spec_decode_metrics,
1885
            num_preemption_iter=num_preemption_iter,
1886
1887
1888
1889

            # Request stats
            #   Latency
            time_e2e_requests=time_e2e_requests,
harrywu's avatar
harrywu committed
1890
1891
1892
1893
            time_queue_requests=time_queue_requests,
            time_inference_requests=time_inference_requests,
            time_prefill_requests=time_prefill_requests,
            time_decode_requests=time_decode_requests,
1894
1895
1896
            time_in_queue_requests=time_in_queue_requests,
            model_forward_time_requests=model_forward_time_requests,
            model_execute_time_requests=model_execute_time_requests,
1897
1898
1899
            #   Metadata
            num_prompt_tokens_requests=num_prompt_tokens_requests,
            num_generation_tokens_requests=num_generation_tokens_requests,
harrywu's avatar
harrywu committed
1900
1901
            max_num_generation_tokens_requests=
            max_num_generation_tokens_requests,
1902
            n_requests=n_requests,
1903
            max_tokens_requests=max_tokens_requests,
1904
            finished_reason_requests=finished_reason_requests,
1905
1906
1907
            max_lora=str(max_lora_stat),
            waiting_lora_adapters=list(waiting_lora_adapters.keys()),
            running_lora_adapters=list(running_lora_adapters.keys()))
1908

1909
    def add_lora(self, lora_request: LoRARequest) -> bool:
1910
        return self.model_executor.add_lora(lora_request)
1911
1912

    def remove_lora(self, lora_id: int) -> bool:
1913
        return self.model_executor.remove_lora(lora_id)
1914

1915
    def list_loras(self) -> Set[int]:
1916
        return self.model_executor.list_loras()
1917

1918
1919
1920
    def pin_lora(self, lora_id: int) -> bool:
        return self.model_executor.pin_lora(lora_id)

1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
    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()

1931
1932
1933
1934
1935
1936
    def start_profile(self) -> None:
        self.model_executor.start_profile()

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

1937
1938
1939
1940
1941
    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)

1942
    def wake_up(self, tags: Optional[list[str]] = None) -> None:
1943
1944
        assert self.vllm_config.model_config.enable_sleep_mode, (
            "Sleep mode is not enabled in the model config")
1945
        self.model_executor.wake_up(tags)
1946

1947
1948
1949
    def is_sleeping(self) -> bool:
        return self.model_executor.is_sleeping

1950
    def check_health(self) -> None:
1951
        self.model_executor.check_health()
1952
1953
1954
1955

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

1956
1957
1958
    def do_tracing(self,
                   scheduler_outputs: SchedulerOutputs,
                   finished_before: Optional[List[int]] = None) -> None:
1959
1960
1961
        if self.tracer is None:
            return

1962
1963
1964
1965
1966
1967
        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

1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
            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
1987
            seq_span.set_attribute(SpanAttributes.GEN_AI_RESPONSE_MODEL,
1988
                                   self.model_config.model)
1989
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_ID,
1990
                                   seq_group.request_id)
1991
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_TEMPERATURE,
1992
                                   seq_group.sampling_params.temperature)
1993
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_TOP_P,
1994
                                   seq_group.sampling_params.top_p)
1995
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_MAX_TOKENS,
1996
                                   seq_group.sampling_params.max_tokens)
1997
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_N,
1998
                                   seq_group.sampling_params.n)
1999
            seq_span.set_attribute(SpanAttributes.GEN_AI_USAGE_NUM_SEQUENCES,
2000
                                   seq_group.num_seqs())
2001
            seq_span.set_attribute(SpanAttributes.GEN_AI_USAGE_PROMPT_TOKENS,
2002
2003
                                   len(seq_group.prompt_token_ids))
            seq_span.set_attribute(
2004
                SpanAttributes.GEN_AI_USAGE_COMPLETION_TOKENS,
2005
2006
2007
2008
                sum([
                    seq.get_output_len()
                    for seq in seq_group.get_finished_seqs()
                ]))
2009
            seq_span.set_attribute(SpanAttributes.GEN_AI_LATENCY_TIME_IN_QUEUE,
2010
2011
                                   metrics.time_in_queue)
            seq_span.set_attribute(
2012
2013
                SpanAttributes.GEN_AI_LATENCY_TIME_TO_FIRST_TOKEN, ttft)
            seq_span.set_attribute(SpanAttributes.GEN_AI_LATENCY_E2E, e2e_time)
2014
2015
            if metrics.scheduler_time is not None:
                seq_span.set_attribute(
2016
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_SCHEDULER,
2017
2018
2019
                    metrics.scheduler_time)
            if metrics.model_forward_time is not None:
                seq_span.set_attribute(
2020
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_MODEL_FORWARD,
2021
2022
2023
                    metrics.model_forward_time / 1000.0)
            if metrics.model_execute_time is not None:
                seq_span.set_attribute(
2024
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_MODEL_EXECUTE,
2025
                    metrics.model_execute_time)
2026

2027
    def _validate_model_inputs(self, inputs: ProcessorInputs,
2028
                               lora_request: Optional[LoRARequest]):
2029
2030
        encoder_inputs, decoder_inputs = split_enc_dec_inputs(inputs)

2031
2032
2033
2034
        if encoder_inputs is not None:
            self._validate_model_input(encoder_inputs,
                                       lora_request,
                                       prompt_type="encoder")
2035

2036
2037
2038
        self._validate_model_input(decoder_inputs,
                                   lora_request,
                                   prompt_type="decoder")
2039

2040
2041
2042
2043
2044
2045
2046
    def _validate_model_input(
        self,
        prompt_inputs: SingletonInputs,
        lora_request: Optional[LoRARequest],
        *,
        prompt_type: Literal["encoder", "decoder"],
    ):
2047
2048
2049
        model_config = self.model_config
        tokenizer = (None if self.tokenizer is None else
                     self.tokenizer.get_lora_tokenizer(lora_request))
2050

2051
2052
2053
2054
2055
2056
2057
2058
        prompt_ids = prompt_inputs["prompt_token_ids"]
        if not prompt_ids:
            if prompt_type == "encoder" and model_config.is_multimodal_model:
                pass  # Mllama may have empty encoder inputs for text-only data
            else:
                raise ValueError(f"The {prompt_type} prompt cannot be empty")

        max_prompt_len = self.model_config.max_model_len
2059
        if len(prompt_ids) > max_prompt_len:
2060
            if prompt_type == "encoder" and model_config.is_multimodal_model:
2061
2062
                mm_registry = self.input_preprocessor.mm_registry
                mm_processor = mm_registry.create_processor(
2063
2064
2065
                    model_config,
                    tokenizer=tokenizer or object(),  # Dummy if no tokenizer
                )
2066
                assert isinstance(mm_processor, EncDecMultiModalProcessor)
2067

2068
2069
2070
                if mm_processor.pad_dummy_encoder_prompt:
                    return  # Skip encoder length check for Whisper

2071
            if model_config.is_multimodal_model:
2072
                suggestion = (
2073
2074
2075
2076
                    "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.")
2077
2078
2079
2080
2081
2082
2083
2084
2085
            else:
                suggestion = (
                    "Make sure that `max_model_len` is no smaller than the "
                    "number of text tokens.")

            raise ValueError(
                f"The {prompt_type} prompt (length {len(prompt_ids)}) is "
                f"longer than the maximum model length of {max_prompt_len}. "
                f"{suggestion}")
2086
2087
2088
2089

            # 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
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099

    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 = []
2100

2101
2102
2103
2104
2105
        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
2106
2107
2108
2109
2110
2111
2112
2113
2114

            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

2115
2116
2117
            if self.decoding_config.reasoning_backend is not None:
                logger.debug("Building with reasoning backend %s",
                             self.decoding_config.reasoning_backend)
2118

2119
            processor = get_local_guided_decoding_logits_processor(
2120
2121
                guided_params=guided_decoding,
                tokenizer=tokenizer,
2122
2123
2124
                model_config=self.model_config,
                reasoning_backend=self.decoding_config.reasoning_backend,
            )
2125
2126
2127
2128
2129
2130
2131
2132
2133
            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)

2134
            processors = get_openai_logits_processors(
2135
2136
2137
2138
2139
2140
2141
2142
2143
                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

2144
2145
2146
2147
2148
2149
        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)

2150
2151
2152
2153
2154
2155
2156
        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
2157

2158
2159
2160
2161
2162
2163
2164
2165
    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)

2166

2167
2168
2169
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