arg_utils.py 81.3 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

3
import argparse
4
import dataclasses
5
import json
6
import re
7
import threading
8
from dataclasses import dataclass
9
from typing import (TYPE_CHECKING, Any, Dict, List, Literal, Mapping, Optional,
10
                    Tuple, Type, Union, cast, get_args)
11

12
13
import torch

14
import vllm.envs as envs
15
from vllm import version
16
from vllm.config import (CacheConfig, CompilationConfig, ConfigFormat,
17
18
                         DecodingConfig, DeviceConfig, HfOverrides,
                         KVTransferConfig, LoadConfig, LoadFormat, LoRAConfig,
19
20
21
22
                         ModelConfig, ModelImpl, ObservabilityConfig,
                         ParallelConfig, PoolerConfig, PromptAdapterConfig,
                         SchedulerConfig, SpeculativeConfig, TaskOption,
                         TokenizerPoolConfig, VllmConfig)
23
from vllm.executor.executor_base import ExecutorBase
24
from vllm.logger import init_logger
25
from vllm.model_executor.layers.quantization import QUANTIZATION_METHODS
26
from vllm.plugins import load_general_plugins
27
from vllm.reasoning import ReasoningParserManager
28
from vllm.test_utils import MODEL_WEIGHTS_S3_BUCKET, MODELS_ON_S3
29
from vllm.transformers_utils.utils import check_gguf_file
30
from vllm.usage.usage_lib import UsageContext
31
from vllm.utils import FlexibleArgumentParser, StoreBoolean, is_in_ray_actor
32

33
if TYPE_CHECKING:
34
    from vllm.transformers_utils.tokenizer_group import BaseTokenizerGroup
35

36
37
logger = init_logger(__name__)

38
39
ALLOWED_DETAILED_TRACE_MODULES = ["model", "worker", "all"]

40
41
42
43
44
45
46
DEVICE_OPTIONS = [
    "auto",
    "cuda",
    "neuron",
    "cpu",
    "tpu",
    "xpu",
47
    "hpu",
48
49
]

50

51
52
53
54
55
56
def nullable_str(val: str):
    if not val or val == "None":
        return None
    return val


57
def nullable_kvs(val: str) -> Optional[Mapping[str, int]]:
58
59
60
61
62
63
64
65
66
    """Parses a string containing comma separate key [str] to value [int]
    pairs into a dictionary.

    Args:
        val: String value to be parsed.

    Returns:
        Dictionary with parsed values.
    """
67
68
69
70
71
    if len(val) == 0:
        return None

    out_dict: Dict[str, int] = {}
    for item in val.split(","):
72
73
74
75
76
        kv_parts = [part.lower().strip() for part in item.split("=")]
        if len(kv_parts) != 2:
            raise argparse.ArgumentTypeError(
                "Each item should be in the form KEY=VALUE")
        key, value = kv_parts
77
78

        try:
79
            parsed_value = int(value)
80
81
        except ValueError as exc:
            msg = f"Failed to parse value of item {key}={value}"
82
83
84
85
86
87
            raise argparse.ArgumentTypeError(msg) from exc

        if key in out_dict and out_dict[key] != parsed_value:
            raise argparse.ArgumentTypeError(
                f"Conflicting values specified for key: {key}")
        out_dict[key] = parsed_value
88
89
90
91

    return out_dict


92
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
93
class EngineArgs:
Woosuk Kwon's avatar
Woosuk Kwon committed
94
    """Arguments for vLLM engine."""
95
    model: str = 'facebook/opt-125m'
96
    served_model_name: Optional[Union[str, List[str]]] = None
97
    tokenizer: Optional[str] = None
98
    hf_config_path: Optional[str] = None
99
    task: TaskOption = "auto"
100
    skip_tokenizer_init: bool = False
101
    tokenizer_mode: str = 'auto'
102
    trust_remote_code: bool = False
103
    allowed_local_media_path: str = ""
104
    download_dir: Optional[str] = None
105
    load_format: str = 'auto'
106
    config_format: ConfigFormat = ConfigFormat.AUTO
107
    dtype: str = 'auto'
108
    kv_cache_dtype: str = 'auto'
109
    seed: Optional[int] = None
110
    max_model_len: Optional[int] = None
111
112
113
114
115
    # Note: Specifying a custom executor backend by passing a class
    # is intended for expert use only. The API may change without
    # notice.
    distributed_executor_backend: Optional[Union[str,
                                                 Type[ExecutorBase]]] = None
116
    # number of P/D disaggregation (or other disaggregation) workers
117
118
    pipeline_parallel_size: int = 1
    tensor_parallel_size: int = 1
119
    data_parallel_size: int = 1
120
    enable_expert_parallel: bool = False
121
    max_parallel_loading_workers: Optional[int] = None
122
    block_size: Optional[int] = None
123
    enable_prefix_caching: Optional[bool] = None
124
    prefix_caching_hash_algo: str = "builtin"
125
    disable_sliding_window: bool = False
126
    disable_cascade_attn: bool = False
127
    use_v2_block_manager: bool = True
128
129
    swap_space: float = 4  # GiB
    cpu_offload_gb: float = 0  # GiB
130
    gpu_memory_utilization: float = 0.90
131
    max_num_batched_tokens: Optional[int] = None
132
133
134
    max_num_partial_prefills: Optional[int] = 1
    max_long_partial_prefills: Optional[int] = 1
    long_prefill_token_threshold: Optional[int] = 0
135
    max_num_seqs: Optional[int] = None
136
    max_logprobs: int = 20  # Default value for OpenAI Chat Completions API
137
    disable_log_stats: bool = False
Jasmond L's avatar
Jasmond L committed
138
    revision: Optional[str] = None
139
    code_revision: Optional[str] = None
140
    rope_scaling: Optional[Dict[str, Any]] = None
141
    rope_theta: Optional[float] = None
142
    hf_token: Optional[Union[bool, str]] = None
143
    hf_overrides: Optional[HfOverrides] = None
144
    tokenizer_revision: Optional[str] = None
145
    quantization: Optional[str] = None
146
    enforce_eager: Optional[bool] = None
147
    max_seq_len_to_capture: int = 8192
148
    disable_custom_all_reduce: bool = False
149
    tokenizer_pool_size: int = 0
150
151
152
153
    # Note: Specifying a tokenizer pool by passing a class
    # is intended for expert use only. The API may change without
    # notice.
    tokenizer_pool_type: Union[str, Type["BaseTokenizerGroup"]] = "ray"
154
    tokenizer_pool_extra_config: Optional[Dict[str, Any]] = None
155
    limit_mm_per_prompt: Optional[Mapping[str, int]] = None
156
    mm_processor_kwargs: Optional[Dict[str, Any]] = None
157
    disable_mm_preprocessor_cache: bool = False
158
    enable_lora: bool = False
159
    enable_lora_bias: bool = False
160
161
    max_loras: int = 1
    max_lora_rank: int = 16
162
163
164
    enable_prompt_adapter: bool = False
    max_prompt_adapters: int = 1
    max_prompt_adapter_token: int = 0
165
    fully_sharded_loras: bool = False
166
    lora_extra_vocab_size: int = 256
167
    long_lora_scaling_factors: Optional[Tuple[float]] = None
168
    lora_dtype: Optional[Union[str, torch.dtype]] = 'auto'
169
    max_cpu_loras: Optional[int] = None
170
    device: str = 'auto'
171
    num_scheduler_steps: int = 1
172
    multi_step_stream_outputs: bool = True
173
    ray_workers_use_nsight: bool = False
174
    num_gpu_blocks_override: Optional[int] = None
175
    num_lookahead_slots: int = 0
176
    model_loader_extra_config: Optional[dict] = None
177
    ignore_patterns: Optional[Union[str, List[str]]] = None
178
    preemption_mode: Optional[str] = None
179

180
    scheduler_delay_factor: float = 0.0
181
    enable_chunked_prefill: Optional[bool] = None
182
    disable_chunked_mm_input: bool = False
183

184
    guided_decoding_backend: str = 'xgrammar'
185
    logits_processor_pattern: Optional[str] = None
186

187
    speculative_config: Optional[Dict[str, Any]] = None
188

189
    qlora_adapter_name_or_path: Optional[str] = None
190
    show_hidden_metrics_for_version: Optional[str] = None
191
    otlp_traces_endpoint: Optional[str] = None
192
    collect_detailed_traces: Optional[str] = None
193
    disable_async_output_proc: bool = False
194
    scheduling_policy: Literal["fcfs", "priority"] = "fcfs"
195
    scheduler_cls: Union[str, Type[object]] = "vllm.core.scheduler.Scheduler"
196

197
198
    override_neuron_config: Optional[Dict[str, Any]] = None
    override_pooler_config: Optional[PoolerConfig] = None
199
    compilation_config: Optional[CompilationConfig] = None
200
    worker_cls: str = "auto"
201
    worker_extension_cls: str = ""
202

203
204
    kv_transfer_config: Optional[KVTransferConfig] = None

205
    generation_config: Optional[str] = "auto"
206
    override_generation_config: Optional[Dict[str, Any]] = None
207
    enable_sleep_mode: bool = False
208
    model_impl: str = "auto"
209

210
211
    calculate_kv_scales: Optional[bool] = None

212
    additional_config: Optional[Dict[str, Any]] = None
213
214
    enable_reasoning: Optional[bool] = None
    reasoning_parser: Optional[str] = None
215
    use_tqdm_on_load: bool = True
216

217
    def __post_init__(self):
218
        if not self.tokenizer:
219
            self.tokenizer = self.model
220

221
222
223
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
224
        if isinstance(self.compilation_config, (int, dict)):
225
226
            self.compilation_config = CompilationConfig.from_cli(
                str(self.compilation_config))
227

228
        # Setup plugins
229
230
        from vllm.plugins import load_general_plugins
        load_general_plugins()
231
232

    @staticmethod
233
    def add_cli_args(parser: FlexibleArgumentParser) -> FlexibleArgumentParser:
Woosuk Kwon's avatar
Woosuk Kwon committed
234
        """Shared CLI arguments for vLLM engine."""
235
        # Model arguments
236
237
238
        parser.add_argument(
            '--model',
            type=str,
239
            default=EngineArgs.model,
240
            help='Name or path of the huggingface model to use.')
241
242
243
244
245
246
        parser.add_argument(
            '--task',
            default=EngineArgs.task,
            choices=get_args(TaskOption),
            help='The task to use the model for. Each vLLM instance only '
            'supports one task, even if the same model can be used for '
247
            'multiple tasks. When the model only supports one task, ``"auto"`` '
248
249
            'can be used to select it; otherwise, you must specify explicitly '
            'which task to use.')
250
251
        parser.add_argument(
            '--tokenizer',
252
            type=nullable_str,
253
            default=EngineArgs.tokenizer,
254
255
            help='Name or path of the huggingface tokenizer to use. '
            'If unspecified, model name or path will be used.')
256
257
258
259
260
261
        parser.add_argument(
            "--hf-config-path",
            type=nullable_str,
            default=EngineArgs.hf_config_path,
            help='Name or path of the huggingface config to use. '
            'If unspecified, model name or path will be used.')
262
263
264
        parser.add_argument(
            '--skip-tokenizer-init',
            action='store_true',
265
266
267
            help='Skip initialization of tokenizer and detokenizer. '
            'Expects valid prompt_token_ids and None for prompt from '
            'the input. The generated output will contain token ids.')
Jasmond L's avatar
Jasmond L committed
268
269
        parser.add_argument(
            '--revision',
270
            type=nullable_str,
Jasmond L's avatar
Jasmond L committed
271
            default=None,
272
            help='The specific model version to use. It can be a branch '
Jasmond L's avatar
Jasmond L committed
273
274
            'name, a tag name, or a commit id. If unspecified, will use '
            'the default version.')
275
276
        parser.add_argument(
            '--code-revision',
277
            type=nullable_str,
278
            default=None,
279
            help='The specific revision to use for the model code on '
280
281
            'Hugging Face Hub. It can be a branch name, a tag name, or a '
            'commit id. If unspecified, will use the default version.')
282
283
        parser.add_argument(
            '--tokenizer-revision',
284
            type=nullable_str,
285
            default=None,
286
287
288
            help='Revision of the huggingface tokenizer to use. '
            'It can be a branch name, a tag name, or a commit id. '
            'If unspecified, will use the default version.')
289
290
291
292
        parser.add_argument(
            '--tokenizer-mode',
            type=str,
            default=EngineArgs.tokenizer_mode,
293
            choices=['auto', 'slow', 'mistral', 'custom'],
294
295
            help='The tokenizer mode.\n\n* "auto" will use the '
            'fast tokenizer if available.\n* "slow" will '
296
            'always use the slow tokenizer. \n* '
297
298
299
            '"mistral" will always use the `mistral_common` tokenizer. \n* '
            '"custom" will use --tokenizer to select the '
            'preregistered tokenizer.')
300
301
        parser.add_argument('--trust-remote-code',
                            action='store_true',
302
                            help='Trust remote code from huggingface.')
303
304
305
        parser.add_argument(
            '--allowed-local-media-path',
            type=str,
306
307
308
309
            help="Allowing API requests to read local images or videos "
            "from directories specified by the server file system. "
            "This is a security risk. "
            "Should only be enabled in trusted environments.")
310
        parser.add_argument('--download-dir',
311
                            type=nullable_str,
Zhuohan Li's avatar
Zhuohan Li committed
312
                            default=EngineArgs.download_dir,
313
                            help='Directory to download and load the weights.')
314
315
316
317
        parser.add_argument(
            '--load-format',
            type=str,
            default=EngineArgs.load_format,
318
            choices=[f.value for f in LoadFormat],
319
320
            help='The format of the model weights to load.\n\n'
            '* "auto" will try to load the weights in the safetensors format '
321
            'and fall back to the pytorch bin format if safetensors format '
322
323
324
325
326
327
328
329
            'is not available.\n'
            '* "pt" will load the weights in the pytorch bin format.\n'
            '* "safetensors" will load the weights in the safetensors format.\n'
            '* "npcache" will load the weights in pytorch format and store '
            'a numpy cache to speed up the loading.\n'
            '* "dummy" will initialize the weights with random values, '
            'which is mainly for profiling.\n'
            '* "tensorizer" will load the weights using tensorizer from '
330
            'CoreWeave. See the Tensorize vLLM Model script in the Examples '
331
            'section for more information.\n'
332
            '* "runai_streamer" will load the Safetensors weights using Run:ai'
333
            'Model Streamer.\n'
334
            '* "bitsandbytes" will load the weights using bitsandbytes '
335
336
337
338
339
340
341
            'quantization.\n'
            '* "sharded_state" will load weights from pre-sharded checkpoint '
            'files, supporting efficient loading of tensor-parallel models\n'
            '* "gguf" will load weights from GGUF format files (details '
            'specified in https://github.com/ggml-org/ggml/blob/master/docs/gguf.md).\n'
            '* "mistral" will load weights from consolidated safetensors files '
            'used by Mistral models.\n')
342
343
344
345
346
347
348
        parser.add_argument(
            '--config-format',
            default=EngineArgs.config_format,
            choices=[f.value for f in ConfigFormat],
            help='The format of the model config to load.\n\n'
            '* "auto" will try to load the config in hf format '
            'if available else it will try to load in mistral format ')
349
350
351
352
        parser.add_argument(
            '--dtype',
            type=str,
            default=EngineArgs.dtype,
Woosuk Kwon's avatar
Woosuk Kwon committed
353
354
355
            choices=[
                'auto', 'half', 'float16', 'bfloat16', 'float', 'float32'
            ],
356
357
358
359
360
361
362
363
            help='Data type for model weights and activations.\n\n'
            '* "auto" will use FP16 precision for FP32 and FP16 models, and '
            'BF16 precision for BF16 models.\n'
            '* "half" for FP16. Recommended for AWQ quantization.\n'
            '* "float16" is the same as "half".\n'
            '* "bfloat16" for a balance between precision and range.\n'
            '* "float" is shorthand for FP32 precision.\n'
            '* "float32" for FP32 precision.')
364
365
366
        parser.add_argument(
            '--kv-cache-dtype',
            type=str,
367
            choices=['auto', 'fp8', 'fp8_e5m2', 'fp8_e4m3'],
368
            default=EngineArgs.kv_cache_dtype,
369
            help='Data type for kv cache storage. If "auto", will use model '
370
371
            'data type. CUDA 11.8+ supports fp8 (=fp8_e4m3) and fp8_e5m2. '
            'ROCm (AMD GPU) supports fp8 (=fp8_e4m3)')
372
        parser.add_argument('--max-model-len',
373
                            type=human_readable_int,
374
                            default=EngineArgs.max_model_len,
375
                            help='Model context length. If unspecified, will '
376
377
378
379
380
                            'be automatically derived from the model config. '
                            'Supports k/m/g/K/M/G in human-readable format.\n'
                            'Examples:\n'
                            '- 1k → 1000\n'
                            '- 1K → 1024\n')
381
382
383
        parser.add_argument(
            '--guided-decoding-backend',
            type=str,
384
            default='xgrammar',
385
            help='Which engine will be used for guided decoding'
386
            ' (JSON schema / regex etc) by default. Currently support '
387
388
389
390
391
            'https://github.com/mlc-ai/xgrammar and '
            'https://github.com/guidance-ai/llguidance.'
            'Valid backend values are "xgrammar", "guidance", and "auto". '
            'With "auto", we will make opinionated choices based on request'
            'contents and what the backend libraries currently support, so '
392
            'the behavior is subject to change in each release.')
393
394
395
396
397
398
399
400
        parser.add_argument(
            '--logits-processor-pattern',
            type=nullable_str,
            default=None,
            help='Optional regex pattern specifying valid logits processor '
            'qualified names that can be passed with the `logits_processors` '
            'extra completion argument. Defaults to None, which allows no '
            'processors.')
401
402
403
404
405
406
407
408
409
410
411
412
        parser.add_argument(
            '--model-impl',
            type=str,
            default=EngineArgs.model_impl,
            choices=[f.value for f in ModelImpl],
            help='Which implementation of the model to use.\n\n'
            '* "auto" will try to use the vLLM implementation if it exists '
            'and fall back to the Transformers implementation if no vLLM '
            'implementation is available.\n'
            '* "vllm" will use the vLLM model implementation.\n'
            '* "transformers" will use the Transformers model '
            'implementation.\n')
413
        # Parallel arguments
414
415
        parser.add_argument(
            '--distributed-executor-backend',
416
            choices=['ray', 'mp', 'uni', 'external_launcher'],
417
            default=EngineArgs.distributed_executor_backend,
418
419
420
421
422
423
            help='Backend to use for distributed model '
            'workers, either "ray" or "mp" (multiprocessing). If the product '
            'of pipeline_parallel_size and tensor_parallel_size is less than '
            'or equal to the number of GPUs available, "mp" will be used to '
            'keep processing on a single host. Otherwise, this will default '
            'to "ray" if Ray is installed and fail otherwise. Note that tpu '
424
            'only supports Ray for distributed inference.')
425

426
427
428
        parser.add_argument('--pipeline-parallel-size',
                            '-pp',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
429
                            default=EngineArgs.pipeline_parallel_size,
430
                            help='Number of pipeline stages.')
431
432
433
        parser.add_argument('--tensor-parallel-size',
                            '-tp',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
434
                            default=EngineArgs.tensor_parallel_size,
435
                            help='Number of tensor parallel replicas.')
436
437
438
439
440
441
442
443
        parser.add_argument('--data-parallel-size',
                            '-dp',
                            type=int,
                            default=EngineArgs.data_parallel_size,
                            help='Number of data parallel replicas. '
                            'MoE layers will be sharded according to the '
                            'product of the tensor-parallel-size and '
                            'data-parallel-size.')
444
445
446
447
448
        parser.add_argument(
            '--enable-expert-parallel',
            action='store_true',
            help='Use expert parallelism instead of tensor parallelism '
            'for MoE layers.')
449
450
451
        parser.add_argument(
            '--max-parallel-loading-workers',
            type=int,
452
            default=EngineArgs.max_parallel_loading_workers,
453
            help='Load model sequentially in multiple batches, '
454
            'to avoid RAM OOM when using tensor '
455
            'parallel and large models.')
456
457
458
        parser.add_argument(
            '--ray-workers-use-nsight',
            action='store_true',
459
            help='If specified, use nsight to profile Ray workers.')
460
        # KV cache arguments
461
462
        parser.add_argument('--block-size',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
463
                            default=EngineArgs.block_size,
464
                            choices=[8, 16, 32, 64, 128],
465
                            help='Token block size for contiguous chunks of '
466
                            'tokens. This is ignored on neuron devices and '
467
                            'set to ``--max-model-len``. On CUDA devices, '
468
469
                            'only block sizes up to 32 are supported. '
                            'On HPU devices, block size defaults to 128.')
470

471
472
473
474
475
        parser.add_argument(
            "--enable-prefix-caching",
            action=argparse.BooleanOptionalAction,
            default=EngineArgs.enable_prefix_caching,
            help="Enables automatic prefix caching. "
476
            "Use ``--no-enable-prefix-caching`` to disable explicitly.",
477
        )
478
479
480
481
482
483
484
        parser.add_argument(
            "--prefix-caching-hash-algo",
            type=str,
            choices=["builtin", "sha256"],
            default=EngineArgs.prefix_caching_hash_algo,
            help="Set the hash algorithm for prefix caching. "
            "Options are 'builtin' (Python's built-in hash) or 'sha256' "
485
            "(collision resistant but with certain overheads).",
486
        )
487
488
489
        parser.add_argument('--disable-sliding-window',
                            action='store_true',
                            help='Disables sliding window, '
490
                            'capping to sliding window size.')
491
492
        parser.add_argument('--use-v2-block-manager',
                            action='store_true',
493
                            default=True,
494
495
496
497
498
                            help='[DEPRECATED] block manager v1 has been '
                            'removed and SelfAttnBlockSpaceManager (i.e. '
                            'block manager v2) is now the default. '
                            'Setting this flag to True or False'
                            ' has no effect on vLLM behavior.')
499
500
501
502
503
504
505
506
        parser.add_argument(
            '--num-lookahead-slots',
            type=int,
            default=EngineArgs.num_lookahead_slots,
            help='Experimental scheduling config necessary for '
            'speculative decoding. This will be replaced by '
            'speculative config in the future; it is present '
            'to enable correctness tests until then.')
507

508
509
510
        parser.add_argument('--seed',
                            type=int,
                            default=EngineArgs.seed,
511
                            help='Random seed for operations.')
512
        parser.add_argument('--swap-space',
513
                            type=float,
Zhuohan Li's avatar
Zhuohan Li committed
514
                            default=EngineArgs.swap_space,
515
                            help='CPU swap space size (GiB) per GPU.')
516
517
518
519
520
521
522
523
524
        parser.add_argument(
            '--cpu-offload-gb',
            type=float,
            default=0,
            help='The space in GiB to offload to CPU, per GPU. '
            'Default is 0, which means no offloading. Intuitively, '
            'this argument can be seen as a virtual way to increase '
            'the GPU memory size. For example, if you have one 24 GB '
            'GPU and set this to 10, virtually you can think of it as '
525
            'a 34 GB GPU. Then you can load a 13B model with BF16 weight, '
526
            'which requires at least 26GB GPU memory. Note that this '
527
            'requires fast CPU-GPU interconnect, as part of the model is '
528
529
            'loaded from CPU memory to GPU memory on the fly in each '
            'model forward pass.')
530
531
532
533
        parser.add_argument(
            '--gpu-memory-utilization',
            type=float,
            default=EngineArgs.gpu_memory_utilization,
534
535
536
            help='The fraction of GPU memory to be used for the model '
            'executor, which can range from 0 to 1. For example, a value of '
            '0.5 would imply 50%% GPU memory utilization. If unspecified, '
537
538
539
540
541
542
            'will use the default value of 0.9. This is a per-instance '
            'limit, and only applies to the current vLLM instance.'
            'It does not matter if you have another vLLM instance running '
            'on the same GPU. For example, if you have two vLLM instances '
            'running on the same GPU, you can set the GPU memory utilization '
            'to 0.5 for each instance.')
543
        parser.add_argument(
544
            '--num-gpu-blocks-override',
545
546
547
            type=int,
            default=None,
            help='If specified, ignore GPU profiling result and use this number'
548
            ' of GPU blocks. Used for testing preemption.')
549
550
        parser.add_argument('--max-num-batched-tokens',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
551
                            default=EngineArgs.max_num_batched_tokens,
552
553
                            help='Maximum number of batched tokens per '
                            'iteration.')
554
555
556
557
558
        parser.add_argument(
            "--max-num-partial-prefills",
            type=int,
            default=EngineArgs.max_num_partial_prefills,
            help="For chunked prefill, the max number of concurrent \
559
            partial prefills.")
560
561
562
563
564
565
566
567
        parser.add_argument(
            "--max-long-partial-prefills",
            type=int,
            default=EngineArgs.max_long_partial_prefills,
            help="For chunked prefill, the maximum number of prompts longer "
            "than --long-prefill-token-threshold that will be prefilled "
            "concurrently. Setting this less than --max-num-partial-prefills "
            "will allow shorter prompts to jump the queue in front of longer "
568
            "prompts in some cases, improving latency.")
569
570
571
572
573
        parser.add_argument(
            "--long-prefill-token-threshold",
            type=float,
            default=EngineArgs.long_prefill_token_threshold,
            help="For chunked prefill, a request is considered long if the "
574
            "prompt is longer than this number of tokens.")
575
576
        parser.add_argument('--max-num-seqs',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
577
                            default=EngineArgs.max_num_seqs,
578
                            help='Maximum number of sequences per iteration.')
579
580
581
582
        parser.add_argument(
            '--max-logprobs',
            type=int,
            default=EngineArgs.max_logprobs,
583
584
            help=('Max number of log probs to return logprobs is specified in'
                  ' SamplingParams.'))
585
586
        parser.add_argument('--disable-log-stats',
                            action='store_true',
587
                            help='Disable logging statistics.')
588
589
590
        # Quantization settings.
        parser.add_argument('--quantization',
                            '-q',
591
                            type=nullable_str,
592
                            choices=[*QUANTIZATION_METHODS, None],
593
                            default=EngineArgs.quantization,
594
595
596
597
598
599
                            help='Method used to quantize the weights. If '
                            'None, we first check the `quantization_config` '
                            'attribute in the model config file. If that is '
                            'None, we assume the model weights are not '
                            'quantized and use `dtype` to determine the data '
                            'type of the weights.')
600
601
602
603
604
        parser.add_argument(
            '--rope-scaling',
            default=None,
            type=json.loads,
            help='RoPE scaling configuration in JSON format. '
605
            'For example, ``{"rope_type":"dynamic","factor":2.0}``')
606
607
608
609
610
611
        parser.add_argument('--rope-theta',
                            default=None,
                            type=float,
                            help='RoPE theta. Use with `rope_scaling`. In '
                            'some cases, changing the RoPE theta improves the '
                            'performance of the scaled model.')
612
613
614
615
616
617
618
619
620
621
        parser.add_argument(
            '--hf-token',
            type=str,
            nargs='?',
            const=True,
            default=None,
            help='The token to use as HTTP bearer authorization'
            ' for remote files. If `True`, will use the token '
            'generated when running `huggingface-cli login` '
            '(stored in `~/.huggingface`).')
622
623
624
        parser.add_argument('--hf-overrides',
                            type=json.loads,
                            default=EngineArgs.hf_overrides,
625
                            help='Extra arguments for the HuggingFace config. '
626
627
                            'This should be a JSON string that will be '
                            'parsed into a dictionary.')
628
629
630
631
632
        parser.add_argument('--enforce-eager',
                            action='store_true',
                            help='Always use eager-mode PyTorch. If False, '
                            'will use eager mode and CUDA graph in hybrid '
                            'for maximal performance and flexibility.')
633
        parser.add_argument('--max-seq-len-to-capture',
634
635
636
637
                            type=int,
                            default=EngineArgs.max_seq_len_to_capture,
                            help='Maximum sequence length covered by CUDA '
                            'graphs. When a sequence has context length '
638
639
640
641
                            'larger than this, we fall back to eager mode. '
                            'Additionally for encoder-decoder models, if the '
                            'sequence length of the encoder input is larger '
                            'than this, we fall back to the eager mode.')
642
643
644
        parser.add_argument('--disable-custom-all-reduce',
                            action='store_true',
                            default=EngineArgs.disable_custom_all_reduce,
645
                            help='See ParallelConfig.')
646
647
648
649
650
651
652
653
654
655
656
657
658
        parser.add_argument('--tokenizer-pool-size',
                            type=int,
                            default=EngineArgs.tokenizer_pool_size,
                            help='Size of tokenizer pool to use for '
                            'asynchronous tokenization. If 0, will '
                            'use synchronous tokenization.')
        parser.add_argument('--tokenizer-pool-type',
                            type=str,
                            default=EngineArgs.tokenizer_pool_type,
                            help='Type of tokenizer pool to use for '
                            'asynchronous tokenization. Ignored '
                            'if tokenizer_pool_size is 0.')
        parser.add_argument('--tokenizer-pool-extra-config',
659
                            type=nullable_str,
660
661
662
663
664
                            default=EngineArgs.tokenizer_pool_extra_config,
                            help='Extra config for tokenizer pool. '
                            'This should be a JSON string that will be '
                            'parsed into a dictionary. Ignored if '
                            'tokenizer_pool_size is 0.')
665
666
667
668
669
670
671

        # Multimodal related configs
        parser.add_argument(
            '--limit-mm-per-prompt',
            type=nullable_kvs,
            default=EngineArgs.limit_mm_per_prompt,
            # The default value is given in
672
            # MultiModalConfig.get_limit_per_prompt
673
674
675
676
677
678
            help=('For each multimodal plugin, limit how many '
                  'input instances to allow for each prompt. '
                  'Expects a comma-separated list of items, '
                  'e.g.: `image=16,video=2` allows a maximum of 16 '
                  'images and 2 videos per prompt. Defaults to 1 for '
                  'each modality.'))
679
680
681
682
        parser.add_argument(
            '--mm-processor-kwargs',
            default=None,
            type=json.loads,
683
            help=('Overrides for the multimodal input mapping/processing, '
684
                  'e.g., image processor. For example: ``{"num_crops": 4}``.'))
685
        parser.add_argument(
686
            '--disable-mm-preprocessor-cache',
687
            action='store_true',
688
689
            help='If true, then disables caching of the multi-modal '
            'preprocessor/mapper. (not recommended)')
690

691
692
693
694
        # LoRA related configs
        parser.add_argument('--enable-lora',
                            action='store_true',
                            help='If True, enable handling of LoRA adapters.')
695
696
697
        parser.add_argument('--enable-lora-bias',
                            action='store_true',
                            help='If True, enable bias for LoRA adapters.')
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
        parser.add_argument('--max-loras',
                            type=int,
                            default=EngineArgs.max_loras,
                            help='Max number of LoRAs in a single batch.')
        parser.add_argument('--max-lora-rank',
                            type=int,
                            default=EngineArgs.max_lora_rank,
                            help='Max LoRA rank.')
        parser.add_argument(
            '--lora-extra-vocab-size',
            type=int,
            default=EngineArgs.lora_extra_vocab_size,
            help=('Maximum size of extra vocabulary that can be '
                  'present in a LoRA adapter (added to the base '
                  'model vocabulary).'))
        parser.add_argument(
            '--lora-dtype',
            type=str,
            default=EngineArgs.lora_dtype,
717
            choices=['auto', 'float16', 'bfloat16'],
718
719
            help=('Data type for LoRA. If auto, will default to '
                  'base model dtype.'))
720
721
722
723
724
725
726
727
728
729
730
        parser.add_argument(
            '--long-lora-scaling-factors',
            type=nullable_str,
            default=EngineArgs.long_lora_scaling_factors,
            help=('Specify multiple scaling factors (which can '
                  'be different from base model scaling factor '
                  '- see eg. Long LoRA) to allow for multiple '
                  'LoRA adapters trained with those scaling '
                  'factors to be used at the same time. If not '
                  'specified, only adapters trained with the '
                  'base model scaling factor are allowed.'))
731
732
733
734
735
        parser.add_argument(
            '--max-cpu-loras',
            type=int,
            default=EngineArgs.max_cpu_loras,
            help=('Maximum number of LoRAs to store in CPU memory. '
736
                  'Must be >= than max_loras.'))
737
738
739
740
741
742
743
744
        parser.add_argument(
            '--fully-sharded-loras',
            action='store_true',
            help=('By default, only half of the LoRA computation is '
                  'sharded with tensor parallelism. '
                  'Enabling this will use the fully sharded layers. '
                  'At high sequence length, max rank or '
                  'tensor parallel size, this is likely faster.'))
745
746
747
748
749
750
751
752
753
754
755
        parser.add_argument('--enable-prompt-adapter',
                            action='store_true',
                            help='If True, enable handling of PromptAdapters.')
        parser.add_argument('--max-prompt-adapters',
                            type=int,
                            default=EngineArgs.max_prompt_adapters,
                            help='Max number of PromptAdapters in a batch.')
        parser.add_argument('--max-prompt-adapter-token',
                            type=int,
                            default=EngineArgs.max_prompt_adapter_token,
                            help='Max number of PromptAdapters tokens')
756
757
758
        parser.add_argument("--device",
                            type=str,
                            default=EngineArgs.device,
759
                            choices=DEVICE_OPTIONS,
760
                            help='Device type for vLLM execution.')
761
762
763
764
765
        parser.add_argument('--num-scheduler-steps',
                            type=int,
                            default=1,
                            help=('Maximum number of forward steps per '
                                  'scheduler call.'))
766
767
768
769
770
771
772
773
        parser.add_argument(
            '--use-tqdm-on-load',
            dest='use_tqdm_on_load',
            action=argparse.BooleanOptionalAction,
            default=EngineArgs.use_tqdm_on_load,
            help='Whether to enable/disable progress bar '
            'when loading model weights.',
        )
774

775
776
        parser.add_argument(
            '--multi-step-stream-outputs',
777
778
779
780
781
782
            action=StoreBoolean,
            default=EngineArgs.multi_step_stream_outputs,
            nargs="?",
            const="True",
            help='If False, then multi-step will stream outputs at the end '
            'of all steps')
783
784
785
786
        parser.add_argument(
            '--scheduler-delay-factor',
            type=float,
            default=EngineArgs.scheduler_delay_factor,
787
            help='Apply a delay (of delay factor multiplied by previous '
788
            'prompt latency) before scheduling next prompt.')
789
790
        parser.add_argument(
            '--enable-chunked-prefill',
791
792
793
794
            action=StoreBoolean,
            default=EngineArgs.enable_chunked_prefill,
            nargs="?",
            const="True",
795
            help='If set, the prefill requests can be chunked based on the '
796
            'max_num_batched_tokens.')
797
        parser.add_argument('--speculative-config',
798
                            type=json.loads,
799
800
801
                            default=None,
                            help='The configurations for speculative decoding.'
                            ' Should be a JSON string.')
802

803
        parser.add_argument('--model-loader-extra-config',
804
                            type=nullable_str,
805
806
807
808
809
810
                            default=EngineArgs.model_loader_extra_config,
                            help='Extra config for model loader. '
                            'This will be passed to the model loader '
                            'corresponding to the chosen load_format. '
                            'This should be a JSON string that will be '
                            'parsed into a dictionary.')
811
812
813
814
815
816
        parser.add_argument(
            '--ignore-patterns',
            action="append",
            type=str,
            default=[],
            help="The pattern(s) to ignore when loading the model."
817
            "Default to `original/**/*` to avoid repeated loading of llama's "
818
            "checkpoints.")
819
        parser.add_argument(
820
            '--preemption-mode',
821
822
            type=str,
            default=None,
823
824
825
            help='If \'recompute\', the engine performs preemption by '
            'recomputing; If \'swap\', the engine performs preemption by '
            'block swapping.')
826

827
828
829
830
831
832
833
834
835
836
        parser.add_argument(
            "--served-model-name",
            nargs="+",
            type=str,
            default=None,
            help="The model name(s) used in the API. If multiple "
            "names are provided, the server will respond to any "
            "of the provided names. The model name in the model "
            "field of a response will be the first name in this "
            "list. If not specified, the model name will be the "
837
            "same as the ``--model`` argument. Noted that this name(s) "
838
            "will also be used in `model_name` tag content of "
839
            "prometheus metrics, if multiple names provided, metrics "
840
            "tag will take the first one.")
841
842
843
844
        parser.add_argument('--qlora-adapter-name-or-path',
                            type=str,
                            default=None,
                            help='Name or path of the QLoRA adapter.')
845

846
847
848
849
850
851
852
853
854
855
856
857
        parser.add_argument('--show-hidden-metrics-for-version',
                            type=str,
                            default=None,
                            help='Enable deprecated Prometheus metrics that '
                            'have been hidden since the specified version. '
                            'For example, if a previously deprecated metric '
                            'has been hidden since the v0.7.0 release, you '
                            'use --show-hidden-metrics-for-version=0.7 as a '
                            'temporary escape hatch while you migrate to new '
                            'metrics. The metric is likely to be removed '
                            'completely in an upcoming release.')

858
859
860
861
862
        parser.add_argument(
            '--otlp-traces-endpoint',
            type=str,
            default=None,
            help='Target URL to which OpenTelemetry traces will be sent.')
863
864
865
866
867
868
        parser.add_argument(
            '--collect-detailed-traces',
            type=str,
            default=None,
            help="Valid choices are " +
            ",".join(ALLOWED_DETAILED_TRACE_MODULES) +
869
            ". It makes sense to set this only if ``--otlp-traces-endpoint`` is"
870
871
872
            " set. If set, it will collect detailed traces for the specified "
            "modules. This involves use of possibly costly and or blocking "
            "operations and hence might have a performance impact.")
873

874
875
876
877
878
879
        parser.add_argument(
            '--disable-async-output-proc',
            action='store_true',
            default=EngineArgs.disable_async_output_proc,
            help="Disable async output processing. This may result in "
            "lower performance.")
880

881
882
883
884
885
886
887
888
889
890
        parser.add_argument(
            '--scheduling-policy',
            choices=['fcfs', 'priority'],
            default="fcfs",
            help='The scheduling policy to use. "fcfs" (first come first served'
            ', i.e. requests are handled in order of arrival; default) '
            'or "priority" (requests are handled based on given '
            'priority (lower value means earlier handling) and time of '
            'arrival deciding any ties).')

891
892
893
894
895
896
897
        parser.add_argument(
            '--scheduler-cls',
            default=EngineArgs.scheduler_cls,
            help='The scheduler class to use. "vllm.core.scheduler.Scheduler" '
            'is the default scheduler. Can be a class directly or the path to '
            'a class of form "mod.custom_class".')

898
        parser.add_argument(
899
900
            '--override-neuron-config',
            type=json.loads,
901
            default=None,
902
            help="Override or set neuron device configuration. "
903
            "e.g. ``{\"cast_logits_dtype\": \"bloat16\"}``.")
904
        parser.add_argument(
905
906
            '--override-pooler-config',
            type=PoolerConfig.from_json,
907
            default=None,
908
            help="Override or set the pooling method for pooling models. "
909
            "e.g. ``{\"pooling_type\": \"mean\", \"normalize\": false}``.")
910

911
912
913
914
915
916
917
918
919
920
921
922
        parser.add_argument('--compilation-config',
                            '-O',
                            type=CompilationConfig.from_cli,
                            default=None,
                            help='torch.compile configuration for the model.'
                            'When it is a number (0, 1, 2, 3), it will be '
                            'interpreted as the optimization level.\n'
                            'NOTE: level 0 is the default level without '
                            'any optimization. level 1 and 2 are for internal '
                            'testing only. level 3 is the recommended level '
                            'for production.\n'
                            'To specify the full compilation config, '
923
924
925
926
                            'use a JSON string.\n'
                            'Following the convention of traditional '
                            'compilers, using -O without space is also '
                            'supported. -O3 is equivalent to -O 3.')
927

928
929
930
931
932
933
        parser.add_argument('--kv-transfer-config',
                            type=KVTransferConfig.from_cli,
                            default=None,
                            help='The configurations for distributed KV cache '
                            'transfer. Should be a JSON string.')

934
935
936
937
938
        parser.add_argument(
            '--worker-cls',
            type=str,
            default="auto",
            help='The worker class to use for distributed execution.')
939
940
941
942
943
944
945
        parser.add_argument(
            '--worker-extension-cls',
            type=str,
            default="",
            help='The worker extension class on top of the worker cls, '
            'it is useful if you just want to add new functions to the worker '
            'class without changing the existing functions.')
946
947
948
        parser.add_argument(
            "--generation-config",
            type=nullable_str,
949
            default="auto",
950
            help="The folder path to the generation config. "
951
952
953
954
955
            "Defaults to 'auto', the generation config will be loaded from "
            "model path. If set to 'vllm', no generation config is loaded, "
            "vLLM defaults will be used. If set to a folder path, the "
            "generation config will be loaded from the specified folder path. "
            "If `max_new_tokens` is specified in generation config, then "
956
957
958
959
960
961
962
963
964
965
966
967
            "it sets a server-wide limit on the number of output tokens "
            "for all requests.")

        parser.add_argument(
            "--override-generation-config",
            type=json.loads,
            default=None,
            help="Overrides or sets generation config in JSON format. "
            "e.g. ``{\"temperature\": 0.5}``. If used with "
            "--generation-config=auto, the override parameters will be merged "
            "with the default config from the model. If generation-config is "
            "None, only the override parameters are used.")
968

969
970
971
972
973
974
        parser.add_argument("--enable-sleep-mode",
                            action="store_true",
                            default=False,
                            help="Enable sleep mode for the engine. "
                            "(only cuda platform is supported)")

975
976
977
978
979
980
981
982
983
        parser.add_argument(
            '--calculate-kv-scales',
            action='store_true',
            help='This enables dynamic calculation of '
            'k_scale and v_scale when kv-cache-dtype is fp8. '
            'If calculate-kv-scales is false, the scales will '
            'be loaded from the model checkpoint if available. '
            'Otherwise, the scales will default to 1.0.')

984
985
986
987
988
989
990
991
        parser.add_argument(
            "--additional-config",
            type=json.loads,
            default=None,
            help="Additional config for specified platform in JSON format. "
            "Different platforms may support different configs. Make sure the "
            "configs are valid for the platform you are using. The input format"
            " is like '{\"config_key\":\"config_value\"}'")
992
993
994
995
996
997
998
999
1000
1001
1002
1003

        parser.add_argument(
            "--enable-reasoning",
            action="store_true",
            default=False,
            help="Whether to enable reasoning_content for the model. "
            "If enabled, the model will be able to generate reasoning content."
        )

        parser.add_argument(
            "--reasoning-parser",
            type=str,
1004
            choices=list(ReasoningParserManager.reasoning_parsers),
1005
1006
1007
1008
1009
1010
            default=None,
            help=
            "Select the reasoning parser depending on the model that you're "
            "using. This is used to parse the reasoning content into OpenAI "
            "API format. Required for ``--enable-reasoning``.")

1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
        parser.add_argument(
            "--disable-cascade-attn",
            action="store_true",
            default=False,
            help="Disable cascade attention for V1. While cascade attention "
            "does not change the mathematical correctness, disabling it "
            "could be useful for preventing potential numerical issues. "
            "Note that even if this is set to False, cascade attention will be "
            "only used when the heuristic tells that it's beneficial.")

1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
        parser.add_argument(
            "--disable-chunked-mm-input",
            action=StoreBoolean,
            default=EngineArgs.disable_chunked_mm_input,
            nargs="?",
            const="False",
            help="Disable multimodal input chunking attention for V1. "
            "If set to true and chunked prefill is enabled, we do not want to"
            " partially schedule a multimodal item. This ensures that if a "
            "request has a mixed prompt (like text tokens TTTT followed by "
            "image tokens IIIIIIIIII) where only some image tokens can be "
            "scheduled (like TTTTIIIII, leaving IIIII), it will be scheduled "
            "as TTTT in one step and IIIIIIIIII in the next.")

1035
        return parser
1036
1037

    @classmethod
1038
    def from_cli_args(cls, args: argparse.Namespace):
1039
1040
1041
        # Get the list of attributes of this dataclass.
        attrs = [attr.name for attr in dataclasses.fields(cls)]
        # Set the attributes from the parsed arguments.
Zhuohan Li's avatar
Zhuohan Li committed
1042
1043
        engine_args = cls(**{attr: getattr(args, attr) for attr in attrs})
        return engine_args
1044

1045
    def create_model_config(self) -> ModelConfig:
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
        # gguf file needs a specific model loader and doesn't use hf_repo
        if check_gguf_file(self.model):
            self.quantization = self.load_format = "gguf"

        # NOTE: This is to allow model loading from S3 in CI
        if (not isinstance(self, AsyncEngineArgs) and envs.VLLM_CI_USE_S3
                and self.model in MODELS_ON_S3
                and self.load_format == LoadFormat.AUTO):  # noqa: E501
            self.model = f"{MODEL_WEIGHTS_S3_BUCKET}/{self.model}"
            self.load_format = LoadFormat.RUNAI_STREAMER

1057
        return ModelConfig(
1058
            model=self.model,
1059
            hf_config_path=self.hf_config_path,
1060
            task=self.task,
1061
1062
            # We know this is not None because we set it in __post_init__
            tokenizer=cast(str, self.tokenizer),
1063
1064
            tokenizer_mode=self.tokenizer_mode,
            trust_remote_code=self.trust_remote_code,
1065
            allowed_local_media_path=self.allowed_local_media_path,
1066
1067
1068
1069
1070
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
            rope_scaling=self.rope_scaling,
1071
            rope_theta=self.rope_theta,
1072
            hf_token=self.hf_token,
1073
            hf_overrides=self.hf_overrides,
1074
1075
1076
1077
1078
1079
1080
            tokenizer_revision=self.tokenizer_revision,
            max_model_len=self.max_model_len,
            quantization=self.quantization,
            enforce_eager=self.enforce_eager,
            max_seq_len_to_capture=self.max_seq_len_to_capture,
            max_logprobs=self.max_logprobs,
            disable_sliding_window=self.disable_sliding_window,
1081
            disable_cascade_attn=self.disable_cascade_attn,
1082
            skip_tokenizer_init=self.skip_tokenizer_init,
1083
            served_model_name=self.served_model_name,
1084
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1085
            use_async_output_proc=not self.disable_async_output_proc,
1086
            config_format=self.config_format,
1087
            mm_processor_kwargs=self.mm_processor_kwargs,
1088
            disable_mm_preprocessor_cache=self.disable_mm_preprocessor_cache,
1089
1090
            override_neuron_config=self.override_neuron_config,
            override_pooler_config=self.override_pooler_config,
1091
            logits_processor_pattern=self.logits_processor_pattern,
1092
            generation_config=self.generation_config,
1093
            override_generation_config=self.override_generation_config,
1094
            enable_sleep_mode=self.enable_sleep_mode,
1095
            model_impl=self.model_impl,
1096
        )
1097

1098
1099
    def create_load_config(self) -> LoadConfig:

1100
        if(self.qlora_adapter_name_or_path is not None) and \
1101
1102
            self.quantization != "bitsandbytes":
            raise ValueError(
1103
                "QLoRA adapter only support "
1104
1105
                f"'bitsandbytes' quantization, but got {self.quantization}")

1106
1107
        if self.quantization == "bitsandbytes":
            self.load_format = "bitsandbytes"
1108
1109
1110
1111
1112
        return LoadConfig(
            load_format=self.load_format,
            download_dir=self.download_dir,
            model_loader_extra_config=self.model_loader_extra_config,
            ignore_patterns=self.ignore_patterns,
1113
            use_tqdm_on_load=self.use_tqdm_on_load,
1114
        )
1115

1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
    def create_speculative_config(
        self,
        target_model_config: ModelConfig,
        target_parallel_config: ParallelConfig,
        enable_chunked_prefill: bool,
        disable_log_stats: bool,
    ) -> Optional["SpeculativeConfig"]:
        """Initializes and returns a SpeculativeConfig object based on
        `speculative_config`.

        This function utilizes `speculative_config` to create a
        SpeculativeConfig object. The `speculative_config` can either be
        provided as a JSON string input via CLI arguments or directly as a
1129
        dictionary from the engine.
1130
1131
        """
        if self.speculative_config is None:
1132
1133
            return None

1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
        # Note(Shangming): These parameters are not obtained from the cli arg
        # '--speculative-config' and must be passed in when creating the engine
        # config.
        self.speculative_config.update({
            "target_model_config": target_model_config,
            "target_parallel_config": target_parallel_config,
            "enable_chunked_prefill": enable_chunked_prefill,
            "disable_log_stats": disable_log_stats,
        })
        speculative_config = SpeculativeConfig.from_dict(
            self.speculative_config)

        return speculative_config

1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
    def create_engine_config(
        self,
        usage_context: Optional[UsageContext] = None,
    ) -> VllmConfig:
        """
        Create the VllmConfig.

        NOTE: for autoselection of V0 vs V1 engine, we need to
        create the ModelConfig first, since ModelConfig's attrs
        (e.g. the model arch) are needed to make the decision.
Simon Mo's avatar
Simon Mo committed
1158

1159
1160
1161
1162
1163
1164
        This function set VLLM_USE_V1=X if VLLM_USE_V1 is
        unspecified by the user.

        If VLLM_USE_V1 is specified by the user but the VllmConfig
        is incompatible, we raise an error.
        """
1165
1166
        from vllm.platforms import current_platform
        current_platform.pre_register_and_update()
1167

1168
        device_config = DeviceConfig(device=self.device)
1169
1170
        model_config = self.create_model_config()

1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
        # * If VLLM_USE_V1 is unset, we enable V1 for "supported features"
        #   and fall back to V0 for experimental or unsupported features.
        # * If VLLM_USE_V1=1, we enable V1 for supported + experimental
        #   features and raise error for unsupported features.
        # * If VLLM_USE_V1=0, we disable V1.
        use_v1 = False
        try_v1 = envs.VLLM_USE_V1 or not envs.is_set("VLLM_USE_V1")
        if try_v1 and self._is_v1_supported_oracle(model_config):
            use_v1 = True

        # If user explicitly set VLLM_USE_V1, sanity check we respect it.
        if envs.is_set("VLLM_USE_V1"):
            assert use_v1 == envs.VLLM_USE_V1
        # Otherwise, set the VLLM_USE_V1 variable globally.
        else:
            envs.set_vllm_use_v1(use_v1)

        # Set default arguments for V0 or V1 Engine.
        if use_v1:
            self._set_default_args_v1(usage_context)
        else:
            self._set_default_args_v0(model_config)
1193

1194
1195
        assert self.enable_chunked_prefill is not None

1196
        cache_config = CacheConfig(
1197
            block_size=self.block_size,
1198
1199
1200
            gpu_memory_utilization=self.gpu_memory_utilization,
            swap_space=self.swap_space,
            cache_dtype=self.kv_cache_dtype,
1201
            is_attention_free=model_config.is_attention_free,
1202
1203
            num_gpu_blocks_override=self.num_gpu_blocks_override,
            sliding_window=model_config.get_sliding_window(),
1204
            enable_prefix_caching=self.enable_prefix_caching,
1205
            prefix_caching_hash_algo=self.prefix_caching_hash_algo,
1206
            cpu_offload_gb=self.cpu_offload_gb,
1207
            calculate_kv_scales=self.calculate_kv_scales,
1208
        )
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220

        # Get the current placement group if Ray is initialized and
        # we are in a Ray actor. If so, then the placement group will be
        # passed to spawned processes.
        placement_group = None
        if is_in_ray_actor():
            import ray

            # This call initializes Ray automatically if it is not initialized,
            # but we should not do this here.
            placement_group = ray.util.get_current_placement_group()

1221
        parallel_config = ParallelConfig(
1222
1223
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
1224
            data_parallel_size=self.data_parallel_size,
1225
            enable_expert_parallel=self.enable_expert_parallel,
1226
1227
1228
            max_parallel_loading_workers=self.max_parallel_loading_workers,
            disable_custom_all_reduce=self.disable_custom_all_reduce,
            tokenizer_pool_config=TokenizerPoolConfig.create_config(
1229
1230
1231
                self.tokenizer_pool_size,
                self.tokenizer_pool_type,
                self.tokenizer_pool_extra_config,
1232
            ),
1233
            ray_workers_use_nsight=self.ray_workers_use_nsight,
1234
            placement_group=placement_group,
1235
1236
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
1237
            worker_extension_cls=self.worker_extension_cls,
1238
        )
1239

1240
        speculative_config = self.create_speculative_config(
1241
1242
            target_model_config=model_config,
            target_parallel_config=parallel_config,
1243
            enable_chunked_prefill=self.enable_chunked_prefill,
1244
            disable_log_stats=self.disable_log_stats,
1245
1246
        )

1247
        # Reminder: Please update docs/source/features/compatibility_matrix.md
1248
        # If the feature combo become valid
1249
1250
1251
1252
        if self.num_scheduler_steps > 1:
            if speculative_config is not None:
                raise ValueError("Speculative decoding is not supported with "
                                 "multi-step (--num-scheduler-steps > 1)")
1253
1254
1255
            if self.enable_chunked_prefill and self.pipeline_parallel_size > 1:
                raise ValueError("Multi-Step Chunked-Prefill is not supported "
                                 "for pipeline-parallel-size > 1")
1256
1257
1258
1259
1260
1261
            from vllm.platforms import current_platform
            if current_platform.is_cpu():
                logger.warning("Multi-Step (--num-scheduler-steps > 1) is "
                               "currently not supported for CPUs and has been "
                               "disabled.")
                self.num_scheduler_steps = 1
1262
1263
1264
1265
1266
1267
1268
1269
1270

        # make sure num_lookahead_slots is set the higher value depending on
        # if we are using speculative decoding or multi-step
        num_lookahead_slots = max(self.num_lookahead_slots,
                                  self.num_scheduler_steps - 1)
        num_lookahead_slots = num_lookahead_slots \
            if speculative_config is None \
            else speculative_config.num_lookahead_slots

1271
        scheduler_config = SchedulerConfig(
1272
            runner_type=model_config.runner_type,
1273
1274
1275
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1276
            num_lookahead_slots=num_lookahead_slots,
1277
1278
            delay_factor=self.scheduler_delay_factor,
            enable_chunked_prefill=self.enable_chunked_prefill,
1279
            disable_chunked_mm_input=self.disable_chunked_mm_input,
1280
            is_multimodal_model=model_config.is_multimodal_model,
1281
            preemption_mode=self.preemption_mode,
1282
            num_scheduler_steps=self.num_scheduler_steps,
1283
            multi_step_stream_outputs=self.multi_step_stream_outputs,
1284
1285
            send_delta_data=(envs.VLLM_USE_RAY_SPMD_WORKER
                             and parallel_config.use_ray),
1286
            policy=self.scheduling_policy,
1287
            scheduler_cls=self.scheduler_cls,
1288
1289
1290
1291
            max_num_partial_prefills=self.max_num_partial_prefills,
            max_long_partial_prefills=self.max_long_partial_prefills,
            long_prefill_token_threshold=self.long_prefill_token_threshold,
        )
1292

1293
        lora_config = LoRAConfig(
1294
            bias_enabled=self.enable_lora_bias,
1295
1296
            max_lora_rank=self.max_lora_rank,
            max_loras=self.max_loras,
1297
            fully_sharded_loras=self.fully_sharded_loras,
1298
            lora_extra_vocab_size=self.lora_extra_vocab_size,
1299
            long_lora_scaling_factors=self.long_lora_scaling_factors,
1300
1301
1302
            lora_dtype=self.lora_dtype,
            max_cpu_loras=self.max_cpu_loras if self.max_cpu_loras
            and self.max_cpu_loras > 0 else None) if self.enable_lora else None
1303

1304
1305
1306
1307
1308
1309
1310
        if self.qlora_adapter_name_or_path is not None and \
            self.qlora_adapter_name_or_path != "":
            if self.model_loader_extra_config is None:
                self.model_loader_extra_config = {}
            self.model_loader_extra_config[
                "qlora_adapter_name_or_path"] = self.qlora_adapter_name_or_path

1311
1312
1313
1314
        # bitsandbytes pre-quantized model need a specific model loader
        if model_config.quantization == "bitsandbytes":
            self.quantization = self.load_format = "bitsandbytes"

1315
        load_config = self.create_load_config()
1316

1317
1318
1319
1320
1321
        prompt_adapter_config = PromptAdapterConfig(
            max_prompt_adapters=self.max_prompt_adapters,
            max_prompt_adapter_token=self.max_prompt_adapter_token) \
                                        if self.enable_prompt_adapter else None

1322
        decoding_config = DecodingConfig(
1323
1324
1325
1326
            guided_decoding_backend=self.guided_decoding_backend,
            reasoning_backend=self.reasoning_parser
            if self.enable_reasoning else None,
        )
1327

1328
1329
1330
1331
1332
        show_hidden_metrics = False
        if self.show_hidden_metrics_for_version is not None:
            show_hidden_metrics = version._prev_minor_version_was(
                self.show_hidden_metrics_for_version)

1333
1334
1335
1336
1337
1338
1339
1340
        detailed_trace_modules = []
        if self.collect_detailed_traces is not None:
            detailed_trace_modules = self.collect_detailed_traces.split(",")
        for m in detailed_trace_modules:
            if m not in ALLOWED_DETAILED_TRACE_MODULES:
                raise ValueError(
                    f"Invalid module {m} in collect_detailed_traces. "
                    f"Valid modules are {ALLOWED_DETAILED_TRACE_MODULES}")
1341
        observability_config = ObservabilityConfig(
1342
            show_hidden_metrics=show_hidden_metrics,
1343
1344
1345
1346
1347
1348
            otlp_traces_endpoint=self.otlp_traces_endpoint,
            collect_model_forward_time="model" in detailed_trace_modules
            or "all" in detailed_trace_modules,
            collect_model_execute_time="worker" in detailed_trace_modules
            or "all" in detailed_trace_modules,
        )
1349

1350
        config = VllmConfig(
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
            model_config=model_config,
            cache_config=cache_config,
            parallel_config=parallel_config,
            scheduler_config=scheduler_config,
            device_config=device_config,
            lora_config=lora_config,
            speculative_config=speculative_config,
            load_config=load_config,
            decoding_config=decoding_config,
            observability_config=observability_config,
1361
            prompt_adapter_config=prompt_adapter_config,
1362
            compilation_config=self.compilation_config,
1363
            kv_transfer_config=self.kv_transfer_config,
1364
            additional_config=self.additional_config,
1365
        )
1366

1367
1368
        return config

1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
    def _is_v1_supported_oracle(self, model_config: ModelConfig) -> bool:
        """Oracle for whether to use V0 or V1 Engine by default."""

        #############################################################
        # Unsupported Feature Flags on V1.

        if (self.load_format == LoadFormat.TENSORIZER.value
                or self.load_format == LoadFormat.SHARDED_STATE.value):
            _raise_or_fallback(
                feature_name=f"--load_format {self.load_format}",
                recommend_to_remove=False)
            return False

        if (self.logits_processor_pattern
                != EngineArgs.logits_processor_pattern):
            _raise_or_fallback(feature_name="--logits-processor-pattern",
                               recommend_to_remove=False)
            return False

        if self.preemption_mode != EngineArgs.preemption_mode:
            _raise_or_fallback(feature_name="--preemption-mode",
                               recommend_to_remove=True)
            return False

        if (self.disable_async_output_proc
                != EngineArgs.disable_async_output_proc):
            _raise_or_fallback(feature_name="--disable-async-output-proc",
                               recommend_to_remove=True)
            return False

        if self.scheduling_policy != EngineArgs.scheduling_policy:
            _raise_or_fallback(feature_name="--scheduling-policy",
                               recommend_to_remove=False)
            return False

        if self.num_scheduler_steps != EngineArgs.num_scheduler_steps:
            _raise_or_fallback(feature_name="--num-scheduler-steps",
                               recommend_to_remove=True)
            return False

        if self.scheduler_delay_factor != EngineArgs.scheduler_delay_factor:
            _raise_or_fallback(feature_name="--scheduler-delay-factor",
                               recommend_to_remove=True)
            return False

        if self.additional_config != EngineArgs.additional_config:
            _raise_or_fallback(feature_name="--additional-config",
                               recommend_to_remove=False)
            return False

1419
        # Xgrammar and Guidance are supported.
1420
        SUPPORTED_GUIDED_DECODING = [
1421
1422
            "xgrammar", "xgrammar:disable-any-whitespace", "guidance",
            "guidance:disable-any-whitespace", "auto"
1423
        ]
1424
1425
1426
1427
1428
1429
        if self.guided_decoding_backend not in SUPPORTED_GUIDED_DECODING:
            _raise_or_fallback(feature_name="--guided-decoding-backend",
                               recommend_to_remove=False)
            return False

        # Need at least Ampere for now (FA support required).
1430
1431
1432
        # Skip this check if we are running on a non-GPU platform,
        # or if the device capability is not available
        # (e.g. in a Ray actor without GPUs).
1433
1434
        from vllm.platforms import current_platform
        if (current_platform.is_cuda()
1435
                and current_platform.get_device_capability()
1436
1437
1438
1439
1440
1441
1442
                and current_platform.get_device_capability().major < 8):
            _raise_or_fallback(feature_name="Compute Capability < 8.0",
                               recommend_to_remove=False)
            return False

        # No Fp8 KV cache so far.
        if self.kv_cache_dtype != "auto":
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
            fp8_attention = self.kv_cache_dtype.startswith("fp8")
            will_use_fa = (
                current_platform.is_cuda()
                and not envs.is_set("VLLM_ATTENTION_BACKEND")
            ) or envs.VLLM_ATTENTION_BACKEND == "FLASH_ATTN_VLLM_V1"
            supported = False
            if fp8_attention and will_use_fa:
                from vllm.vllm_flash_attn.fa_utils import (
                    flash_attn_supports_fp8)
                supported = flash_attn_supports_fp8()
            if not supported:
                _raise_or_fallback(feature_name="--kv-cache-dtype",
                                   recommend_to_remove=False)
                return False
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471

        # No Prompt Adapter so far.
        if self.enable_prompt_adapter:
            _raise_or_fallback(feature_name="--enable-prompt-adapter",
                               recommend_to_remove=False)
            return False

        # Only Fp16 and Bf16 dtypes since we only support FA.
        V1_SUPPORTED_DTYPES = [torch.bfloat16, torch.float16]
        if model_config.dtype not in V1_SUPPORTED_DTYPES:
            _raise_or_fallback(feature_name=f"--dtype {model_config.dtype}",
                               recommend_to_remove=False)
            return False

        # Some quantization is not compatible with torch.compile.
1472
        V1_UNSUPPORTED_QUANT = ["gguf"]
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
        if model_config.quantization in V1_UNSUPPORTED_QUANT:
            _raise_or_fallback(
                feature_name=f"--quantization {model_config.quantization}",
                recommend_to_remove=False)
            return False

        # No Embedding Models so far.
        if model_config.task not in ["generate"]:
            _raise_or_fallback(feature_name=f"--task {model_config.task}",
                               recommend_to_remove=False)
            return False

        # No Mamba or Encoder-Decoder so far.
        if not model_config.is_v1_compatible:
            _raise_or_fallback(feature_name=model_config.architectures,
                               recommend_to_remove=False)
            return False

        # No Concurrent Partial Prefills so far.
        if (self.max_num_partial_prefills
                != EngineArgs.max_num_partial_prefills
                or self.max_long_partial_prefills
1495
                != EngineArgs.max_long_partial_prefills):
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
            _raise_or_fallback(feature_name="Concurrent Partial Prefill",
                               recommend_to_remove=False)
            return False

        # No OTLP observability so far.
        if (self.otlp_traces_endpoint or self.collect_detailed_traces):
            _raise_or_fallback(feature_name="--otlp-traces-endpoint",
                               recommend_to_remove=False)
            return False

        # Only Ngram speculative decoding so far.
1507
        is_ngram_enabled = False
1508
        is_eagle_enabled = False
1509
        if self.speculative_config is not None:
1510
            # This is supported but experimental (handled below).
1511
1512
1513
1514
1515
1516
            speculative_method = self.speculative_config.get("method")
            if speculative_method:
                if speculative_method in ("ngram", "[ngram]"):
                    is_ngram_enabled = True
                elif speculative_method == "eagle":
                    is_eagle_enabled = True
1517
            else:
1518
1519
1520
1521
1522
                speculative_model = self.speculative_config.get("model")
                if speculative_model in ("ngram", "[ngram]"):
                    is_ngram_enabled = True
            if not (is_ngram_enabled or is_eagle_enabled):
                # Other speculative decoding methods are not supported yet.
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
                _raise_or_fallback(feature_name="Speculative Decoding",
                                   recommend_to_remove=False)
                return False

        # No Disaggregated Prefill so far.
        if self.kv_transfer_config != EngineArgs.kv_transfer_config:
            _raise_or_fallback(feature_name="--kv-transfer-config",
                               recommend_to_remove=False)
            return False

        # No FlashInfer or XFormers so far.
        V1_BACKENDS = [
            "FLASH_ATTN_VLLM_V1", "FLASH_ATTN", "PALLAS", "PALLAS_VLLM_V1",
1536
            "TRITON_ATTN_VLLM_V1", "TRITON_MLA", "FLASHMLA"
1537
1538
1539
1540
1541
1542
1543
        ]
        if (envs.is_set("VLLM_ATTENTION_BACKEND")
                and envs.VLLM_ATTENTION_BACKEND not in V1_BACKENDS):
            name = f"VLLM_ATTENTION_BACKEND={envs.VLLM_ATTENTION_BACKEND}"
            _raise_or_fallback(feature_name=name, recommend_to_remove=True)
            return False

1544
1545
        # Platforms must decide if they can support v1 for this model
        if not current_platform.supports_v1(model_config=model_config):
1546
1547
1548
1549
            _raise_or_fallback(
                feature_name=f"device type={current_platform.device_type}",
                recommend_to_remove=False)
            return False
1550
1551
1552
        #############################################################
        # Experimental Features - allow users to opt in.

1553
1554
1555
1556
1557
        # Signal Handlers requires running in main thread.
        if (threading.current_thread() != threading.main_thread()
                and _warn_or_fallback("Engine in background thread")):
            return False

1558
1559
1560
        # PP is supported on V1 with Ray distributed executor,
        # but off for MP distributed executor for now.
        if (self.pipeline_parallel_size > 1
1561
1562
1563
                and self.distributed_executor_backend != "ray"):
            name = "Pipeline Parallelism without Ray distributed executor"
            _raise_or_fallback(feature_name=name, recommend_to_remove=False)
1564
1565
1566
            return False

        # ngram is supported on V1, but off by default for now.
1567
        if is_ngram_enabled and _warn_or_fallback("ngram"):
1568
1569
            return False

1570
1571
1572
1573
        # Eagle is under development, so we don't support it yet.
        if is_eagle_enabled and _warn_or_fallback("Eagle"):
            return False

1574
1575
1576
        # Non-CUDA is supported on V1, but off by default for now.
        not_cuda = not current_platform.is_cuda()
        if not_cuda and _warn_or_fallback(  # noqa: SIM103
1577
                current_platform.device_name):
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
            return False
        #############################################################

        return True

    def _set_default_args_v0(self, model_config: ModelConfig) -> None:
        """Set Default Arguments for V0 Engine."""

        max_model_len = model_config.max_model_len
        use_long_context = max_model_len > 32768
        if self.enable_chunked_prefill is None:
            # Chunked prefill not supported for Multimodal or MLA in V0.
            if model_config.is_multimodal_model or model_config.use_mla:
                self.enable_chunked_prefill = False

            # Enable chunked prefill by default for long context (> 32K)
            # models to avoid OOM errors in initial memory profiling phase.
            elif use_long_context:
                from vllm.platforms import current_platform
                is_gpu = current_platform.is_cuda()
                use_sliding_window = (model_config.get_sliding_window()
                                      is not None)
1600
                use_spec_decode = self.speculative_config is not None
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627

                if (is_gpu and not use_sliding_window and not use_spec_decode
                        and not self.enable_lora
                        and not self.enable_prompt_adapter
                        and model_config.runner_type != "pooling"):
                    self.enable_chunked_prefill = True
                    logger.warning(
                        "Chunked prefill is enabled by default for models "
                        "with max_model_len > 32K. Chunked prefill might "
                        "not work with some features or models. If you "
                        "encounter any issues, please disable by launching "
                        "with --enable-chunked-prefill=False.")

            if self.enable_chunked_prefill is None:
                self.enable_chunked_prefill = False

        if not self.enable_chunked_prefill and use_long_context:
            logger.warning(
                "The model has a long context length (%s). This may cause"
                "OOM during the initial memory profiling phase, or result "
                "in low performance due to small KV cache size. Consider "
                "setting --max-model-len to a smaller value.", max_model_len)
        elif (self.enable_chunked_prefill
              and model_config.runner_type == "pooling"):
            msg = "Chunked prefill is not supported for pooling models"
            raise ValueError(msg)

1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
        # if using prefix caching, we must set a hash algo
        if self.enable_prefix_caching:
            # Disable prefix caching for multimodal models for VLLM_V0.
            if model_config.is_multimodal_model:
                logger.warning(
                    "--enable-prefix-caching is not supported for multimodal "
                    "models in V0 and has been disabled.")
                self.enable_prefix_caching = False

            # VLLM_V0 only supports builtin hash algo for prefix caching.
            if self.prefix_caching_hash_algo is None:
                self.prefix_caching_hash_algo = "builtin"
            elif self.prefix_caching_hash_algo == "sha256":
                raise ValueError(
                    "sha256 is not supported for prefix caching in V0 engine. "
                    "Please use 'builtin'.")
1644
1645
1646
1647
1648
1649
1650

        # Set max_num_seqs to 256 for VLLM_V0.
        if self.max_num_seqs is None:
            self.max_num_seqs = 256

    def _set_default_args_v1(self, usage_context: UsageContext) -> None:
        """Set Default Arguments for V1 Engine."""
1651

1652
1653
        # V1 always uses chunked prefills.
        self.enable_chunked_prefill = True
1654
1655
1656
1657
1658

        # V1 enables prefix caching by default.
        if self.enable_prefix_caching is None:
            self.enable_prefix_caching = True

1659
1660
1661
1662
        # if using prefix caching, we must set a hash algo
        if self.enable_prefix_caching and self.prefix_caching_hash_algo is None:
            self.prefix_caching_hash_algo = "builtin"

1663
1664
1665
        # V1 should use the new scheduler by default.
        # Swap it only if this arg is set to the original V0 default
        if self.scheduler_cls == EngineArgs.scheduler_cls:
1666
            self.scheduler_cls = "vllm.v1.core.sched.scheduler.Scheduler"
1667

1668
1669
        # When no user override, set the default values based on the usage
        # context.
1670
        # Use different default values for different hardware.
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683

        # Try to query the device name on the current platform. If it fails,
        # it may be because the platform that imports vLLM is not the same
        # as the platform that vLLM is running on (e.g. the case of scaling
        # vLLM with Ray) and has no GPUs. In this case we use the default
        # values for non-H100/H200 GPUs.
        try:
            from vllm.platforms import current_platform
            device_name = current_platform.get_device_name().lower()
        except Exception:
            # This is only used to set default_max_num_batched_tokens
            device_name = "no-device"

1684
1685
1686
1687
1688
1689
        if "h100" in device_name or "h200" in device_name:
            # For H100 and H200, we use larger default values.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 16384,
                UsageContext.OPENAI_API_SERVER: 8192,
            }
1690
            default_max_num_seqs = 1024
1691
1692
1693
1694
1695
1696
        else:
            # TODO(woosuk): Tune the default values for other hardware.
            default_max_num_batched_tokens = {
                UsageContext.LLM_CLASS: 8192,
                UsageContext.OPENAI_API_SERVER: 2048,
            }
1697
            default_max_num_seqs = 256
1698

1699
        use_context_value = usage_context.value if usage_context else None
1700
1701
1702
1703
        if (self.max_num_batched_tokens is None
                and usage_context in default_max_num_batched_tokens):
            self.max_num_batched_tokens = default_max_num_batched_tokens[
                usage_context]
1704
            logger.debug(
1705
                "Setting max_num_batched_tokens to %d for %s usage context.",
1706
                self.max_num_batched_tokens, use_context_value)
1707

1708
1709
1710
1711
1712
        if self.max_num_seqs is None:
            self.max_num_seqs = default_max_num_seqs

            logger.debug("Setting max_num_seqs to %d for %s usage context.",
                         self.max_num_seqs, use_context_value)
1713

1714

1715
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
1716
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
1717
    """Arguments for asynchronous vLLM engine."""
1718
    disable_log_requests: bool = False
1719
1720

    @staticmethod
1721
1722
    def add_cli_args(parser: FlexibleArgumentParser,
                     async_args_only: bool = False) -> FlexibleArgumentParser:
1723
1724
1725
1726
        # Initialize plugin to update the parser, for example, The plugin may
        # adding a new kind of quantization method to --quantization argument or
        # a new device to --device argument.
        load_general_plugins()
1727
1728
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
1729
1730
        parser.add_argument('--disable-log-requests',
                            action='store_true',
1731
                            help='Disable logging requests.')
1732
1733
        from vllm.platforms import current_platform
        current_platform.pre_register_and_update(parser)
1734
        return parser
1735
1736


1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
def _raise_or_fallback(feature_name: str, recommend_to_remove: bool):
    if envs.is_set("VLLM_USE_V1") and envs.VLLM_USE_V1:
        raise NotImplementedError(
            f"VLLM_USE_V1=1 is not supported with {feature_name}.")
    msg = f"{feature_name} is not supported by the V1 Engine. "
    msg += "Falling back to V0. "
    if recommend_to_remove:
        msg += f"We recommend to remove {feature_name} from your config "
        msg += "in favor of the V1 Engine."
    logger.warning(msg)


def _warn_or_fallback(feature_name: str) -> bool:
    if envs.is_set("VLLM_USE_V1") and envs.VLLM_USE_V1:
        logger.warning(
            "Detected VLLM_USE_V1=1 with %s. Usage should "
            "be considered experimental. Please report any "
            "issues on Github.", feature_name)
        should_exit = False
    else:
        logger.info(
            "%s is experimental on VLLM_USE_V1=1. "
            "Falling back to V0 Engine.", feature_name)
        should_exit = True
    return should_exit


1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
def human_readable_int(value):
    """Parse human-readable integers like '1k', '2M', etc.
    Including decimal values with decimal multipliers.
    
    Examples:
    - '1k' -> 1,000
    - '1K' -> 1,024
    - '25.6k' -> 25,600
    """
    value = value.strip()
    match = re.fullmatch(r'(\d+(?:\.\d+)?)([kKmMgGtT])', value)
    if match:
        decimal_multiplier = {
            'k': 10**3,
            'm': 10**6,
            'g': 10**9,
        }
        binary_multiplier = {
            'K': 2**10,
            'M': 2**20,
            'G': 2**30,
        }

        number, suffix = match.groups()
        if suffix in decimal_multiplier:
            mult = decimal_multiplier[suffix]
            return int(float(number) * mult)
        elif suffix in binary_multiplier:
            mult = binary_multiplier[suffix]
            # Do not allow decimals with binary multipliers
            try:
                return int(number) * mult
            except ValueError as e:
                raise argparse.ArgumentTypeError("Decimals are not allowed " \
                f"with binary suffixes like {suffix}. Did you mean to use " \
                f"{number}{suffix.lower()} instead?") from e

    # Regular plain number.
    return int(value)


1805
1806
# These functions are used by sphinx to build the documentation
def _engine_args_parser():
1807
    return EngineArgs.add_cli_args(FlexibleArgumentParser())
1808
1809
1810


def _async_engine_args_parser():
1811
    return AsyncEngineArgs.add_cli_args(FlexibleArgumentParser(),
1812
                                        async_args_only=True)