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

12
import torch
13
from typing_extensions import TypeIs, TypeVar
14

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

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

67

68
69
70
71
72
73
74
75
def _load_generation_config_dict(model_config: ModelConfig) -> Dict[str, Any]:
    config = try_get_generation_config(
        model_config.model,
        trust_remote_code=model_config.trust_remote_code,
        revision=model_config.revision,
    )

    if config is None:
76
77
        return {}

78
79
    return config.to_diff_dict()

80

81
_G = TypeVar("_G", bound=BaseTokenizerGroup, default=BaseTokenizerGroup)
82
83
84
_O = TypeVar("_O", RequestOutput, EmbeddingRequestOutput)


85
86
87
88
89
@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
90
91
    allow_async_output_proc: bool = False
    last_output: Optional[SamplerOutput] = None
92
93


94
95
96
97
98
99
class OutputData(NamedTuple):
    outputs: List[SamplerOutput]
    seq_group_metadata_list: List[SequenceGroupMetadata]
    scheduler_outputs: SchedulerOutputs
    is_async: bool
    is_last_step: bool
100
101
102
103
104
105
    # 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]
106
107
108
    skip: List[int]


109
class SchedulerContext:
110

111
    def __init__(self, multi_step_stream_outputs: bool = False):
112
113
114
115
116
117
118
        self.output_queue: Deque[OutputData] = deque()
        self.request_outputs: List[Union[RequestOutput,
                                         EmbeddingRequestOutput]] = []
        self.seq_group_metadata_list: Optional[
            List[SequenceGroupMetadata]] = None
        self.scheduler_outputs: Optional[SchedulerOutputs] = None

119
120
        self.multi_step_stream_outputs: bool = multi_step_stream_outputs

121
122
123
    def append_output(self, outputs: List[SamplerOutput],
                      seq_group_metadata_list: List[SequenceGroupMetadata],
                      scheduler_outputs: SchedulerOutputs, is_async: bool,
124
125
                      is_last_step: bool,
                      is_first_step_output: Optional[bool]):
126
127
128
129
130
131
        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,
132
                       is_first_step_output=is_first_step_output,
133
                       skip=[]))
134
135


136
class LLMEngine:
Zhuohan Li's avatar
Zhuohan Li committed
137
    """An LLM engine that receives requests and generates texts.
138

Woosuk Kwon's avatar
Woosuk Kwon committed
139
    This is the main class for the vLLM engine. It receives requests
140
141
142
143
144
145
    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.

146
147
    The :class:`~vllm.LLM` class wraps this class for offline batched inference
    and the :class:`AsyncLLMEngine` class wraps this class for online serving.
148

149
150
    The config arguments are derived from :class:`~vllm.EngineArgs`. (See
    :ref:`engine_args`)
151
152
153
154
155
156
157

    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.
158
        device_config: The configuration related to the device.
159
160
161
        lora_config (Optional): The configuration related to serving multi-LoRA.
        speculative_config (Optional): The configuration related to speculative
            decoding.
162
163
        executor_class: The model executor class for managing distributed
            execution.
164
        prompt_adapter_config (Optional): The configuration related to serving
165
            prompt adapters.
166
        log_stats: Whether to log statistics.
167
        usage_context: Specified entry point, used for usage info collection.
168
    """
169

170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
    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)}")

195
        return cast(_O, output)
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

    @classmethod
    def validate_outputs(
        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

        return outputs_

    tokenizer: Optional[BaseTokenizerGroup]

221
222
    def __init__(
        self,
223
        vllm_config: VllmConfig,
224
        executor_class: Type[ExecutorBase],
225
        log_stats: bool,
yhu422's avatar
yhu422 committed
226
        usage_context: UsageContext = UsageContext.ENGINE_CONTEXT,
227
        stat_loggers: Optional[Dict[str, StatLoggerBase]] = None,
228
        input_registry: InputRegistry = INPUT_REGISTRY,
229
        use_cached_outputs: bool = False,
230
    ) -> None:
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246

        # TODO: remove the local variables and use self.* throughout the class.
        model_config = self.model_config = vllm_config.model_config
        cache_config = self.cache_config = vllm_config.cache_config
        lora_config = self.lora_config = vllm_config.lora_config
        parallel_config = self.parallel_config = vllm_config.parallel_config
        scheduler_config = self.scheduler_config = vllm_config.scheduler_config
        device_config = self.device_config = vllm_config.device_config
        speculative_config = self.speculative_config = vllm_config.speculative_config  # noqa
        load_config = self.load_config = vllm_config.load_config
        decoding_config = self.decoding_config = vllm_config.decoding_config or DecodingConfig(  # noqa
        )
        prompt_adapter_config = self.prompt_adapter_config = vllm_config.prompt_adapter_config  # noqa
        observability_config = self.observability_config = vllm_config.observability_config or ObservabilityConfig(  # noqa
        )

247
        logger.info(
248
249
250
            "Initializing an LLM engine (v%s) with config: "
            "model=%r, speculative_config=%r, tokenizer=%r, "
            "skip_tokenizer_init=%s, tokenizer_mode=%s, revision=%s, "
251
            "override_neuron_config=%s, "
252
            "rope_scaling=%r, rope_theta=%r, tokenizer_revision=%s, "
253
254
            "trust_remote_code=%s, dtype=%s, max_seq_len=%d, "
            "download_dir=%r, load_format=%s, tensor_parallel_size=%d, "
255
            "pipeline_parallel_size=%d, "
256
257
            "disable_custom_all_reduce=%s, quantization=%s, "
            "enforce_eager=%s, kv_cache_dtype=%s, "
258
            "quantization_param_path=%s, device_config=%s, "
259
            "decoding_config=%r, observability_config=%r, "
260
            "seed=%d, served_model_name=%s, "
261
262
263
            "num_scheduler_steps=%d, chunked_prefill_enabled=%s "
            "multi_step_stream_outputs=%s, enable_prefix_caching=%s, "
            "use_async_output_proc=%s, use_cached_outputs=%s, "
264
265
            "chat_template_text_format=%s, mm_processor_kwargs=%s, "
            "pooler_config=%r)",
266
            VLLM_VERSION,
267
268
269
270
271
272
            model_config.model,
            speculative_config,
            model_config.tokenizer,
            model_config.skip_tokenizer_init,
            model_config.tokenizer_mode,
            model_config.revision,
273
            model_config.override_neuron_config,
274
            model_config.rope_scaling,
275
            model_config.rope_theta,
276
277
278
279
280
281
282
            model_config.tokenizer_revision,
            model_config.trust_remote_code,
            model_config.dtype,
            model_config.max_model_len,
            load_config.download_dir,
            load_config.load_format,
            parallel_config.tensor_parallel_size,
283
            parallel_config.pipeline_parallel_size,
284
285
286
287
288
289
290
            parallel_config.disable_custom_all_reduce,
            model_config.quantization,
            model_config.enforce_eager,
            cache_config.cache_dtype,
            model_config.quantization_param_path,
            device_config.device,
            decoding_config,
291
            observability_config,
292
            model_config.seed,
293
            model_config.served_model_name,
294
            scheduler_config.num_scheduler_steps,
295
            scheduler_config.chunked_prefill_enabled,
296
            scheduler_config.multi_step_stream_outputs,
297
            cache_config.enable_prefix_caching,
298
            model_config.use_async_output_proc,
299
            use_cached_outputs,
300
            model_config.chat_template_text_format,
301
            model_config.mm_processor_kwargs,
302
            model_config.pooler_config,
303
        )
304
305
306
        # TODO(woosuk): Print more configs in debug mode.
        self.model_config = model_config
        self.cache_config = cache_config
307
        self.lora_config = lora_config
308
309
        self.parallel_config = parallel_config
        self.scheduler_config = scheduler_config
310
        self.device_config = device_config
311
        self.speculative_config = speculative_config
312
        self.load_config = load_config
313
        self.decoding_config = decoding_config or DecodingConfig()
314
        self.prompt_adapter_config = prompt_adapter_config
315
316
        self.observability_config = observability_config or ObservabilityConfig(
        )
317
        self.log_stats = log_stats
318
        self.use_cached_outputs = use_cached_outputs
319

320
        if not self.model_config.skip_tokenizer_init:
321
            self.tokenizer = self._init_tokenizer()
322
            self.detokenizer = Detokenizer(self.tokenizer)
323
            tokenizer_group = self.get_tokenizer_group()
324
325
        else:
            self.tokenizer = None
326
            self.detokenizer = None
327
328
329
330
331
332
333
334
            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)
335

336
        self.seq_counter = Counter()
337
338
        self.generation_config_fields = _load_generation_config_dict(
            model_config)
339

340
341
342
        self.input_preprocessor = InputPreprocessor(model_config,
                                                    self.tokenizer)

343
344
345
        self.input_registry = input_registry
        self.input_processor = input_registry.create_input_processor(
            model_config)
346

347
        self.model_executor = executor_class(vllm_config=vllm_config, )
348

349
        if self.model_config.task != "embedding":
350
            self._initialize_kv_caches()
351

yhu422's avatar
yhu422 committed
352
353
        # If usage stat is enabled, collect relevant info.
        if is_usage_stats_enabled():
354
355
            from vllm.model_executor.model_loader import (
                get_architecture_class_name)
yhu422's avatar
yhu422 committed
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
            usage_message.report_usage(
                get_architecture_class_name(model_config),
                usage_context,
                extra_kvs={
                    # Common configuration
                    "dtype":
                    str(model_config.dtype),
                    "tensor_parallel_size":
                    parallel_config.tensor_parallel_size,
                    "block_size":
                    cache_config.block_size,
                    "gpu_memory_utilization":
                    cache_config.gpu_memory_utilization,

                    # Quantization
                    "quantization":
                    model_config.quantization,
                    "kv_cache_dtype":
374
                    str(cache_config.cache_dtype),
yhu422's avatar
yhu422 committed
375
376
377
378

                    # Feature flags
                    "enable_lora":
                    bool(lora_config),
379
380
                    "enable_prompt_adapter":
                    bool(prompt_adapter_config),
yhu422's avatar
yhu422 committed
381
382
383
384
385
386
387
388
                    "enable_prefix_caching":
                    cache_config.enable_prefix_caching,
                    "enforce_eager":
                    model_config.enforce_eager,
                    "disable_custom_all_reduce":
                    parallel_config.disable_custom_all_reduce,
                })

389
390
391
392
        if self.tokenizer:
            # Ping the tokenizer to ensure liveness if it runs in a
            # different process.
            self.tokenizer.ping()
393

394
395
396
397
398
399
        self.cached_scheduler_outputs = [
            SchedulerOutputState()
            for _ in range(self.parallel_config.pipeline_parallel_size)
        ]

        self.scheduler_contexts = [
400
401
            SchedulerContext(multi_step_stream_outputs=self.scheduler_config.
                             multi_step_stream_outputs)
402
403
404
            for _ in range(self.parallel_config.pipeline_parallel_size)
        ]

405
406
407
408
409
410
411
412
413
414
        if model_config.use_async_output_proc:
            process_model_outputs = weak_bind(self._process_model_outputs)

            self.async_callbacks = [
                partial(process_model_outputs,
                        ctx=self.scheduler_contexts[v_id])
                for v_id in range(self.parallel_config.pipeline_parallel_size)
            ]
        else:
            self.async_callbacks = []
415
416
417

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

420
        # Create the scheduler.
421
422
        # NOTE: the cache_config here have been updated with the numbers of
        # GPU and CPU blocks, which are profiled in the distributed executor.
423
        self.scheduler = [
424
425
426
            Scheduler(
                scheduler_config, cache_config, lora_config,
                parallel_config.pipeline_parallel_size,
427
                self.async_callbacks[v_id]
428
                if model_config.use_async_output_proc else None)
429
            for v_id in range(parallel_config.pipeline_parallel_size)
430
        ]
Woosuk Kwon's avatar
Woosuk Kwon committed
431

432
433
        # Metric Logging.
        if self.log_stats:
434
435
436
            if stat_loggers is not None:
                self.stat_loggers = stat_loggers
            else:
437
438
439
440
441
442
443
                # 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)

444
445
446
447
448
449
450
451
452
453
454
455
                self.stat_loggers = {
                    "logging":
                    LoggingStatLogger(
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC),
                    "prometheus":
                    PrometheusStatLogger(
                        local_interval=_LOCAL_LOGGING_INTERVAL_SEC,
                        labels=dict(model_name=model_config.served_model_name),
                        max_model_len=self.model_config.max_model_len),
                }
                self.stat_loggers["prometheus"].info("cache_config",
                                                     self.cache_config)
456

457
458
459
460
461
462
        self.tracer = None
        if self.observability_config.otlp_traces_endpoint:
            self.tracer = init_tracer(
                "vllm.llm_engine",
                self.observability_config.otlp_traces_endpoint)

463
464
465
466
467
468
469
470
        # 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,
471
                get_tokenizer_for_seq,
472
473
                stop_checker=StopChecker(
                    self.scheduler_config.max_model_len,
474
                    get_tokenizer_for_seq,
475
476
477
                ),
            ))

478
479
        self.seq_id_to_seq_group: Dict[str, SequenceGroupBase] = {}

480
481
482
483
484
485
486
487
488
489
490
    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.
        """
        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
491
492
493
494
            logger.info(
                "Overriding num_gpu_blocks=%d with "
                "num_gpu_blocks_override=%d", num_gpu_blocks,
                num_gpu_blocks_override)
495
496
497
498
499
500
501
            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)

502
    @classmethod
503
    def _get_executor_cls(cls,
504
                          engine_config: VllmConfig) -> Type[ExecutorBase]:
505
506
        distributed_executor_backend = (
            engine_config.parallel_config.distributed_executor_backend)
507
        # Initialize the cluster and specify the executor class.
508
509
510
511
512
513
514
515
516
        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}.")
            if distributed_executor_backend.uses_ray:  # type: ignore
                initialize_ray_cluster(engine_config.parallel_config)
            executor_class = distributed_executor_backend
        elif engine_config.device_config.device_type == "neuron":
517
518
            from vllm.executor.neuron_executor import NeuronExecutor
            executor_class = NeuronExecutor
519
        elif engine_config.device_config.device_type == "tpu":
520
521
522
523
524
525
526
527
            if distributed_executor_backend == "ray":
                initialize_ray_cluster(engine_config.parallel_config)
                from vllm.executor.ray_tpu_executor import RayTPUExecutor
                executor_class = RayTPUExecutor
            else:
                assert distributed_executor_backend is None
                from vllm.executor.tpu_executor import TPUExecutor
                executor_class = TPUExecutor
528
        elif engine_config.device_config.device_type == "cpu":
529
530
            from vllm.executor.cpu_executor import CPUExecutor
            executor_class = CPUExecutor
531
532
533
        elif engine_config.device_config.device_type == "openvino":
            from vllm.executor.openvino_executor import OpenVINOExecutor
            executor_class = OpenVINOExecutor
534
535
536
537
538
        elif engine_config.device_config.device_type == "xpu":
            if distributed_executor_backend == "ray":
                initialize_ray_cluster(engine_config.parallel_config)
                from vllm.executor.ray_xpu_executor import RayXPUExecutor
                executor_class = RayXPUExecutor
539
540
541
542
543
544
545
            elif distributed_executor_backend == "mp":
                # FIXME(kunshang):
                # spawn needs calling `if __name__ == '__main__':``
                # fork is not supported for xpu start new process.
                logger.error(
                    "Both start methods (spawn and fork) have issue "
                    "on XPU if you use mp backend, Please try ray instead.")
546
547
548
            else:
                from vllm.executor.xpu_executor import XPUExecutor
                executor_class = XPUExecutor
549
        elif distributed_executor_backend == "ray":
550
            initialize_ray_cluster(engine_config.parallel_config)
551
552
            from vllm.executor.ray_gpu_executor import RayGPUExecutor
            executor_class = RayGPUExecutor
553
554
555
        elif distributed_executor_backend == "mp":
            from vllm.executor.multiproc_gpu_executor import (
                MultiprocessingGPUExecutor)
556
557
558
            assert not envs.VLLM_USE_RAY_SPMD_WORKER, (
                "multiprocessing distributed executor backend does not "
                "support VLLM_USE_RAY_SPMD_WORKER=1")
559
            executor_class = MultiprocessingGPUExecutor
560
561
562
        else:
            from vllm.executor.gpu_executor import GPUExecutor
            executor_class = GPUExecutor
563
564
565
566
567
568
569
570
571
572
573
574
575
        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.
        engine_config = engine_args.create_engine_config()
        executor_class = cls._get_executor_cls(engine_config)
576
        # Create the LLM engine.
yhu422's avatar
yhu422 committed
577
        engine = cls(
578
            vllm_config=engine_config,
yhu422's avatar
yhu422 committed
579
580
581
            executor_class=executor_class,
            log_stats=not engine_args.disable_log_stats,
            usage_context=usage_context,
582
            stat_loggers=stat_loggers,
yhu422's avatar
yhu422 committed
583
        )
584

585
        return engine
586

587
588
589
590
591
    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!")

592
593
594
595
596
597
    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()

598
    def get_tokenizer_group(
599
600
601
602
603
604
        self,
        group_type: Type[_G] = BaseTokenizerGroup,
    ) -> _G:
        tokenizer_group = self.tokenizer

        if tokenizer_group is None:
605
606
            raise ValueError("Unable to get tokenizer because "
                             "skip_tokenizer_init is True")
607
608
609
610
        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)}")
611

612
        return tokenizer_group
613

614
    def get_tokenizer(
615
616
617
        self,
        lora_request: Optional[LoRARequest] = None,
    ) -> AnyTokenizer:
618
        return self.get_tokenizer_group().get_lora_tokenizer(lora_request)
619

620
621
622
623
624
625
    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,
            enable_lora=bool(self.lora_config))
626

627
628
    def _verify_args(self) -> None:
        self.model_config.verify_with_parallel_config(self.parallel_config)
629
        self.cache_config.verify_with_parallel_config(self.parallel_config)
630
631
632
633
        if self.lora_config:
            self.lora_config.verify_with_model_config(self.model_config)
            self.lora_config.verify_with_scheduler_config(
                self.scheduler_config)
634
635
636
        if self.prompt_adapter_config:
            self.prompt_adapter_config.verify_with_model_config(
                self.model_config)
637

638
639
640
    def _add_processed_request(
        self,
        request_id: str,
641
        processed_inputs: Union[DecoderOnlyInputs, EncoderDecoderInputs],
642
643
644
        params: Union[SamplingParams, PoolingParams],
        arrival_time: float,
        lora_request: Optional[LoRARequest],
645
        prompt_adapter_request: Optional[PromptAdapterRequest],
646
        trace_headers: Optional[Mapping[str, str]] = None,
647
        priority: int = 0,
648
    ) -> Optional[SequenceGroup]:
649
650
651
        """Add a processed request to the engine's request pool.
        return the created sequence group.
        """
652
653
654
655
656
657
658
659
660
661
662
663
664
665
        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

666
        self._validate_model_inputs(processed_inputs, lora_request)
667
668
669
        # Create the sequences.
        block_size = self.cache_config.block_size
        seq_id = next(self.seq_counter)
670
        eos_token_id = self.input_preprocessor.get_eos_token_id(lora_request)
671
672

        seq = Sequence(seq_id, processed_inputs, block_size, eos_token_id,
673
                       lora_request, prompt_adapter_request)
674

675
676
677
678
679
680
681
682
683
684
        encoder_seq = None
        if 'encoder_prompt_token_ids' in processed_inputs:
            encoder_seq = Sequence(seq_id,
                                   processed_inputs,
                                   block_size,
                                   eos_token_id,
                                   lora_request,
                                   prompt_adapter_request,
                                   from_decoder_prompt=False)

685
686
687
688
689
690
691
692
        # 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,
693
                trace_headers=trace_headers,
694
                prompt_adapter_request=prompt_adapter_request,
695
696
                encoder_seq=encoder_seq,
                priority=priority)
697
698
699
700
701
702
703
        elif isinstance(params, PoolingParams):
            seq_group = self._create_sequence_group_with_pooling(
                request_id,
                seq,
                params,
                arrival_time=arrival_time,
                lora_request=lora_request,
704
                prompt_adapter_request=prompt_adapter_request,
705
706
                encoder_seq=encoder_seq,
                priority=priority)
707
708
709
710
        else:
            raise ValueError(
                "Either SamplingParams or PoolingParams must be provided.")

711
712
713
714
715
716
717
718
        # 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)

719
720
        return seq_group

721
722
    def stop_remote_worker_execution_loop(self) -> None:
        self.model_executor.stop_remote_worker_execution_loop()
723

724
    @overload  # DEPRECATED
725
726
727
    def add_request(
        self,
        request_id: str,
728
729
        *,
        inputs: PromptType,
730
        params: Union[SamplingParams, PoolingParams],
731
        arrival_time: Optional[float] = None,
732
        lora_request: Optional[LoRARequest] = None,
733
        trace_headers: Optional[Mapping[str, str]] = None,
734
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
735
        priority: int = 0,
736
    ) -> None:
737
738
739
740
741
742
743
744
745
746
747
748
749
        ...

    @overload
    def add_request(
        self,
        request_id: str,
        prompt: PromptType,
        params: Union[SamplingParams, PoolingParams],
        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,
750
    ) -> None:
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
        ...

    @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
769
    ) -> None:
Zhuohan Li's avatar
Zhuohan Li committed
770
        """Add a request to the engine's request pool.
771
772

        The request is added to the request pool and will be processed by the
Zhuohan Li's avatar
Zhuohan Li committed
773
        scheduler as `engine.step()` is called. The exact scheduling policy is
774
775
776
777
        determined by the scheduler.

        Args:
            request_id: The unique ID of the request.
778
            prompt: The prompt to the LLM. See :class:`~vllm.inputs.PromptType`
779
780
781
782
                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.
783
            arrival_time: The arrival time of the request. If None, we use
784
                the current monotonic time.
785
            trace_headers: OpenTelemetry trace headers.
786
787
            priority: The priority of the request.
                Only applicable with priority scheduling.
788
789
790
791

        Details:
            - Set arrival_time to the current time if it is None.
            - Set prompt_token_ids to the encoded prompt if it is None.
792
            - Create `n` number of :class:`~vllm.Sequence` objects.
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
            - 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
            >>> ...
812
        """
813
814
815
816
        if inputs is not None:
            prompt = inputs
        assert prompt is not None and params is not None

817
818
819
        if lora_request is not None and not self.lora_config:
            raise ValueError(f"Got lora_request {lora_request} but LoRA is "
                             "not enabled!")
820

821
        if priority != 0 and not self.scheduler_config.policy == "priority":
822
823
824
            raise ValueError(f"Got priority {priority} but "
                             "Priority scheduling is not enabled.")

825
826
827
828
829
830
831
        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")

832
        if arrival_time is None:
833
            arrival_time = time.time()
834

835
836
837
838
839
        if self.tokenizer is not None:
            self._validate_token_prompt(
                prompt,
                tokenizer=self.get_tokenizer(lora_request=lora_request))

840
        preprocessed_inputs = self.input_preprocessor.preprocess(
841
            prompt,
842
843
            request_id=request_id,
            lora_request=lora_request,
844
845
            prompt_adapter_request=prompt_adapter_request,
        )
846
        processed_inputs = self.input_processor(preprocessed_inputs)
847

848
849
850
851
852
853
854
        # This is a bit of a hack - copy the mm_processor_kwargs that were
        # used in the input processor to the processed output, since these
        # kwargs are presumed to be immutable and the values should be aligned
        # between the input processor (here) and the input mapper.
        processed_inputs["mm_processor_kwargs"] = preprocessed_inputs.get(
            "mm_processor_kwargs")

855
        self._add_processed_request(
856
857
858
859
860
            request_id=request_id,
            processed_inputs=processed_inputs,
            params=params,
            arrival_time=arrival_time,
            lora_request=lora_request,
861
            prompt_adapter_request=prompt_adapter_request,
862
            trace_headers=trace_headers,
863
            priority=priority,
864
        )
865

866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
    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.
        if self._is_token_prompt(prompt):
            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))

    @staticmethod
    def _is_token_prompt(prompt: PromptType) -> TypeIs[TokensPrompt]:
        return isinstance(prompt, dict) and "prompt_token_ids" in prompt

891
892
893
894
895
    def _create_sequence_group_with_sampling(
        self,
        request_id: str,
        seq: Sequence,
        sampling_params: SamplingParams,
896
897
        arrival_time: float,
        lora_request: Optional[LoRARequest],
898
        trace_headers: Optional[Mapping[str, str]] = None,
899
        prompt_adapter_request: Optional[PromptAdapterRequest] = None,
900
        encoder_seq: Optional[Sequence] = None,
901
        priority: int = 0,
902
903
904
905
906
907
908
909
910
911
    ) -> 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.")

912
913
914
        sampling_params = self._build_logits_processors(
            sampling_params, lora_request)

915
916
917
        # Defensive copy of SamplingParams, which are used by the sampler,
        # this doesn't deep-copy LogitsProcessor objects
        sampling_params = sampling_params.clone()
918

919
        sampling_params.update_from_generation_config(
920
            self.generation_config_fields, seq.eos_token_id)
921

922
        # Create the sequence group.
923
924
925
926
927
928
929
        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,
930
            prompt_adapter_request=prompt_adapter_request,
931
932
            encoder_seq=encoder_seq,
            priority=priority)
933

934
935
936
937
938
939
940
        return seq_group

    def _create_sequence_group_with_pooling(
        self,
        request_id: str,
        seq: Sequence,
        pooling_params: PoolingParams,
941
942
        arrival_time: float,
        lora_request: Optional[LoRARequest],
943
        prompt_adapter_request: Optional[PromptAdapterRequest],
944
        encoder_seq: Optional[Sequence] = None,
945
        priority: int = 0,
946
947
948
949
950
    ) -> 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.
951
952
953
954
955
956
        seq_group = SequenceGroup(
            request_id=request_id,
            seqs=[seq],
            arrival_time=arrival_time,
            lora_request=lora_request,
            pooling_params=pooling_params,
957
            prompt_adapter_request=prompt_adapter_request,
958
959
            encoder_seq=encoder_seq,
            priority=priority)
960
        return seq_group
961

Antoni Baum's avatar
Antoni Baum committed
962
963
    def abort_request(self, request_id: Union[str, Iterable[str]]) -> None:
        """Aborts a request(s) with the given ID.
964
965

        Args:
Antoni Baum's avatar
Antoni Baum committed
966
            request_id: The ID(s) of the request to abort.
967
968
969
970
971
972
973
974
975
976
977

        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)
978
        """
979
980
        for scheduler in self.scheduler:
            scheduler.abort_seq_group(request_id)
981

982
983
984
985
    def get_model_config(self) -> ModelConfig:
        """Gets the model configuration."""
        return self.model_config

986
987
988
989
    def get_parallel_config(self) -> ParallelConfig:
        """Gets the parallel configuration."""
        return self.parallel_config

990
991
992
993
    def get_decoding_config(self) -> DecodingConfig:
        """Gets the decoding configuration."""
        return self.decoding_config

994
995
996
997
998
999
1000
1001
    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

1002
    def get_num_unfinished_requests(self) -> int:
1003
        """Gets the number of unfinished requests."""
1004
1005
        return sum(scheduler.get_num_unfinished_seq_groups()
                   for scheduler in self.scheduler)
1006

1007
    def has_unfinished_requests(self) -> bool:
1008
        """Returns True if there are unfinished requests."""
1009
1010
1011
1012
1013
1014
1015
1016
1017
        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()
1018

1019
    @staticmethod
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
    def _process_sequence_group_outputs(
        seq_group: SequenceGroup,
        outputs: List[EmbeddingSequenceGroupOutput],
    ) -> None:
        seq_group.embeddings = outputs[0].embeddings

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

        return

1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
    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.

        seq_group: SequenceGroup to update the num_computed_tokens for. 
        seq_group_meta: Metadata of the given SequenceGroup.
        is_first_step_output: Optional[bool] - 
            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)

1070
1071
1072
1073
1074
    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.
1075

1076
1077
        ctx: The virtual engine context to work on
        request_id: If provided, then only this request is going to be processed
1078
        """
1079

1080
        now = time.time()
1081

1082
        if len(ctx.output_queue) == 0:
1083
1084
            return None

1085
        # Get pending async postprocessor
1086
1087
1088
1089
        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,
1090
             is_last_step, is_first_step_output, skip) = ctx.output_queue[0]
1091
1092
        else:
            (outputs, seq_group_metadata_list, scheduler_outputs, is_async,
1093
1094
             is_last_step, is_first_step_output,
             skip) = ctx.output_queue.popleft()
1095
1096
1097
1098
1099

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

1100
        has_multiple_outputs: bool = len(outputs) > 1
1101
        outputs_by_sequence_group: List[List[SequenceGroupOutput]]
1102
1103
1104
1105
1106
        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].
1107
1108
            outputs_by_sequence_group = create_output_by_sequence_group(
                outputs, num_seq_groups=len(seq_group_metadata_list))
1109
1110
1111
            # We have outputs for multiple steps submitted in a single burst,
            # so invalidate is_first_step_output.
            is_first_step_output = None
1112
1113
1114
        else:
            outputs_by_sequence_group = outputs

1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
        # 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

1132
        finished_before: List[int] = []
1133
        finished_now: List[int] = []
1134
1135
1136
1137
1138
        for i in indices:
            if i in skip:
                continue

            seq_group_meta = seq_group_metadata_list[i]
1139
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1140

1141
            seq_group: SequenceGroup = scheduled_seq_group.seq_group
1142
1143
1144
1145
1146

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

1147
            output: List[SequenceGroupOutput]
1148
            if has_multiple_outputs:
1149
1150
1151
1152
                output = outputs_by_sequence_group[i]
            else:
                output = [outputs_by_sequence_group[0][i]]

1153
1154
1155
1156
1157
1158
1159
            if not is_async:
                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(
1160
                        seq_group_meta.token_chunk_size or 0)
1161
1162
1163

            if outputs:
                for o in outputs:
1164
1165
1166
1167
                    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 += (
1168
                                o.model_forward_time or 0)
1169
1170
1171
1172
1173
                        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 += (
1174
                                o.model_execute_time or 0)
1175
1176
1177
                        else:
                            seq_group.metrics.model_execute_time = (
                                o.model_execute_time)
1178

1179
            if self.model_config.task == "embedding":
1180
                self._process_sequence_group_outputs(seq_group, output)
1181
1182
1183
            else:
                self.output_processor.process_prompt_logprob(seq_group, output)
                if seq_group_meta.do_sample:
1184
                    self.output_processor.process_outputs(
1185
                        seq_group, output, is_async)
1186

1187
1188
            if seq_group.is_finished():
                finished_now.append(i)
1189

1190
1191
1192
        # Generate outputs for the requests that finished this iteration
        for i in finished_now:
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]
1193

1194
1195
            seq_group = scheduled_seq_group.seq_group
            seq_group.maybe_set_first_token_time(now)
1196
            request_output = RequestOutputFactory.create(
1197
1198
1199
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs)
1200
1201
            if request_output:
                ctx.request_outputs.append(request_output)
1202

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

1215
1216
1217
1218
1219
        # Free currently finished requests
        if finished_now:
            for scheduler in self.scheduler:
                scheduler.free_finished_seq_groups()

1220
1221
        # For multi-step without streaming, don't create outputs each iteration
        if not is_last_step and not ctx.multi_step_stream_outputs:
1222
1223
1224
1225
            # 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)
1226
                ctx.request_outputs.clear()
1227
1228
1229
            return

        # Create the outputs
1230
1231
        for i in indices:
            if i in skip or i in finished_before or i in finished_now:
1232
1233
                continue  # Avoids double processing

1234
1235
            scheduled_seq_group = scheduler_outputs.scheduled_seq_groups[i]

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

1245
1246
1247
1248
1249
1250
1251
1252
        # 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

1253
        for seq_group in scheduler_outputs.ignored_seq_groups:
1254
1255
1256
1257
1258
            params = seq_group.sampling_params
            if params is not None and params.output_kind == (
                    RequestOutputKind.DELTA) and not seq_group.is_finished():
                continue

1259
            request_output = RequestOutputFactory.create(
1260
1261
1262
1263
                seq_group,
                self.seq_id_to_seq_group,
                use_cache=self.use_cached_outputs,
            )
1264
1265
            if request_output:
                ctx.request_outputs.append(request_output)
1266

1267
1268
1269
1270
        # 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)
1271
            ctx.request_outputs.clear()
1272

1273
1274
1275
1276
        # 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:
1277
            # Log stats.
1278
1279
            self.do_log_stats(scheduler_outputs, outputs, finished_before,
                              skip)
1280
1281

            # Tracing
1282
            self.do_tracing(scheduler_outputs, finished_before)
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300

        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

1301
1302
1303
1304
1305
            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)
1306
            else:
1307
1308
1309
1310
                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)
1311

1312
1313
1314
            if seq_group_metadata.do_sample:
                assert len(sequence_group_outputs.samples) == 1, (
                    "Async output processor expects a single sample"
1315
                    " (i.e sampling_params.n == 1)")
1316
1317
1318
1319
                sample = sequence_group_outputs.samples[0]

                assert len(seq_group.seqs) == 1
                seq = seq_group.seqs[0]
1320
1321
1322
1323
1324
1325
1326
1327
1328

                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)
1329

1330
    def step(self) -> List[Union[RequestOutput, EmbeddingRequestOutput]]:
Antoni Baum's avatar
Antoni Baum committed
1331
1332
        """Performs one decoding iteration and returns newly generated results.

1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
        .. 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.

1348
            - Step 2: Calls the distributed executor to execute the model.
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
            - 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)
1370
            >>>         engine.add_request(str(req_id),prompt,sampling_params)
1371
1372
1373
1374
1375
1376
1377
1378
1379
            >>>
            >>>     # 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
1380
        """
1381
1382
1383
1384
        if self.parallel_config.pipeline_parallel_size > 1:
            raise NotImplementedError(
                "Pipeline parallelism is only supported through AsyncLLMEngine "
                "as performance will be severely degraded otherwise.")
1385

1386
        # For llm_engine, there is no pipeline parallel support, so the engine
1387
        # used is always 0.
1388
1389
        virtual_engine = 0

1390
1391
        # These are cached outputs from previous iterations. None if on first
        # iteration
1392
        cached_outputs = self.cached_scheduler_outputs[virtual_engine]
1393
1394
        seq_group_metadata_list = cached_outputs.seq_group_metadata_list
        scheduler_outputs = cached_outputs.scheduler_outputs
1395
        allow_async_output_proc = cached_outputs.allow_async_output_proc
1396

1397
1398
        ctx = self.scheduler_contexts[virtual_engine]

1399
1400
1401
        # Clear outputs for each new scheduler iteration
        ctx.request_outputs.clear()

1402
1403
1404
1405
        # 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):
1406
            # Schedule iteration
1407
            (seq_group_metadata_list, scheduler_outputs,
1408
1409
             allow_async_output_proc
             ) = self.scheduler[virtual_engine].schedule()
1410

1411
1412
            ctx.seq_group_metadata_list = seq_group_metadata_list
            ctx.scheduler_outputs = scheduler_outputs
1413

1414
1415
            # Maybe switch from async mode to sync mode
            if not allow_async_output_proc and len(ctx.output_queue) > 0:
1416
                self._process_model_outputs(ctx=ctx)
1417

1418
1419
1420
1421
1422
            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(
1423
                    virtual_engine, seq_group_metadata_list, scheduler_outputs,
1424
                    allow_async_output_proc)
1425
1426
1427

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

1429
        if not scheduler_outputs.is_empty():
1430
            finished_requests_ids = self.scheduler[
1431
                virtual_engine].get_and_reset_finished_requests_ids()
1432
1433
1434
1435
1436
1437

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

1440
            execute_model_req = ExecuteModelRequest(
1441
1442
1443
1444
                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,
1445
1446
                num_lookahead_slots=scheduler_outputs.num_lookahead_slots,
                running_queue_size=scheduler_outputs.running_queue_size,
1447
1448
1449
1450
1451
                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)

1452
            if allow_async_output_proc:
1453
1454
                execute_model_req.async_callback = self.async_callbacks[
                    virtual_engine]
1455

1456
            outputs = self.model_executor.execute_model(
1457
                execute_model_req=execute_model_req)
1458

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

1471
1472
1473
1474
1475
1476
        # 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):
1477
            # clear the cache if we have finished all the steps.
1478
1479
1480
            if self.scheduler_config.is_multi_step:
                self.cached_scheduler_outputs[0] = SchedulerOutputState()

1481
1482
1483
1484
1485
1486
            # 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

1487
            # Add results to the output_queue
1488
1489
1490
1491
            ctx.append_output(outputs=outputs,
                              seq_group_metadata_list=seq_group_metadata_list,
                              scheduler_outputs=scheduler_outputs,
                              is_async=allow_async_output_proc,
1492
1493
                              is_last_step=True,
                              is_first_step_output=is_first_step_output)
1494
1495
1496

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

1499
                self._advance_to_next_step(
1500
                    outputs[0], seq_group_metadata_list,
1501
                    scheduler_outputs.scheduled_seq_groups)
1502

1503
            # Check if need to run the usual non-async path
1504
            if not allow_async_output_proc:
1505
                self._process_model_outputs(ctx=ctx)
1506

1507
                # Log stats.
1508
                self.do_log_stats(scheduler_outputs, outputs)
1509

1510
1511
1512
                # Tracing
                self.do_tracing(scheduler_outputs)
        else:
1513
            # Multi-step case
1514
            return ctx.request_outputs
1515

1516
        if not self.has_unfinished_requests():
1517
1518
            # Drain async postprocessor (if exists)
            if len(ctx.output_queue) > 0:
1519
                self._process_model_outputs(ctx=ctx)
1520
            assert len(ctx.output_queue) == 0
1521

1522
1523
1524
1525
1526
            # 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.
1527
            logger.debug("Stopping remote worker execution loop.")
1528
1529
            self.model_executor.stop_remote_worker_execution_loop()

1530
        return ctx.request_outputs
Antoni Baum's avatar
Antoni Baum committed
1531

1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
    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:]
        ]):
            raise AssertionError(("All running sequence groups should "
                                  "have the same remaining steps."))

        return ref_remaining_steps > 0

    def _cache_scheduler_outputs_for_multi_step(
            self, virtual_engine: int,
            seq_group_metadata_list: Optional[List[SequenceGroupMetadata]],
1555
1556
1557
1558
1559
1560
1561
1562
            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
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587

    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

1588
    def add_logger(self, logger_name: str, logger: StatLoggerBase) -> None:
1589
1590
1591
1592
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1593
1594
1595
1596
1597
        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:
1598
1599
1600
1601
        if not self.log_stats:
            raise RuntimeError(
                "Stat logging is disabled. Set `disable_log_stats=False` "
                "argument to enable.")
1602
1603
1604
1605
        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]

1606
1607
1608
    def do_log_stats(self,
                     scheduler_outputs: Optional[SchedulerOutputs] = None,
                     model_output: Optional[List[SamplerOutput]] = None,
1609
1610
                     finished_before: Optional[List[int]] = None,
                     skip: Optional[List[int]] = None) -> None:
1611
1612
        """Forced log when no requests active."""
        if self.log_stats:
1613
            stats = self._get_stats(scheduler_outputs, model_output,
1614
                                    finished_before, skip)
1615
            for logger in self.stat_loggers.values():
1616
                logger.log(stats)
1617

1618
1619
1620
    def _get_stats(self,
                   scheduler_outputs: Optional[SchedulerOutputs],
                   model_output: Optional[List[SamplerOutput]] = None,
1621
1622
                   finished_before: Optional[List[int]] = None,
                   skip: Optional[List[int]] = None) -> Stats:
1623
1624
1625
1626
1627
1628
1629
        """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.
1630
1631
1632
1633
            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.
1634
        """
1635
        now = time.time()
Woosuk Kwon's avatar
Woosuk Kwon committed
1636

1637
1638
        # System State
        #   Scheduler State
1639
1640
1641
1642
1643
1644
        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)
1645
1646

        # KV Cache Usage in %
1647
        num_total_gpu = self.cache_config.num_gpu_blocks
1648
        gpu_cache_usage_sys = 0.
1649
        if num_total_gpu:  # Guard against both None and 0
1650
1651
1652
            num_free_gpu = sum(
                scheduler.block_manager.get_num_free_gpu_blocks()
                for scheduler in self.scheduler)
1653
            gpu_cache_usage_sys = 1.0 - (num_free_gpu / num_total_gpu)
Woosuk Kwon's avatar
Woosuk Kwon committed
1654

1655
        num_total_cpu = self.cache_config.num_cpu_blocks
1656
        cpu_cache_usage_sys = 0.
1657
        if num_total_cpu:  # Guard against both None and 0
1658
1659
1660
            num_free_cpu = sum(
                scheduler.block_manager.get_num_free_cpu_blocks()
                for scheduler in self.scheduler)
1661
1662
            cpu_cache_usage_sys = 1.0 - (num_free_cpu / num_total_cpu)

1663
1664
1665
1666
1667
1668
1669
        # 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)

1670
1671
1672
1673
1674
        # Iteration stats
        num_prompt_tokens_iter = 0
        num_generation_tokens_iter = 0
        time_to_first_tokens_iter: List[float] = []
        time_per_output_tokens_iter: List[float] = []
1675
1676
        num_preemption_iter = (0 if scheduler_outputs is None else
                               scheduler_outputs.preempted)
1677
1678
1679
1680

        # Request stats
        #   Latency
        time_e2e_requests: List[float] = []
1681
1682
1683
        time_in_queue_requests: List[float] = []
        model_forward_time_requests: List[float] = []
        model_execute_time_requests: List[float] = []
1684
1685
1686
1687
        #   Metadata
        num_prompt_tokens_requests: List[int] = []
        num_generation_tokens_requests: List[int] = []
        n_requests: List[int] = []
1688
        max_tokens_requests: List[int] = []
1689
1690
        finished_reason_requests: List[str] = []

1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
        # 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)

1710
1711
        # NOTE: This loop assumes prefill seq_groups are before
        # decode seq_groups in scheduled_seq_groups.
1712
        if scheduler_outputs is not None:
1713
1714
1715
1716
            # 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

1717
            num_generation_tokens_from_prefill_groups = 0.
1718
1719
1720
1721
            # 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.
1722
1723
1724

            for idx, scheduled_seq_group in enumerate(
                    scheduler_outputs.scheduled_seq_groups):
1725
1726
1727
1728
                # Skip double logging when using async output proc
                if finished_before and idx in finished_before:
                    actual_num_batched_tokens -= 1
                    continue
1729
1730
1731
1732
1733

                # Currently, skip == preempted sequences, so we need to skip
                # their log stats
                if skip and idx in skip:
                    continue
1734

1735
                group_was_prefill = idx < scheduler_outputs.num_prefill_groups
1736
                seq_group = scheduled_seq_group.seq_group
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758

                # 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():
                        latency = seq_group.get_last_latency(now)
                        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.
                    latency = seq_group.get_last_latency(now)
                    time_per_output_tokens_iter.append(latency)
1759
1760
1761
1762
1763
1764
1765
1766
1767
                    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
1768
1769
1770
1771
1772
1773

                # 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.
1774
                if seq_group.is_finished():
1775
                    # Latency timings
1776
1777
                    time_e2e_requests.append(now -
                                             seq_group.metrics.arrival_time)
1778
1779
1780
1781
1782
1783
1784
1785
1786
                    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)
1787
1788
1789
1790
1791
1792
1793
                    # 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()
                    ])
1794
1795
                    if seq_group.sampling_params is not None:
                        n_requests.append(seq_group.sampling_params.n)
1796
1797
                        max_tokens_requests.append(
                            seq_group.sampling_params.max_tokens)
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
                    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 = (
1810
                actual_num_batched_tokens - num_prompt_tokens_iter +
1811
                num_generation_tokens_from_prefill_groups)
1812

1813
1814
1815
1816
1817
1818
1819
1820
        # Spec decode, if enabled, emits specialized metrics from the worker in
        # sampler output.
        if model_output and (model_output[0].spec_decode_worker_metrics
                             is not None):
            spec_decode_metrics = model_output[0].spec_decode_worker_metrics
        else:
            spec_decode_metrics = None

1821
1822
        return Stats(
            now=now,
1823
1824
1825
1826
1827
1828
1829
1830
            # 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,
1831
1832
1833
            #   Prefix Cache Hit Rate
            cpu_prefix_cache_hit_rate=cpu_prefix_cache_hit_rate,
            gpu_prefix_cache_hit_rate=gpu_prefix_cache_hit_rate,
1834
1835
1836
1837
1838
1839

            # Iteration stats
            num_prompt_tokens_iter=num_prompt_tokens_iter,
            num_generation_tokens_iter=num_generation_tokens_iter,
            time_to_first_tokens_iter=time_to_first_tokens_iter,
            time_per_output_tokens_iter=time_per_output_tokens_iter,
1840
            spec_decode_metrics=spec_decode_metrics,
1841
            num_preemption_iter=num_preemption_iter,
1842
1843
1844
1845

            # Request stats
            #   Latency
            time_e2e_requests=time_e2e_requests,
1846
1847
1848
            time_in_queue_requests=time_in_queue_requests,
            model_forward_time_requests=model_forward_time_requests,
            model_execute_time_requests=model_execute_time_requests,
1849
1850
1851
1852
            #   Metadata
            num_prompt_tokens_requests=num_prompt_tokens_requests,
            num_generation_tokens_requests=num_generation_tokens_requests,
            n_requests=n_requests,
1853
            max_tokens_requests=max_tokens_requests,
1854
            finished_reason_requests=finished_reason_requests,
1855
1856
1857
            max_lora=str(max_lora_stat),
            waiting_lora_adapters=list(waiting_lora_adapters.keys()),
            running_lora_adapters=list(running_lora_adapters.keys()))
1858

1859
    def add_lora(self, lora_request: LoRARequest) -> bool:
1860
        return self.model_executor.add_lora(lora_request)
1861
1862

    def remove_lora(self, lora_id: int) -> bool:
1863
        return self.model_executor.remove_lora(lora_id)
1864

1865
    def list_loras(self) -> Set[int]:
1866
        return self.model_executor.list_loras()
1867

1868
1869
1870
    def pin_lora(self, lora_id: int) -> bool:
        return self.model_executor.pin_lora(lora_id)

1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
    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()

1881
    def check_health(self) -> None:
1882
1883
        if self.tokenizer:
            self.tokenizer.check_health()
1884
        self.model_executor.check_health()
1885

1886
    def start_profile(self) -> None:
1887
1888
        # using type instead of isinstance to check to avoid capturing
        # inherited classes (MultiprocessingGPUExecutor)
1889
        if type(self.model_executor) == GPUExecutor:  # noqa: E721
1890
1891
1892
            self.model_executor.start_profile()
        else:
            self.model_executor._run_workers("start_profile")
1893
1894

    def stop_profile(self) -> None:
1895
1896
        # using type instead of isinstance to check to avoid capturing
        # inherited classes (MultiprocessingGPUExecutor)
1897
        if type(self.model_executor) == GPUExecutor:  # noqa: E721
1898
1899
1900
            self.model_executor.stop_profile()
        else:
            self.model_executor._run_workers("stop_profile")
1901

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

1905
1906
1907
    def do_tracing(self,
                   scheduler_outputs: SchedulerOutputs,
                   finished_before: Optional[List[int]] = None) -> None:
1908
1909
1910
        if self.tracer is None:
            return

1911
1912
1913
1914
1915
1916
        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

1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
            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
            # attribute names are based on
            # https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/llm-spans.md
            seq_span.set_attribute(SpanAttributes.LLM_RESPONSE_MODEL,
                                   self.model_config.model)
            seq_span.set_attribute(SpanAttributes.LLM_REQUEST_ID,
                                   seq_group.request_id)
            seq_span.set_attribute(SpanAttributes.LLM_REQUEST_TEMPERATURE,
                                   seq_group.sampling_params.temperature)
            seq_span.set_attribute(SpanAttributes.LLM_REQUEST_TOP_P,
                                   seq_group.sampling_params.top_p)
            seq_span.set_attribute(SpanAttributes.LLM_REQUEST_MAX_TOKENS,
                                   seq_group.sampling_params.max_tokens)
            seq_span.set_attribute(SpanAttributes.LLM_REQUEST_N,
                                   seq_group.sampling_params.n)
            seq_span.set_attribute(SpanAttributes.LLM_USAGE_NUM_SEQUENCES,
                                   seq_group.num_seqs())
            seq_span.set_attribute(SpanAttributes.LLM_USAGE_PROMPT_TOKENS,
                                   len(seq_group.prompt_token_ids))
            seq_span.set_attribute(
                SpanAttributes.LLM_USAGE_COMPLETION_TOKENS,
                sum([
                    seq.get_output_len()
                    for seq in seq_group.get_finished_seqs()
                ]))
            seq_span.set_attribute(SpanAttributes.LLM_LATENCY_TIME_IN_QUEUE,
                                   metrics.time_in_queue)
            seq_span.set_attribute(
                SpanAttributes.LLM_LATENCY_TIME_TO_FIRST_TOKEN, ttft)
            seq_span.set_attribute(SpanAttributes.LLM_LATENCY_E2E, e2e_time)
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
            if metrics.scheduler_time is not None:
                seq_span.set_attribute(
                    SpanAttributes.LLM_LATENCY_TIME_IN_SCHEDULER,
                    metrics.scheduler_time)
            if metrics.model_forward_time is not None:
                seq_span.set_attribute(
                    SpanAttributes.LLM_LATENCY_TIME_IN_MODEL_FORWARD,
                    metrics.model_forward_time / 1000.0)
            if metrics.model_execute_time is not None:
                seq_span.set_attribute(
                    SpanAttributes.LLM_LATENCY_TIME_IN_MODEL_EXECUTE,
                    metrics.model_execute_time)
1977
1978

    def is_encoder_decoder_model(self):
1979
        return self.input_preprocessor.is_encoder_decoder_model()
1980

1981
    def _validate_model_inputs(self, inputs: Union[DecoderOnlyInputs,
1982
1983
                                                   EncoderDecoderInputs],
                               lora_request: Optional[LoRARequest]):
1984
1985
1986
1987
1988
        if self.model_config.is_multimodal_model:
            # For encoder-decoder multimodal models, the max_prompt_len
            # restricts the decoder prompt length
            prompt_ids = inputs.get("prompt_token_ids")
        elif self.is_encoder_decoder_model():
1989
1990
1991
1992
1993
            prompt_ids = inputs.get("encoder_prompt_token_ids")
        else:
            prompt_ids = inputs.get("prompt_token_ids")

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

1996
        if self.model_config.is_multimodal_model:
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
            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.")
2007
2008
2009
2010

            # 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
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020

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

2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
        if (guided_decoding := sampling_params.guided_decoding) is not None:

            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(
                guided_params=guided_decoding, tokenizer=tokenizer)
            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)

2043
            processors = get_openai_logits_processors(
2044
2045
2046
2047
2048
2049
2050
2051
2052
                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

2053
2054
2055
2056
2057
2058
        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)

2059
2060
2061
2062
2063
2064
2065
        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