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

14
import torch
15
from typing_extensions import TypeVar, deprecated
16

17
import vllm.envs as envs
18
19
20
from vllm.config import (DecodingConfig, LoRAConfig, ModelConfig,
                         ObservabilityConfig, ParallelConfig, SchedulerConfig,
                         VllmConfig)
21
22
from vllm.core.scheduler import (ScheduledSequenceGroup, Scheduler,
                                 SchedulerOutputs)
Woosuk Kwon's avatar
Woosuk Kwon committed
23
from vllm.engine.arg_utils import EngineArgs
24
from vllm.engine.metrics_types import StatLoggerBase, Stats
25
26
27
28
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
29
30
from vllm.entrypoints.openai.logits_processors import (
    get_logits_processors as get_openai_logits_processors)
31
from vllm.executor.executor_base import ExecutorBase
32
from vllm.inputs import (INPUT_REGISTRY, InputRegistry, ProcessorInputs,
33
                         PromptType, SingletonInputsAdapter)
34
from vllm.inputs.parse import is_encoder_decoder_inputs, is_token_prompt
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.outputs import (PoolingRequestOutput, RequestOutput,
44
45
                          RequestOutputFactory)
from vllm.pooling_params import PoolingParams
46
from vllm.prompt_adapter.request import PromptAdapterRequest
47
from vllm.sampling_params import RequestOutputKind, SamplingParams
48
49
50
from vllm.sequence import (ExecuteModelRequest, ParallelSampleSequenceGroup,
                           PoolingSequenceGroupOutput, Sequence, SequenceGroup,
                           SequenceGroupBase, SequenceGroupMetadata,
zhuwenwen's avatar
zhuwenwen committed
51
                           SequenceGroupOutput, SequenceStatus, CompletionSequenceGroupOutput, VLLM_INVALID_TOKEN_ID)
52
53
from vllm.tracing import (SpanAttributes, SpanKind, extract_trace_context,
                          init_tracer)
54
from vllm.transformers_utils.detokenizer import Detokenizer
55
from vllm.transformers_utils.tokenizer import AnyTokenizer
56
from vllm.transformers_utils.tokenizer_group import (
57
    BaseTokenizerGroup, init_tokenizer_from_configs)
yhu422's avatar
yhu422 committed
58
59
from vllm.usage.usage_lib import (UsageContext, is_usage_stats_enabled,
                                  usage_message)
60
from vllm.utils import Counter, Device, deprecate_kwargs, weak_bind
61
from vllm.version import __version__ as VLLM_VERSION
62
63

logger = init_logger(__name__)
64
_LOCAL_LOGGING_INTERVAL_SEC = 5
Woosuk Kwon's avatar
Woosuk Kwon committed
65

66
_G = TypeVar("_G", bound=BaseTokenizerGroup, default=BaseTokenizerGroup)
67
_O = TypeVar("_O", RequestOutput, PoolingRequestOutput)
68
69


70
71
72
73
74
@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
75
76
    allow_async_output_proc: bool = False
    last_output: Optional[SamplerOutput] = None
77
78


79
80
81
82
83
84
class OutputData(NamedTuple):
    outputs: List[SamplerOutput]
    seq_group_metadata_list: List[SequenceGroupMetadata]
    scheduler_outputs: SchedulerOutputs
    is_async: bool
    is_last_step: bool
85
86
87
88
89
90
    # 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]
91
92
93
    skip: List[int]


94
class SchedulerContext:
95

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

104
105
        self.multi_step_stream_outputs: bool = multi_step_stream_outputs

106
107
108
    def append_output(self, outputs: List[SamplerOutput],
                      seq_group_metadata_list: List[SequenceGroupMetadata],
                      scheduler_outputs: SchedulerOutputs, is_async: bool,
109
110
                      is_last_step: bool,
                      is_first_step_output: Optional[bool]):
111
112
113
114
115
116
        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,
117
                       is_first_step_output=is_first_step_output,
118
                       skip=[]))
119
120


121
class LLMEngine:
Zhuohan Li's avatar
Zhuohan Li committed
122
    """An LLM engine that receives requests and generates texts.
123

Woosuk Kwon's avatar
Woosuk Kwon committed
124
    This is the main class for the vLLM engine. It receives requests
125
126
127
128
129
130
    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.

131
132
    The :class:`~vllm.LLM` class wraps this class for offline batched inference
    and the :class:`AsyncLLMEngine` class wraps this class for online serving.
133

134
    The config arguments are derived from :class:`~vllm.EngineArgs`. (See
135
    :ref:`engine-args`)
136
137
138
139
140
141
142

    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.
143
        device_config: The configuration related to the device.
144
145
146
        lora_config (Optional): The configuration related to serving multi-LoRA.
        speculative_config (Optional): The configuration related to speculative
            decoding.
147
148
        executor_class: The model executor class for managing distributed
            execution.
149
        prompt_adapter_config (Optional): The configuration related to serving
150
            prompt adapters.
151
        log_stats: Whether to log statistics.
152
        usage_context: Specified entry point, used for usage info collection.
153
    """
154

155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
    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)}")

180
        return cast(_O, output)
181
182
183

    @classmethod
    def validate_outputs(
zhuwenwen's avatar
zhuwenwen committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
        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

202
203
204
205
        return outputs_

    tokenizer: Optional[BaseTokenizerGroup]

206
207
    def __init__(
        self,
208
        vllm_config: VllmConfig,
209
        executor_class: Type[ExecutorBase],
210
        log_stats: bool,
yhu422's avatar
yhu422 committed
211
        usage_context: UsageContext = UsageContext.ENGINE_CONTEXT,
212
        stat_loggers: Optional[Dict[str, StatLoggerBase]] = None,
213
        input_registry: InputRegistry = INPUT_REGISTRY,
214
        mm_registry: MultiModalRegistry = MULTIMODAL_REGISTRY,
215
        use_cached_outputs: bool = False,
216
    ) -> None:
217

218
        self.vllm_config = vllm_config
219
220
221
222
223
224
225
226
227
        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
228
        )
229
230
        self.prompt_adapter_config = vllm_config.prompt_adapter_config  # noqa
        self.observability_config = vllm_config.observability_config or ObservabilityConfig(  # noqa
231
232
        )

233
        logger.info(
234
            "Initializing a V0 LLM engine (v%s) with config: %s, "
235
            "use_cached_outputs=%s, ",
236
            VLLM_VERSION,
237
            vllm_config,
238
            use_cached_outputs,
239
        )
240

241
        self.log_stats = log_stats
242
        self.use_cached_outputs = use_cached_outputs
243

244
        if not self.model_config.skip_tokenizer_init:
245
            self.tokenizer = self._init_tokenizer()
246
            self.detokenizer = Detokenizer(self.tokenizer)
247
            tokenizer_group = self.get_tokenizer_group()
248
249
        else:
            self.tokenizer = None
250
            self.detokenizer = None
251
252
253
254
255
256
257
258
            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)
259

260
        self.seq_counter = Counter()
261
262
        self.generation_config_fields = (
            self.model_config.try_get_generation_config())
263

264
        self.input_preprocessor = InputPreprocessor(self.model_config,
265
266
                                                    self.tokenizer,
                                                    mm_registry)
267

268
269
        self.input_registry = input_registry
        self.input_processor = input_registry.create_input_processor(
270
            self.model_config)
271

272
        self.model_executor = executor_class(vllm_config=vllm_config, )
273

274
        if self.model_config.runner_type != "pooling":
275
            self._initialize_kv_caches()
276

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

                    # Quantization
                    "quantization":
297
                    self.model_config.quantization,
yhu422's avatar
yhu422 committed
298
                    "kv_cache_dtype":
299
                    str(self.cache_config.cache_dtype),
yhu422's avatar
yhu422 committed
300
301
302

                    # Feature flags
                    "enable_lora":
303
                    bool(self.lora_config),
304
                    "enable_prompt_adapter":
305
                    bool(self.prompt_adapter_config),
yhu422's avatar
yhu422 committed
306
                    "enable_prefix_caching":
307
                    self.cache_config.enable_prefix_caching,
yhu422's avatar
yhu422 committed
308
                    "enforce_eager":
309
                    self.model_config.enforce_eager,
yhu422's avatar
yhu422 committed
310
                    "disable_custom_all_reduce":
311
                    self.parallel_config.disable_custom_all_reduce,
yhu422's avatar
yhu422 committed
312
                })
zhuwenwen's avatar
zhuwenwen committed
313

314
315
316
317
        if self.tokenizer:
            # Ping the tokenizer to ensure liveness if it runs in a
            # different process.
            self.tokenizer.ping()
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
        self.scheduler = [
349
            Scheduler(
350
351
                self.scheduler_config, self.cache_config, self.lora_config,
                self.parallel_config.pipeline_parallel_size,
352
                self.async_callbacks[v_id]
353
354
                if self.model_config.use_async_output_proc else None)
            for v_id in range(self.parallel_config.pipeline_parallel_size)
355
        ]
zhuwenwen's avatar
zhuwenwen committed
356

357
358
        # Metric Logging.
        if self.log_stats:
359
360
361
            if stat_loggers is not None:
                self.stat_loggers = stat_loggers
            else:
362
363
364
365
366
367
368
                # 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)

369
370
371
                self.stat_loggers = {
                    "logging":
                    LoggingStatLogger(
372
373
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC,
                        vllm_config=vllm_config),
374
375
376
                    "prometheus":
                    PrometheusStatLogger(
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC,
377
378
                        labels=dict(
                            model_name=self.model_config.served_model_name),
379
                        vllm_config=vllm_config),
380
381
382
                }
                self.stat_loggers["prometheus"].info("cache_config",
                                                     self.cache_config)
383

384
385
386
387
388
389
        self.tracer = None
        if self.observability_config.otlp_traces_endpoint:
            self.tracer = init_tracer(
                "vllm.llm_engine",
                self.observability_config.otlp_traces_endpoint)

390
391
392
393
394
395
396
397
        # 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,
398
                get_tokenizer_for_seq,
399
400
                stop_checker=StopChecker(
                    self.scheduler_config.max_model_len,
401
                    get_tokenizer_for_seq,
402
403
                ),
            ))
404
405
        
        self.tree_decoding = os.environ.get('VLLM_TREE_DECODING') == '1'
406

407
408
        self.seq_id_to_seq_group: Dict[str, SequenceGroupBase] = {}

409
410
411
412
413
414
    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.
        """
415
        start = time.time()
416
417
418
419
420
        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
421
422
423
424
            logger.info(
                "Overriding num_gpu_blocks=%d with "
                "num_gpu_blocks_override=%d", num_gpu_blocks,
                num_gpu_blocks_override)
425
426
427
428
429
430
            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)
431
432
433
        elapsed = time.time() - start
        logger.info(("init engine (profile, create kv cache, "
                     "warmup model) took %.2f seconds"), elapsed)
434

435
    @classmethod
436
    def _get_executor_cls(cls,
437
                          engine_config: VllmConfig) -> Type[ExecutorBase]:
438
439
        distributed_executor_backend = (
            engine_config.parallel_config.distributed_executor_backend)
440
        # Initialize the cluster and specify the executor class.
441
442
443
444
445
446
        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
447
        elif engine_config.parallel_config.world_size > 1:
448
            if distributed_executor_backend == "ray":
449
450
451
                from vllm.executor.ray_distributed_executor import (
                    RayDistributedExecutor)
                executor_class = RayDistributedExecutor
452
            elif distributed_executor_backend == "mp":
453
454
455
456
457
458
459
460
461
462
                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.
                from vllm.executor.uniproc_executor import UniProcExecutor
                executor_class = UniProcExecutor
463
464
465
466
467
            elif distributed_executor_backend == "external_launcher":
                # executor with external launcher
                from vllm.executor.uniproc_executor import (  # noqa
                    ExecutorWithExternalLauncher)
                executor_class = ExecutorWithExternalLauncher
468
        else:
469
470
            from vllm.executor.uniproc_executor import UniProcExecutor
            executor_class = UniProcExecutor
471
472
473
474
475
476
477
478
479
480
481
        return executor_class

    @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.
482
        engine_config = engine_args.create_engine_config(usage_context)
483
        executor_class = cls._get_executor_cls(engine_config)
484
        # Create the LLM engine.
yhu422's avatar
yhu422 committed
485
        engine = cls(
486
            vllm_config=engine_config,
yhu422's avatar
yhu422 committed
487
488
489
            executor_class=executor_class,
            log_stats=not engine_args.disable_log_stats,
            usage_context=usage_context,
490
            stat_loggers=stat_loggers,
yhu422's avatar
yhu422 committed
491
        )
492

493
        return engine
494

495
496
497
498
499
    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!")

500
501
502
503
504
505
    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()

506
    def get_tokenizer_group(
507
508
509
510
511
512
        self,
        group_type: Type[_G] = BaseTokenizerGroup,
    ) -> _G:
        tokenizer_group = self.tokenizer

        if tokenizer_group is None:
513
514
            raise ValueError("Unable to get tokenizer because "
                             "skip_tokenizer_init is True")
515
516
517
518
        if not isinstance(tokenizer_group, group_type):
            raise TypeError("Invalid type of tokenizer group. "
                            f"Expected type: {group_type}, but "
                            f"found type: {type(tokenizer_group)}")
519

520
        return tokenizer_group
521

522
    def get_tokenizer(
523
524
525
        self,
        lora_request: Optional[LoRARequest] = None,
    ) -> AnyTokenizer:
526
        return self.get_tokenizer_group().get_lora_tokenizer(lora_request)
527

528
529
530
531
532
    def _init_tokenizer(self) -> BaseTokenizerGroup:
        return init_tokenizer_from_configs(
            model_config=self.model_config,
            scheduler_config=self.scheduler_config,
            parallel_config=self.parallel_config,
533
            lora_config=self.lora_config)
534

535
536
    def _verify_args(self) -> None:
        self.model_config.verify_with_parallel_config(self.parallel_config)
537
        self.cache_config.verify_with_parallel_config(self.parallel_config)
538
539
540
541
        if self.lora_config:
            self.lora_config.verify_with_model_config(self.model_config)
            self.lora_config.verify_with_scheduler_config(
                self.scheduler_config)
542
543
544
        if self.prompt_adapter_config:
            self.prompt_adapter_config.verify_with_model_config(
                self.model_config)
545

546
547
548
    def _add_processed_request(
        self,
        request_id: str,
549
        processed_inputs: ProcessorInputs,
550
551
552
        params: Union[SamplingParams, PoolingParams],
        arrival_time: float,
        lora_request: Optional[LoRARequest],
553
        prompt_adapter_request: Optional[PromptAdapterRequest],
554
        trace_headers: Optional[Mapping[str, str]] = None,
555
        priority: int = 0,
556
    ) -> Optional[SequenceGroup]:
557
558
559
        """Add a processed request to the engine's request pool.
        return the created sequence group.
        """
560
561
562
563
564
565
566
567
568
569
570
571
572
573
        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

574
        self._validate_model_inputs(processed_inputs, lora_request)
575
576
577
        # Create the sequences.
        block_size = self.cache_config.block_size
        seq_id = next(self.seq_counter)
578
        eos_token_id = self.input_preprocessor.get_eos_token_id(lora_request)
579

580
581
582
583
584
585
586
587
        if is_encoder_decoder_inputs(processed_inputs):
            decoder_inputs = processed_inputs["decoder"]
            encoder_inputs = processed_inputs["encoder"]
        else:
            decoder_inputs = processed_inputs
            encoder_inputs = None

        seq = Sequence(seq_id, decoder_inputs, block_size, eos_token_id,
588
                       lora_request, prompt_adapter_request)
589

590
591
592
        encoder_seq = (None if encoder_inputs is None else Sequence(
            seq_id, encoder_inputs, block_size, eos_token_id, lora_request,
            prompt_adapter_request))
593

594
595
596
597
598
599
600
601
        # 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,
602
                trace_headers=trace_headers,
603
                prompt_adapter_request=prompt_adapter_request,
604
605
                encoder_seq=encoder_seq,
                priority=priority)
606
607
608
609
610
611
612
        elif isinstance(params, PoolingParams):
            seq_group = self._create_sequence_group_with_pooling(
                request_id,
                seq,
                params,
                arrival_time=arrival_time,
                lora_request=lora_request,
613
                prompt_adapter_request=prompt_adapter_request,
614
615
                encoder_seq=encoder_seq,
                priority=priority)
616
617
618
619
        else:
            raise ValueError(
                "Either SamplingParams or PoolingParams must be provided.")

620
621
622
623
624
625
626
627
        # 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)

628
629
        return seq_group

630
631
    def stop_remote_worker_execution_loop(self) -> None:
        self.model_executor.stop_remote_worker_execution_loop()
632

633
    @overload
634
635
636
    def add_request(
        self,
        request_id: str,
637
        prompt: PromptType,
638
        params: Union[SamplingParams, PoolingParams],
639
        arrival_time: Optional[float] = None,
640
        lora_request: Optional[LoRARequest] = None,
641
        trace_headers: Optional[Mapping[str, str]] = None,
642
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
643
        priority: int = 0,
644
    ) -> None:
645
646
647
        ...

    @overload
648
    @deprecated("'inputs' will be renamed to 'prompt")
649
650
651
    def add_request(
        self,
        request_id: str,
652
653
        *,
        inputs: PromptType,
654
        params: Union[SamplingParams, PoolingParams],
655
        arrival_time: Optional[float] = None,
656
        lora_request: Optional[LoRARequest] = None,
657
        trace_headers: Optional[Mapping[str, str]] = None,
658
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
659
        priority: int = 0,
660
    ) -> None:
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
        ...

    @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
679
    ) -> None:
Zhuohan Li's avatar
Zhuohan Li committed
680
        """Add a request to the engine's request pool.
681
682

        The request is added to the request pool and will be processed by the
Zhuohan Li's avatar
Zhuohan Li committed
683
        scheduler as `engine.step()` is called. The exact scheduling policy is
684
685
686
687
        determined by the scheduler.

        Args:
            request_id: The unique ID of the request.
688
            prompt: The prompt to the LLM. See :class:`~vllm.inputs.PromptType`
689
690
691
692
                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.
693
            arrival_time: The arrival time of the request. If None, we use
694
                the current monotonic time.
695
            lora_request: The LoRA request to add.
696
            trace_headers: OpenTelemetry trace headers.
697
            prompt_adapter_request: The prompt adapter request to add.
698
699
            priority: The priority of the request.
                Only applicable with priority scheduling.
700
701
702
703

        Details:
            - Set arrival_time to the current time if it is None.
            - Set prompt_token_ids to the encoded prompt if it is None.
704
            - Create `n` number of :class:`~vllm.Sequence` objects.
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
            - 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
            >>> ...
724
        """
725
726
727
728
        if inputs is not None:
            prompt = inputs
        assert prompt is not None and params is not None

729
730
731
        if lora_request is not None and not self.lora_config:
            raise ValueError(f"Got lora_request {lora_request} but LoRA is "
                             "not enabled!")
732

733
        if priority != 0 and not self.scheduler_config.policy == "priority":
734
735
736
            raise ValueError(f"Got priority {priority} but "
                             "Priority scheduling is not enabled.")

737
738
739
740
741
742
743
        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")

744
        if arrival_time is None:
745
            arrival_time = time.time()
746

747
748
749
750
751
        if self.tokenizer is not None:
            self._validate_token_prompt(
                prompt,
                tokenizer=self.get_tokenizer(lora_request=lora_request))

752
        preprocessed_inputs = self.input_preprocessor.preprocess(
753
            prompt,
754
755
            request_id=request_id,
            lora_request=lora_request,
756
757
            prompt_adapter_request=prompt_adapter_request,
        )
758
        processed_inputs = self.input_processor(preprocessed_inputs)
759

760
761
762
763
764
765
        self._add_processed_request(
            request_id=request_id,
            processed_inputs=processed_inputs,
            params=params,
            arrival_time=arrival_time,
            lora_request=lora_request,
766
            prompt_adapter_request=prompt_adapter_request,
767
            trace_headers=trace_headers,
768
            priority=priority,
769
        )
770

771
772
773
774
775
776
777
778
779
780
781
    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.
782
        if is_token_prompt(prompt):
783
784
785
786
787
788
789
790
791
            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))

792
793
794
795
796
    def _create_sequence_group_with_sampling(
        self,
        request_id: str,
        seq: Sequence,
        sampling_params: SamplingParams,
797
798
        arrival_time: float,
        lora_request: Optional[LoRARequest],
799
        trace_headers: Optional[Mapping[str, str]] = None,
800
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
801
        encoder_seq: Optional[Sequence] = None,
802
        priority: int = 0,
803
804
805
806
807
808
809
810
811
812
    ) -> 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.")

813
814
815
        sampling_params = self._build_logits_processors(
            sampling_params, lora_request)

816
817
818
        # Defensive copy of SamplingParams, which are used by the sampler,
        # this doesn't deep-copy LogitsProcessor objects
        sampling_params = sampling_params.clone()
819

820
        sampling_params.update_from_generation_config(
821
            self.generation_config_fields, seq.eos_token_id)
822

823
        # Create the sequence group.
824
825
826
827
828
829
830
        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,
831
            prompt_adapter_request=prompt_adapter_request,
832
833
            encoder_seq=encoder_seq,
            priority=priority)
834

835
836
837
838
839
840
841
        return seq_group

    def _create_sequence_group_with_pooling(
        self,
        request_id: str,
        seq: Sequence,
        pooling_params: PoolingParams,
842
843
        arrival_time: float,
        lora_request: Optional[LoRARequest],
844
        prompt_adapter_request: Optional[PromptAdapterRequest],
845
        encoder_seq: Optional[Sequence] = None,
846
        priority: int = 0,
847
848
849
850
851
    ) -> 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.
852
853
854
855
856
857
        seq_group = SequenceGroup(
            request_id=request_id,
            seqs=[seq],
            arrival_time=arrival_time,
            lora_request=lora_request,
            pooling_params=pooling_params,
858
            prompt_adapter_request=prompt_adapter_request,
859
860
            encoder_seq=encoder_seq,
            priority=priority)
861
        return seq_group
862

Antoni Baum's avatar
Antoni Baum committed
863
864
    def abort_request(self, request_id: Union[str, Iterable[str]]) -> None:
        """Aborts a request(s) with the given ID.
865
866

        Args:
Antoni Baum's avatar
Antoni Baum committed
867
            request_id: The ID(s) of the request to abort.
868
869
870
871
872
873
874
875
876
877
878

        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)
879
        """
880
881
        for scheduler in self.scheduler:
            scheduler.abort_seq_group(request_id)
882

883
884
885
886
    def get_model_config(self) -> ModelConfig:
        """Gets the model configuration."""
        return self.model_config

887
888
889
890
    def get_parallel_config(self) -> ParallelConfig:
        """Gets the parallel configuration."""
        return self.parallel_config

891
892
893
894
    def get_decoding_config(self) -> DecodingConfig:
        """Gets the decoding configuration."""
        return self.decoding_config

895
896
897
898
899
900
901
902
    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

903
    def get_num_unfinished_requests(self) -> int:
904
        """Gets the number of unfinished requests."""
905
906
        return sum(scheduler.get_num_unfinished_seq_groups()
                   for scheduler in self.scheduler)
907

908
    def has_unfinished_requests(self) -> bool:
909
        """Returns True if there are unfinished requests."""
910
911
912
913
914
915
916
917
918
        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()
919

920
921
922
923
924
925
926
927
    def reset_prefix_cache(self) -> bool:
        """Reset prefix cache for all devices."""

        success = True
        for scheduler in self.scheduler:
            success = success and scheduler.reset_prefix_cache()
        return success

928
    @staticmethod
929
930
    def _process_sequence_group_outputs(
        seq_group: SequenceGroup,
931
        outputs: List[PoolingSequenceGroupOutput],
932
    ) -> None:
933
        seq_group.pooled_data = outputs[0].data
934
935
936
937
938
939

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

        return

940
941
942
943
944
945
946
947
    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.

948
        seq_group: SequenceGroup to update the num_computed_tokens for.
949
        seq_group_meta: Metadata of the given SequenceGroup.
950
        is_first_step_output: Optional[bool] -
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
            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)

979
980
981
982
983
    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.
984

985
986
        ctx: The virtual engine context to work on
        request_id: If provided, then only this request is going to be processed
987
        """
988

989
        now = time.time()
990

991
        if len(ctx.output_queue) == 0:
992
993
            return None

994
        # Get pending async postprocessor
995
996
997
998
        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,
999
             is_last_step, is_first_step_output, skip) = ctx.output_queue[0]
1000
1001
        else:
            (outputs, seq_group_metadata_list, scheduler_outputs, is_async,
1002
1003
             is_last_step, is_first_step_output,
             skip) = ctx.output_queue.popleft()
1004
1005
1006
1007
1008

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

1009
        has_multiple_outputs: bool = len(outputs) > 1
1010
        outputs_by_sequence_group: List[List[SequenceGroupOutput]]
1011
1012
1013
1014
1015
        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].
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
            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
1033
1034
1035
            # We have outputs for multiple steps submitted in a single burst,
            # so invalidate is_first_step_output.
            is_first_step_output = None
1036
        elif len(outputs) == 1:
1037
            outputs_by_sequence_group = outputs
1038
1039
        else:
            return None
1040

1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
        # 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

1058
        finished_before: List[int] = []
1059
        finished_now: List[int] = []
1060
        empty_seq_indices: List[int] = []
1061
1062
1063
1064
1065
        for i in indices:
            if i in skip:
                continue

            seq_group_meta = seq_group_metadata_list[i]
1066
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1067

1068
            seq_group: SequenceGroup = scheduled_seq_group.seq_group
1069
1070
1071
1072
1073

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

1074
            output: List[SequenceGroupOutput]
1075
            if has_multiple_outputs:
1076
1077
1078
1079
                output = outputs_by_sequence_group[i]
            else:
                output = [outputs_by_sequence_group[0][i]]

1080
            # tree style speculative decoding may generate empty output in first step
1081
1082
1083
1084
1085
1086
1087
1088
1089
            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
1090

1091
            if not is_async:
1092
1093
1094
1095
1096
1097
                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(
1098
                        seq_group_meta.token_chunk_size or 0)
1099
1100
1101

            if outputs:
                for o in outputs:
1102
1103
1104
1105
                    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 += (
1106
                                o.model_forward_time or 0)
1107
1108
1109
1110
1111
                        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 += (
1112
                                o.model_execute_time or 0)
1113
1114
1115
                        else:
                            seq_group.metrics.model_execute_time = (
                                o.model_execute_time)
1116

1117
            if self.model_config.runner_type == "pooling":
1118
                self._process_sequence_group_outputs(seq_group, output)
1119
1120
1121
1122
1123
            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)
1124

1125
1126
            if seq_group.is_finished():
                finished_now.append(i)
1127

1128
1129
1130
        # Generate outputs for the requests that finished this iteration
        for i in finished_now:
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1131

1132
            seq_group = scheduled_seq_group.seq_group
1133
            seq_group.maybe_set_first_token_time(now)
1134
1135
            if not seq_group.is_prefill():
                seq_group.set_last_token_time(now)
1136
            request_output = RequestOutputFactory.create(
1137
1138
1139
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs)
1140
1141
            if request_output:
                ctx.request_outputs.append(request_output)
1142

1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
        # 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

1155
1156
1157
1158
1159
        # Free currently finished requests
        if finished_now:
            for scheduler in self.scheduler:
                scheduler.free_finished_seq_groups()

1160
1161
        # For multi-step without streaming, don't create outputs each iteration
        if not is_last_step and not ctx.multi_step_stream_outputs:
1162
1163
1164
1165
            # 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)
1166
                ctx.request_outputs.clear()
1167
1168
1169
            return

        # Create the outputs
1170
        for i in indices:
1171
            if i in skip or i in finished_before or i in finished_now or i in empty_seq_indices:
1172
1173
                continue  # Avoids double processing

1174
1175
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]

1176
            seq_group = scheduled_seq_group.seq_group
1177
            seq_group.maybe_set_first_token_time(now)
1178
1179
            if not seq_group.is_prefill():
                seq_group.set_last_token_time(now)
1180
            request_output = RequestOutputFactory.create(
1181
1182
1183
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs)
1184
            if request_output:
1185
                ctx.request_outputs.append(request_output)
1186

1187
1188
1189
1190
1191
1192
1193
1194
        # 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

1195
        for seq_group in scheduler_outputs.ignored_seq_groups:
1196
1197
1198
1199
1200
            params = seq_group.sampling_params
            if params is not None and params.output_kind == (
                    RequestOutputKind.DELTA) and not seq_group.is_finished():
                continue

1201
            request_output = RequestOutputFactory.create(
1202
1203
1204
1205
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs,
            )
1206
1207
            if request_output:
                ctx.request_outputs.append(request_output)
1208

1209
1210
1211
1212
        # 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)
1213
            ctx.request_outputs.clear()
1214

1215
1216
1217
1218
        # 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:
1219
            # Log stats.
1220
1221
            self.do_log_stats(scheduler_outputs, outputs, finished_before,
                              skip)
1222
1223

            # Tracing
1224
            self.do_tracing(scheduler_outputs, finished_before)
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242

        return None

    def _advance_to_next_step(
            self, output: List[SamplerOutput],
            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

1243
1244
1245
1246
1247
            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)
1248
            else:
1249
1250
1251
1252
                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)
1253
1254
1255
1256

            if seq_group_metadata.do_sample:
                assert len(sequence_group_outputs.samples) == 1, (
                    "Async output processor expects a single sample"
1257
                    " (i.e sampling_params.n == 1)")
1258
1259
1260
1261
                sample = sequence_group_outputs.samples[0]

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

1263
1264
1265
1266
1267
1268
1269
1270
                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)
1271

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

1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
        .. 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.

1290
            - Step 2: Calls the distributed executor to execute the model.
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
            - 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)
1312
            >>>         engine.add_request(str(req_id),prompt,sampling_params)
1313
1314
1315
1316
1317
1318
1319
1320
1321
            >>>
            >>>     # 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
1322
        """
1323
1324
1325
1326
        if self.parallel_config.pipeline_parallel_size > 1:
            raise NotImplementedError(
                "Pipeline parallelism is only supported through AsyncLLMEngine "
                "as performance will be severely degraded otherwise.")
1327

1328
        # For llm_engine, there is no pipeline parallel support, so the engine
1329
        # used is always 0.
1330
1331
        virtual_engine = 0

1332
1333
        # These are cached outputs from previous iterations. None if on first
        # iteration
1334
        cached_outputs = self.cached_scheduler_outputs[virtual_engine]
1335
1336
        seq_group_metadata_list = cached_outputs.seq_group_metadata_list
        scheduler_outputs = cached_outputs.scheduler_outputs
1337
        allow_async_output_proc = cached_outputs.allow_async_output_proc
1338

1339
1340
        ctx = self.scheduler_contexts[virtual_engine]

1341
1342
1343
        # Clear outputs for each new scheduler iteration
        ctx.request_outputs.clear()

1344
1345
1346
1347
        # 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.
        if not self._has_remaining_steps(seq_group_metadata_list):
1348
            # Schedule iteration
1349
            (seq_group_metadata_list, scheduler_outputs,
1350
1351
             allow_async_output_proc
             ) = self.scheduler[virtual_engine].schedule()
1352

1353
1354
            ctx.seq_group_metadata_list = seq_group_metadata_list
            ctx.scheduler_outputs = scheduler_outputs
1355

1356
1357
1358
            finished_requests_ids = self.scheduler[
                virtual_engine].get_and_reset_finished_requests_ids()

1359
1360
            # Maybe switch from async mode to sync mode
            if not allow_async_output_proc and len(ctx.output_queue) > 0:
1361
                self._process_model_outputs(ctx=ctx)
1362

1363
1364
1365
1366
1367
            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(
1368
                    virtual_engine, seq_group_metadata_list, scheduler_outputs,
1369
                    allow_async_output_proc)
1370
1371
        else:
            finished_requests_ids = list()
1372
1373
1374

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

1376
        if not scheduler_outputs.is_empty():
1377
1378
1379
1380
1381
1382

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

1385
            execute_model_req = ExecuteModelRequest(
1386
1387
1388
1389
                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,
1390
1391
                num_lookahead_slots=scheduler_outputs.num_lookahead_slots,
                running_queue_size=scheduler_outputs.running_queue_size,
1392
1393
1394
1395
1396
                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)

1397
            if allow_async_output_proc:
1398
1399
                execute_model_req.async_callback = self.async_callbacks[
                    virtual_engine]
1400

1401
            outputs = self.model_executor.execute_model(
1402
                execute_model_req=execute_model_req)
1403

1404
            # We need to do this here so that last step's sampled_token_ids can
1405
1406
            # be passed to the next iteration for PP.
            if self.scheduler_config.is_multi_step:
1407
                self._update_cached_scheduler_output(virtual_engine, outputs)
1408
        else:
1409
1410
            # Nothing scheduled => If there is pending async postprocessor,
            # then finish it here.
1411
1412
            if len(ctx.output_queue) > 0:
                self._process_model_outputs(ctx=ctx)
1413
            # No outputs in this case
1414
            outputs = []
Antoni Baum's avatar
Antoni Baum committed
1415

1416
1417
1418
1419
1420
1421
        # 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):
1422
            # clear the cache if we have finished all the steps.
1423
1424
1425
            if self.scheduler_config.is_multi_step:
                self.cached_scheduler_outputs[0] = SchedulerOutputState()

1426
1427
1428
1429
1430
1431
            # 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

1432
            # Add results to the output_queue
1433
1434
1435
1436
            ctx.append_output(outputs=outputs,
                              seq_group_metadata_list=seq_group_metadata_list,
                              scheduler_outputs=scheduler_outputs,
                              is_async=allow_async_output_proc,
1437
1438
                              is_last_step=True,
                              is_first_step_output=is_first_step_output)
1439
1440
1441

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

1444
                self._advance_to_next_step(
1445
                    outputs[0], seq_group_metadata_list,
1446
                    scheduler_outputs.scheduled_seq_groups)
1447

1448
            # Check if need to run the usual non-async path
1449
            if not allow_async_output_proc:
1450
                self._process_model_outputs(ctx=ctx)
1451

1452
                # Log stats.
1453
                self.do_log_stats(scheduler_outputs, outputs)
1454

1455
1456
1457
                # Tracing
                self.do_tracing(scheduler_outputs)
        else:
1458
            # Multi-step case
1459
            return ctx.request_outputs
1460

1461
        if not self.has_unfinished_requests():
1462
1463
            # Drain async postprocessor (if exists)
            if len(ctx.output_queue) > 0:
1464
                self._process_model_outputs(ctx=ctx)
1465
            assert len(ctx.output_queue) == 0
1466

1467
1468
1469
1470
1471
            # 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.
1472
            logger.debug("Stopping remote worker execution loop.")
1473
1474
            self.model_executor.stop_remote_worker_execution_loop()

1475
        return ctx.request_outputs
Antoni Baum's avatar
Antoni Baum committed
1476

1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
    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:]
        ]):
1492
1493
            raise AssertionError("All running sequence groups should "
                                 "have the same remaining steps.")
1494
1495
1496
1497
1498
1499

        return ref_remaining_steps > 0

    def _cache_scheduler_outputs_for_multi_step(
            self, virtual_engine: int,
            seq_group_metadata_list: Optional[List[SequenceGroupMetadata]],
1500
1501
1502
1503
1504
1505
1506
1507
            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
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531

    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
1532

1533
    def add_logger(self, logger_name: str, logger: StatLoggerBase) -> None:
1534
1535
1536
1537
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1538
1539
1540
1541
1542
        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:
1543
1544
1545
1546
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1547
1548
1549
1550
        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]

1551
1552
1553
    def do_log_stats(self,
                     scheduler_outputs: Optional[SchedulerOutputs] = None,
                     model_output: Optional[List[SamplerOutput]] = None,
1554
1555
                     finished_before: Optional[List[int]] = None,
                     skip: Optional[List[int]] = None) -> None:
1556
1557
        """Forced log when no requests active."""
        if self.log_stats:
1558
            stats = self._get_stats(scheduler_outputs, model_output,
1559
                                    finished_before, skip)
1560
            for logger in self.stat_loggers.values():
1561
                logger.log(stats)
1562

1563
1564
1565
    def _get_stats(self,
                   scheduler_outputs: Optional[SchedulerOutputs],
                   model_output: Optional[List[SamplerOutput]] = None,
1566
1567
                   finished_before: Optional[List[int]] = None,
                   skip: Optional[List[int]] = None) -> Stats:
1568
1569
1570
1571
1572
1573
1574
        """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.
1575
1576
1577
1578
            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.
1579
        """
1580
        now = time.time()
Woosuk Kwon's avatar
Woosuk Kwon committed
1581

1582
1583
        # System State
        #   Scheduler State
1584
1585
1586
1587
1588
1589
        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)
1590
1591

        # KV Cache Usage in %
1592
        num_total_gpu = self.cache_config.num_gpu_blocks
1593
        gpu_cache_usage_sys = 0.
1594
        if num_total_gpu:  # Guard against both None and 0
1595
1596
1597
            num_free_gpu = sum(
                scheduler.block_manager.get_num_free_gpu_blocks()
                for scheduler in self.scheduler)
1598
            gpu_cache_usage_sys = 1.0 - (num_free_gpu / num_total_gpu)
Woosuk Kwon's avatar
Woosuk Kwon committed
1599

1600
        num_total_cpu = self.cache_config.num_cpu_blocks
1601
        cpu_cache_usage_sys = 0.
1602
        if num_total_cpu:  # Guard against both None and 0
1603
1604
1605
            num_free_cpu = sum(
                scheduler.block_manager.get_num_free_cpu_blocks()
                for scheduler in self.scheduler)
1606
1607
            cpu_cache_usage_sys = 1.0 - (num_free_cpu / num_total_cpu)

1608
1609
1610
1611
1612
1613
1614
        # 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)

1615
1616
1617
        # Iteration stats
        num_prompt_tokens_iter = 0
        num_generation_tokens_iter = 0
harrywu's avatar
harrywu committed
1618
        num_tokens_iter = 0
1619
1620
        time_to_first_tokens_iter: List[float] = []
        time_per_output_tokens_iter: List[float] = []
1621
1622
        num_preemption_iter = (0 if scheduler_outputs is None else
                               scheduler_outputs.preempted)
1623
1624
1625
1626

        # Request stats
        #   Latency
        time_e2e_requests: List[float] = []
harrywu's avatar
harrywu committed
1627
1628
1629
1630
        time_queue_requests: List[float] = []
        time_inference_requests: List[float] = []
        time_prefill_requests: List[float] = []
        time_decode_requests: List[float] = []
1631
1632
1633
        time_in_queue_requests: List[float] = []
        model_forward_time_requests: List[float] = []
        model_execute_time_requests: List[float] = []
1634
1635
1636
1637
        #   Metadata
        num_prompt_tokens_requests: List[int] = []
        num_generation_tokens_requests: List[int] = []
        n_requests: List[int] = []
harrywu's avatar
harrywu committed
1638
        max_num_generation_tokens_requests: List[int] = []
1639
        max_tokens_requests: List[int] = []
1640
1641
        finished_reason_requests: List[str] = []

1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
        # Lora requests
        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)

1661
1662
        # NOTE: This loop assumes prefill seq_groups are before
        # decode seq_groups in scheduled_seq_groups.
1663
        if scheduler_outputs is not None:
1664
1665
1666
1667
            # 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

1668
            num_generation_tokens_from_prefill_groups = 0
1669
1670
1671
1672
            # 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.
1673
1674
1675

            for idx, scheduled_seq_group in enumerate(
                    scheduler_outputs.scheduled_seq_groups):
1676
1677
1678
1679
1680
                # Skip double logging when using async output proc
                if finished_before and idx in finished_before:
                    actual_num_batched_tokens -= 1
                    continue

1681
1682
1683
1684
                # Currently, skip == preempted sequences, so we need to skip
                # their log stats
                if skip and idx in skip:
                    continue
1685

1686
                group_was_prefill = idx < scheduler_outputs.num_prefill_groups
1687
                seq_group = scheduled_seq_group.seq_group
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699

                # 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():
1700
                        latency = seq_group.get_last_token_latency()
1701
1702
1703
1704
1705
1706
1707
                        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.
1708
                    latency = seq_group.get_last_token_latency()
1709
                    time_per_output_tokens_iter.append(latency)
1710
1711
1712
1713
1714
1715
1716
1717
1718
                    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
1719
1720
1721
1722
1723
1724

                # 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.
1725
                if seq_group.is_finished():
1726
                    # Latency timings
1727
1728
                    time_e2e_requests.append(now -
                                             seq_group.metrics.arrival_time)
harrywu's avatar
harrywu committed
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
                    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)
1741
1742
1743
1744
1745
1746
1747
1748
1749
                    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)
1750
1751
1752
1753
1754
1755
1756
                    # 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
1757
1758
1759
                    max_num_generation_tokens_requests.append(
                        max(seq.get_output_len()
                            for seq in seq_group.get_seqs()))
1760
1761
                    if seq_group.sampling_params is not None:
                        n_requests.append(seq_group.sampling_params.n)
1762
1763
                        max_tokens_requests.append(
                            seq_group.sampling_params.max_tokens)
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
                    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 = (
1776
                actual_num_batched_tokens - num_prompt_tokens_iter +
1777
                num_generation_tokens_from_prefill_groups)
harrywu's avatar
harrywu committed
1778
1779
            num_tokens_iter = (num_generation_tokens_iter +
                               num_prompt_tokens_iter)
1780
1781
        # Spec decode, if enabled, emits specialized metrics from the worker in
        # sampler output.
1782
1783
        if model_output and isinstance(model_output[0], SamplerOutput) and (
                model_output[0].spec_decode_worker_metrics is not None):
1784
1785
1786
1787
            spec_decode_metrics = model_output[0].spec_decode_worker_metrics
        else:
            spec_decode_metrics = None

1788
1789
        return Stats(
            now=now,
1790
1791
1792
1793
1794
1795
1796
1797
            # 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,
1798
1799
1800
            #   Prefix Cache Hit Rate
            cpu_prefix_cache_hit_rate=cpu_prefix_cache_hit_rate,
            gpu_prefix_cache_hit_rate=gpu_prefix_cache_hit_rate,
1801
1802
1803
1804

            # Iteration stats
            num_prompt_tokens_iter=num_prompt_tokens_iter,
            num_generation_tokens_iter=num_generation_tokens_iter,
harrywu's avatar
harrywu committed
1805
            num_tokens_iter=num_tokens_iter,
1806
1807
            time_to_first_tokens_iter=time_to_first_tokens_iter,
            time_per_output_tokens_iter=time_per_output_tokens_iter,
1808
            spec_decode_metrics=spec_decode_metrics,
1809
            num_preemption_iter=num_preemption_iter,
1810
1811
1812
1813

            # Request stats
            #   Latency
            time_e2e_requests=time_e2e_requests,
harrywu's avatar
harrywu committed
1814
1815
1816
1817
            time_queue_requests=time_queue_requests,
            time_inference_requests=time_inference_requests,
            time_prefill_requests=time_prefill_requests,
            time_decode_requests=time_decode_requests,
1818
1819
1820
            time_in_queue_requests=time_in_queue_requests,
            model_forward_time_requests=model_forward_time_requests,
            model_execute_time_requests=model_execute_time_requests,
1821
1822
1823
            #   Metadata
            num_prompt_tokens_requests=num_prompt_tokens_requests,
            num_generation_tokens_requests=num_generation_tokens_requests,
harrywu's avatar
harrywu committed
1824
1825
            max_num_generation_tokens_requests=
            max_num_generation_tokens_requests,
1826
            n_requests=n_requests,
1827
            max_tokens_requests=max_tokens_requests,
1828
            finished_reason_requests=finished_reason_requests,
1829
1830
1831
            max_lora=str(max_lora_stat),
            waiting_lora_adapters=list(waiting_lora_adapters.keys()),
            running_lora_adapters=list(running_lora_adapters.keys()))
1832

1833
    def add_lora(self, lora_request: LoRARequest) -> bool:
1834
        return self.model_executor.add_lora(lora_request)
1835
1836

    def remove_lora(self, lora_id: int) -> bool:
1837
        return self.model_executor.remove_lora(lora_id)
1838

1839
    def list_loras(self) -> Set[int]:
1840
        return self.model_executor.list_loras()
1841

1842
1843
1844
    def pin_lora(self, lora_id: int) -> bool:
        return self.model_executor.pin_lora(lora_id)

1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
    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()

1855
1856
1857
1858
1859
1860
    def start_profile(self) -> None:
        self.model_executor.start_profile()

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

1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
    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)

    def wake_up(self) -> None:
        assert self.vllm_config.model_config.enable_sleep_mode, (
            "Sleep mode is not enabled in the model config")
        self.model_executor.wake_up()

1871
    def check_health(self) -> None:
1872
1873
        if self.tokenizer:
            self.tokenizer.check_health()
1874
        self.model_executor.check_health()
1875
1876
1877
1878

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

1879
1880
1881
    def do_tracing(self,
                   scheduler_outputs: SchedulerOutputs,
                   finished_before: Optional[List[int]] = None) -> None:
1882
1883
1884
        if self.tracer is None:
            return

1885
1886
1887
1888
1889
1890
        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

1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
            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
1910
            seq_span.set_attribute(SpanAttributes.GEN_AI_RESPONSE_MODEL,
1911
                                   self.model_config.model)
1912
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_ID,
1913
                                   seq_group.request_id)
1914
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_TEMPERATURE,
1915
                                   seq_group.sampling_params.temperature)
1916
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_TOP_P,
1917
                                   seq_group.sampling_params.top_p)
1918
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_MAX_TOKENS,
1919
                                   seq_group.sampling_params.max_tokens)
1920
            seq_span.set_attribute(SpanAttributes.GEN_AI_REQUEST_N,
1921
                                   seq_group.sampling_params.n)
1922
            seq_span.set_attribute(SpanAttributes.GEN_AI_USAGE_NUM_SEQUENCES,
1923
                                   seq_group.num_seqs())
1924
            seq_span.set_attribute(SpanAttributes.GEN_AI_USAGE_PROMPT_TOKENS,
1925
1926
                                   len(seq_group.prompt_token_ids))
            seq_span.set_attribute(
1927
                SpanAttributes.GEN_AI_USAGE_COMPLETION_TOKENS,
1928
1929
1930
1931
                sum([
                    seq.get_output_len()
                    for seq in seq_group.get_finished_seqs()
                ]))
1932
            seq_span.set_attribute(SpanAttributes.GEN_AI_LATENCY_TIME_IN_QUEUE,
1933
1934
                                   metrics.time_in_queue)
            seq_span.set_attribute(
1935
1936
                SpanAttributes.GEN_AI_LATENCY_TIME_TO_FIRST_TOKEN, ttft)
            seq_span.set_attribute(SpanAttributes.GEN_AI_LATENCY_E2E, e2e_time)
1937
1938
            if metrics.scheduler_time is not None:
                seq_span.set_attribute(
1939
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_SCHEDULER,
1940
1941
1942
                    metrics.scheduler_time)
            if metrics.model_forward_time is not None:
                seq_span.set_attribute(
1943
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_MODEL_FORWARD,
1944
1945
1946
                    metrics.model_forward_time / 1000.0)
            if metrics.model_execute_time is not None:
                seq_span.set_attribute(
1947
                    SpanAttributes.GEN_AI_LATENCY_TIME_IN_MODEL_EXECUTE,
1948
                    metrics.model_execute_time)
1949

1950
    def _validate_model_inputs(self, inputs: ProcessorInputs,
1951
                               lora_request: Optional[LoRARequest]):
1952
        if is_encoder_decoder_inputs(inputs):
1953
1954
            # For encoder-decoder multimodal models, the max_prompt_len
            # restricts the decoder prompt length
1955
1956
            prompt_inputs = inputs["decoder" if self.model_config.
                                   is_multimodal_model else "encoder"]
1957
        else:
1958
1959
            prompt_inputs = inputs

1960
        prompt_ids = SingletonInputsAdapter(prompt_inputs).prompt_token_ids
1961
1962

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

1965
        if self.model_config.is_multimodal_model:
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
            max_prompt_len = self.model_config.max_model_len

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

            # 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
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989

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

1991
1992
1993
1994
1995
        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
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005

            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

            processor = get_local_guided_decoding_logits_processor(
2006
2007
2008
                guided_params=guided_decoding,
                tokenizer=tokenizer,
                model_config=self.model_config)
2009
2010
2011
2012
2013
2014
2015
2016
2017
            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)

2018
            processors = get_openai_logits_processors(
2019
2020
2021
2022
2023
2024
2025
2026
2027
                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

2028
2029
2030
2031
2032
2033
        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)

2034
2035
2036
2037
2038
2039
2040
        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