arg_utils.py 61 KB
Newer Older
1
import argparse
2
import dataclasses
3
import json
4
from dataclasses import dataclass
5
from typing import (TYPE_CHECKING, Any, Dict, List, Literal, Mapping, Optional,
6
                    Tuple, Type, Union, cast, get_args)
7

8
9
import torch

10
import vllm.envs as envs
11
from vllm.config import (CacheConfig, CompilationConfig, ConfigFormat,
12
13
14
15
                         DecodingConfig, DeviceConfig, HfOverrides,
                         KVTransferConfig, LoadConfig, LoadFormat, LoRAConfig,
                         ModelConfig, ObservabilityConfig, ParallelConfig,
                         PoolerConfig, PromptAdapterConfig, SchedulerConfig,
16
17
                         SpeculativeConfig, TaskOption, TokenizerPoolConfig,
                         VllmConfig)
18
from vllm.executor.executor_base import ExecutorBase
19
from vllm.logger import init_logger
20
from vllm.model_executor.layers.quantization import QUANTIZATION_METHODS
21
from vllm.transformers_utils.utils import check_gguf_file
22
from vllm.usage.usage_lib import UsageContext
23
from vllm.utils import FlexibleArgumentParser, StoreBoolean
24

25
if TYPE_CHECKING:
26
    from vllm.transformers_utils.tokenizer_group import BaseTokenizerGroup
27

28
29
logger = init_logger(__name__)

30
31
ALLOWED_DETAILED_TRACE_MODULES = ["model", "worker", "all"]

32
33
34
35
36
37
38
39
DEVICE_OPTIONS = [
    "auto",
    "cuda",
    "neuron",
    "cpu",
    "openvino",
    "tpu",
    "xpu",
40
    "hpu",
41
42
]

43

44
45
46
47
48
49
def nullable_str(val: str):
    if not val or val == "None":
        return None
    return val


50
def nullable_kvs(val: str) -> Optional[Mapping[str, int]]:
51
52
53
54
55
56
57
58
59
    """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.
    """
60
61
62
63
64
    if len(val) == 0:
        return None

    out_dict: Dict[str, int] = {}
    for item in val.split(","):
65
66
67
68
69
        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
70
71

        try:
72
            parsed_value = int(value)
73
74
        except ValueError as exc:
            msg = f"Failed to parse value of item {key}={value}"
75
76
77
78
79
80
            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
81
82
83
84

    return out_dict


85
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
86
class EngineArgs:
Woosuk Kwon's avatar
Woosuk Kwon committed
87
    """Arguments for vLLM engine."""
88
    model: str = 'facebook/opt-125m'
89
    served_model_name: Optional[Union[str, List[str]]] = None
90
    tokenizer: Optional[str] = None
91
    task: TaskOption = "auto"
92
    skip_tokenizer_init: bool = False
93
    tokenizer_mode: str = 'auto'
94
    trust_remote_code: bool = False
95
    allowed_local_media_path: str = ""
96
    download_dir: Optional[str] = None
97
    load_format: str = 'auto'
98
    config_format: ConfigFormat = ConfigFormat.AUTO
99
    dtype: str = 'auto'
100
    kv_cache_dtype: str = 'auto'
101
    quantization_param_path: Optional[str] = None
102
    seed: int = 0
103
    max_model_len: Optional[int] = None
104
    worker_use_ray: bool = False
105
106
107
108
109
    # 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
110
    # number of P/D disaggregation (or other disaggregation) workers
111
112
    pipeline_parallel_size: int = 1
    tensor_parallel_size: int = 1
113
    max_parallel_loading_workers: Optional[int] = None
114
    block_size: Optional[int] = None
115
    enable_prefix_caching: Optional[bool] = None
116
    disable_sliding_window: bool = False
117
    use_v2_block_manager: bool = True
118
119
    swap_space: float = 4  # GiB
    cpu_offload_gb: float = 0  # GiB
120
    gpu_memory_utilization: float = 0.90
121
    max_num_batched_tokens: Optional[int] = None
122
    max_num_seqs: Optional[int] = None
123
    max_logprobs: int = 20  # Default value for OpenAI Chat Completions API
124
    disable_log_stats: bool = False
Jasmond L's avatar
Jasmond L committed
125
    revision: Optional[str] = None
126
    code_revision: Optional[str] = None
127
    rope_scaling: Optional[Dict[str, Any]] = None
128
    rope_theta: Optional[float] = None
129
    hf_overrides: Optional[HfOverrides] = None
130
    tokenizer_revision: Optional[str] = None
131
    quantization: Optional[str] = None
132
    enforce_eager: Optional[bool] = None
133
    max_seq_len_to_capture: int = 8192
134
    disable_custom_all_reduce: bool = False
135
    tokenizer_pool_size: int = 0
136
137
138
139
    # 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"
140
    tokenizer_pool_extra_config: Optional[Dict[str, Any]] = None
141
    limit_mm_per_prompt: Optional[Mapping[str, int]] = None
142
    mm_processor_kwargs: Optional[Dict[str, Any]] = None
143
    disable_mm_preprocessor_cache: bool = False
144
    enable_lora: bool = False
145
    enable_lora_bias: bool = False
146
147
    max_loras: int = 1
    max_lora_rank: int = 16
148
149
150
    enable_prompt_adapter: bool = False
    max_prompt_adapters: int = 1
    max_prompt_adapter_token: int = 0
151
    fully_sharded_loras: bool = False
152
    lora_extra_vocab_size: int = 256
153
    long_lora_scaling_factors: Optional[Tuple[float]] = None
154
    lora_dtype: Optional[Union[str, torch.dtype]] = 'auto'
155
    max_cpu_loras: Optional[int] = None
156
    device: str = 'auto'
157
    num_scheduler_steps: int = 1
158
    multi_step_stream_outputs: bool = True
159
    ray_workers_use_nsight: bool = False
160
    num_gpu_blocks_override: Optional[int] = None
161
    num_lookahead_slots: int = 0
162
    model_loader_extra_config: Optional[dict] = None
163
    ignore_patterns: Optional[Union[str, List[str]]] = None
164
    preemption_mode: Optional[str] = None
165

166
    scheduler_delay_factor: float = 0.0
167
    enable_chunked_prefill: Optional[bool] = None
168

169
    guided_decoding_backend: str = 'xgrammar'
170
    logits_processor_pattern: Optional[str] = None
171
172
    # Speculative decoding configuration.
    speculative_model: Optional[str] = None
173
    speculative_model_quantization: Optional[str] = None
174
    speculative_draft_tensor_parallel_size: Optional[int] = None
175
    num_speculative_tokens: Optional[int] = None
176
    speculative_disable_mqa_scorer: Optional[bool] = False
177
    speculative_max_model_len: Optional[int] = None
178
    speculative_disable_by_batch_size: Optional[int] = None
179
180
    ngram_prompt_lookup_max: Optional[int] = None
    ngram_prompt_lookup_min: Optional[int] = None
181
182
183
    spec_decoding_acceptance_method: str = 'rejection_sampler'
    typical_acceptance_sampler_posterior_threshold: Optional[float] = None
    typical_acceptance_sampler_posterior_alpha: Optional[float] = None
184
    qlora_adapter_name_or_path: Optional[str] = None
185
    disable_logprobs_during_spec_decoding: Optional[bool] = None
186

187
    otlp_traces_endpoint: Optional[str] = None
188
    collect_detailed_traces: Optional[str] = None
189
    disable_async_output_proc: bool = False
190
    scheduling_policy: Literal["fcfs", "priority"] = "fcfs"
191

192
193
    override_neuron_config: Optional[Dict[str, Any]] = None
    override_pooler_config: Optional[PoolerConfig] = None
194
    compilation_config: Optional[CompilationConfig] = None
195
    worker_cls: str = "auto"
196

197
198
    kv_transfer_config: Optional[KVTransferConfig] = None

199
    generation_config: Optional[str] = None
200
    enable_sleep_mode: bool = False
201

202
    def __post_init__(self):
203
        if not self.tokenizer:
204
            self.tokenizer = self.model
205

206
207
208
209
        # Override the default value of enable_prefix_caching if it's not set
        # by user.
        if self.enable_prefix_caching is None:
            self.enable_prefix_caching = bool(envs.VLLM_USE_V1)
210

211
212
213
        # Override max_num_seqs if it's not set by user.
        if self.max_num_seqs is None:
            self.max_num_seqs = 256 if not envs.VLLM_USE_V1 else 1024
214

215
216
217
        # support `EngineArgs(compilation_config={...})`
        # without having to manually construct a
        # CompilationConfig object
218
        if isinstance(self.compilation_config, (int, dict)):
219
220
            self.compilation_config = CompilationConfig.from_cli(
                str(self.compilation_config))
221

222
        # Setup plugins
223
224
        from vllm.plugins import load_general_plugins
        load_general_plugins()
225
226

    @staticmethod
227
    def add_cli_args(parser: FlexibleArgumentParser) -> FlexibleArgumentParser:
Woosuk Kwon's avatar
Woosuk Kwon committed
228
        """Shared CLI arguments for vLLM engine."""
229

230
        # Model arguments
231
232
233
        parser.add_argument(
            '--model',
            type=str,
234
            default=EngineArgs.model,
235
            help='Name or path of the huggingface model to use.')
236
237
238
239
240
241
        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 '
242
            'multiple tasks. When the model only supports one task, ``"auto"`` '
243
244
            'can be used to select it; otherwise, you must specify explicitly '
            'which task to use.')
245
246
        parser.add_argument(
            '--tokenizer',
247
            type=nullable_str,
248
            default=EngineArgs.tokenizer,
249
250
            help='Name or path of the huggingface tokenizer to use. '
            'If unspecified, model name or path will be used.')
251
252
253
        parser.add_argument(
            '--skip-tokenizer-init',
            action='store_true',
254
            help='Skip initialization of tokenizer and detokenizer.')
Jasmond L's avatar
Jasmond L committed
255
256
        parser.add_argument(
            '--revision',
257
            type=nullable_str,
Jasmond L's avatar
Jasmond L committed
258
            default=None,
259
            help='The specific model version to use. It can be a branch '
Jasmond L's avatar
Jasmond L committed
260
261
            'name, a tag name, or a commit id. If unspecified, will use '
            'the default version.')
262
263
        parser.add_argument(
            '--code-revision',
264
            type=nullable_str,
265
            default=None,
266
            help='The specific revision to use for the model code on '
267
268
            'Hugging Face Hub. It can be a branch name, a tag name, or a '
            'commit id. If unspecified, will use the default version.')
269
270
        parser.add_argument(
            '--tokenizer-revision',
271
            type=nullable_str,
272
            default=None,
273
274
275
            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.')
276
277
278
279
        parser.add_argument(
            '--tokenizer-mode',
            type=str,
            default=EngineArgs.tokenizer_mode,
280
            choices=['auto', 'slow', 'mistral'],
281
282
            help='The tokenizer mode.\n\n* "auto" will use the '
            'fast tokenizer if available.\n* "slow" will '
283
284
            'always use the slow tokenizer. \n* '
            '"mistral" will always use the `mistral_common` tokenizer.')
285
286
        parser.add_argument('--trust-remote-code',
                            action='store_true',
287
                            help='Trust remote code from huggingface.')
288
289
290
        parser.add_argument(
            '--allowed-local-media-path',
            type=str,
291
292
293
294
            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.")
295
        parser.add_argument('--download-dir',
296
                            type=nullable_str,
Zhuohan Li's avatar
Zhuohan Li committed
297
                            default=EngineArgs.download_dir,
298
                            help='Directory to download and load the weights, '
299
                            'default to the default cache dir of '
300
                            'huggingface.')
301
302
303
304
        parser.add_argument(
            '--load-format',
            type=str,
            default=EngineArgs.load_format,
305
            choices=[f.value for f in LoadFormat],
306
307
            help='The format of the model weights to load.\n\n'
            '* "auto" will try to load the weights in the safetensors format '
308
            'and fall back to the pytorch bin format if safetensors format '
309
310
311
312
313
314
315
316
            '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 '
317
            'CoreWeave. See the Tensorize vLLM Model script in the Examples '
318
            'section for more information.\n'
319
320
            '* "runai_streamer" will load the Safetensors weights using Run:ai'
            'Model Streamer \n'
321
322
            '* "bitsandbytes" will load the weights using bitsandbytes '
            'quantization.\n')
323
324
325
326
327
328
329
        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 ')
330
331
332
333
        parser.add_argument(
            '--dtype',
            type=str,
            default=EngineArgs.dtype,
Woosuk Kwon's avatar
Woosuk Kwon committed
334
335
336
            choices=[
                'auto', 'half', 'float16', 'bfloat16', 'float', 'float32'
            ],
337
338
339
340
341
342
343
344
            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.')
345
346
347
        parser.add_argument(
            '--kv-cache-dtype',
            type=str,
348
            choices=['auto', 'fp8', 'fp8_e5m2', 'fp8_e4m3'],
349
            default=EngineArgs.kv_cache_dtype,
350
            help='Data type for kv cache storage. If "auto", will use model '
351
352
            'data type. CUDA 11.8+ supports fp8 (=fp8_e4m3) and fp8_e5m2. '
            'ROCm (AMD GPU) supports fp8 (=fp8_e4m3)')
353
354
        parser.add_argument(
            '--quantization-param-path',
355
            type=nullable_str,
356
357
358
359
360
            default=None,
            help='Path to the JSON file containing the KV cache '
            'scaling factors. This should generally be supplied, when '
            'KV cache dtype is FP8. Otherwise, KV cache scaling factors '
            'default to 1.0, which may cause accuracy issues. '
361
            'FP8_E5M2 (without scaling) is only supported on cuda version '
362
            'greater than 11.8. On ROCm (AMD GPU), FP8_E4M3 is instead '
363
            'supported for common inference criteria.')
364
365
        parser.add_argument('--max-model-len',
                            type=int,
366
                            default=EngineArgs.max_model_len,
367
368
                            help='Model context length. If unspecified, will '
                            'be automatically derived from the model config.')
369
370
371
        parser.add_argument(
            '--guided-decoding-backend',
            type=str,
372
373
            default='xgrammar',
            choices=['outlines', 'lm-format-enforcer', 'xgrammar'],
374
            help='Which engine will be used for guided decoding'
375
            ' (JSON schema / regex etc) by default. Currently support '
376
            'https://github.com/outlines-dev/outlines, '
377
            'https://github.com/mlc-ai/xgrammar, and '
378
379
380
            'https://github.com/noamgat/lm-format-enforcer.'
            ' Can be overridden per request via guided_decoding_backend'
            ' parameter.')
381
382
383
384
385
386
387
388
        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.')
389
        # Parallel arguments
390
391
        parser.add_argument(
            '--distributed-executor-backend',
392
            choices=['ray', 'mp', 'uni', 'external_launcher'],
393
            default=EngineArgs.distributed_executor_backend,
394
395
396
397
398
399
            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 '
400
            'only supports Ray for distributed inference.')
401

402
403
404
        parser.add_argument(
            '--worker-use-ray',
            action='store_true',
405
            help='Deprecated, use ``--distributed-executor-backend=ray``.')
406
407
408
        parser.add_argument('--pipeline-parallel-size',
                            '-pp',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
409
                            default=EngineArgs.pipeline_parallel_size,
410
                            help='Number of pipeline stages.')
411
412
413
        parser.add_argument('--tensor-parallel-size',
                            '-tp',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
414
                            default=EngineArgs.tensor_parallel_size,
415
                            help='Number of tensor parallel replicas.')
416
417
418
        parser.add_argument(
            '--max-parallel-loading-workers',
            type=int,
419
            default=EngineArgs.max_parallel_loading_workers,
420
            help='Load model sequentially in multiple batches, '
421
            'to avoid RAM OOM when using tensor '
422
            'parallel and large models.')
423
424
425
        parser.add_argument(
            '--ray-workers-use-nsight',
            action='store_true',
426
            help='If specified, use nsight to profile Ray workers.')
427
        # KV cache arguments
428
429
        parser.add_argument('--block-size',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
430
                            default=EngineArgs.block_size,
431
                            choices=[8, 16, 32, 64, 128],
432
                            help='Token block size for contiguous chunks of '
433
                            'tokens. This is ignored on neuron devices and '
434
                            'set to ``--max-model-len``. On CUDA devices, '
435
436
                            'only block sizes up to 32 are supported. '
                            'On HPU devices, block size defaults to 128.')
437

438
439
440
441
442
        parser.add_argument(
            "--enable-prefix-caching",
            action=argparse.BooleanOptionalAction,
            default=EngineArgs.enable_prefix_caching,
            help="Enables automatic prefix caching. "
443
            "Use ``--no-enable-prefix-caching`` to disable explicitly.",
444
        )
445
446
447
        parser.add_argument('--disable-sliding-window',
                            action='store_true',
                            help='Disables sliding window, '
448
                            'capping to sliding window size.')
449
450
        parser.add_argument('--use-v2-block-manager',
                            action='store_true',
451
                            default=True,
452
453
454
455
456
                            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.')
457
458
459
460
461
462
463
464
        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.')
465

466
467
468
        parser.add_argument('--seed',
                            type=int,
                            default=EngineArgs.seed,
469
                            help='Random seed for operations.')
470
        parser.add_argument('--swap-space',
471
                            type=float,
Zhuohan Li's avatar
Zhuohan Li committed
472
                            default=EngineArgs.swap_space,
473
                            help='CPU swap space size (GiB) per GPU.')
474
475
476
477
478
479
480
481
482
        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 '
483
            'a 34 GB GPU. Then you can load a 13B model with BF16 weight, '
484
            'which requires at least 26GB GPU memory. Note that this '
485
            'requires fast CPU-GPU interconnect, as part of the model is '
486
487
            'loaded from CPU memory to GPU memory on the fly in each '
            'model forward pass.')
488
489
490
491
        parser.add_argument(
            '--gpu-memory-utilization',
            type=float,
            default=EngineArgs.gpu_memory_utilization,
492
493
494
            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, '
495
496
497
498
499
500
            '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.')
501
        parser.add_argument(
502
            '--num-gpu-blocks-override',
503
504
505
            type=int,
            default=None,
            help='If specified, ignore GPU profiling result and use this number'
506
            ' of GPU blocks. Used for testing preemption.')
507
508
        parser.add_argument('--max-num-batched-tokens',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
509
                            default=EngineArgs.max_num_batched_tokens,
510
511
                            help='Maximum number of batched tokens per '
                            'iteration.')
512
513
        parser.add_argument('--max-num-seqs',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
514
                            default=EngineArgs.max_num_seqs,
515
                            help='Maximum number of sequences per iteration.')
516
517
518
519
        parser.add_argument(
            '--max-logprobs',
            type=int,
            default=EngineArgs.max_logprobs,
520
521
            help=('Max number of log probs to return logprobs is specified in'
                  ' SamplingParams.'))
522
523
        parser.add_argument('--disable-log-stats',
                            action='store_true',
524
                            help='Disable logging statistics.')
525
526
527
        # Quantization settings.
        parser.add_argument('--quantization',
                            '-q',
528
                            type=nullable_str,
529
                            choices=[*QUANTIZATION_METHODS, None],
530
                            default=EngineArgs.quantization,
531
532
533
534
535
536
                            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.')
537
538
539
540
541
        parser.add_argument(
            '--rope-scaling',
            default=None,
            type=json.loads,
            help='RoPE scaling configuration in JSON format. '
542
            'For example, ``{"rope_type":"dynamic","factor":2.0}``')
543
544
545
546
547
548
        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.')
549
550
551
        parser.add_argument('--hf-overrides',
                            type=json.loads,
                            default=EngineArgs.hf_overrides,
552
                            help='Extra arguments for the HuggingFace config. '
553
554
                            'This should be a JSON string that will be '
                            'parsed into a dictionary.')
555
556
557
558
559
        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.')
560
        parser.add_argument('--max-seq-len-to-capture',
561
562
563
564
                            type=int,
                            default=EngineArgs.max_seq_len_to_capture,
                            help='Maximum sequence length covered by CUDA '
                            'graphs. When a sequence has context length '
565
566
567
568
                            '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.')
569
570
571
        parser.add_argument('--disable-custom-all-reduce',
                            action='store_true',
                            default=EngineArgs.disable_custom_all_reduce,
572
                            help='See ParallelConfig.')
573
574
575
576
577
578
579
580
581
582
583
584
585
        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',
586
                            type=nullable_str,
587
588
589
590
591
                            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.')
592
593
594
595
596
597
598
599
600
601
602
603
604
605

        # 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
            # MultiModalRegistry.init_mm_limits_per_prompt
            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.'))
606
607
608
609
        parser.add_argument(
            '--mm-processor-kwargs',
            default=None,
            type=json.loads,
610
            help=('Overrides for the multimodal input mapping/processing, '
611
                  'e.g., image processor. For example: ``{"num_crops": 4}``.'))
612
        parser.add_argument(
613
            '--disable-mm-preprocessor-cache',
614
            action='store_true',
615
616
            help='If true, then disables caching of the multi-modal '
            'preprocessor/mapper. (not recommended)')
617

618
619
620
621
        # LoRA related configs
        parser.add_argument('--enable-lora',
                            action='store_true',
                            help='If True, enable handling of LoRA adapters.')
622
623
624
        parser.add_argument('--enable-lora-bias',
                            action='store_true',
                            help='If True, enable bias for LoRA adapters.')
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
        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,
644
            choices=['auto', 'float16', 'bfloat16'],
645
646
            help=('Data type for LoRA. If auto, will default to '
                  'base model dtype.'))
647
648
649
650
651
652
653
654
655
656
657
        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.'))
658
659
660
661
662
        parser.add_argument(
            '--max-cpu-loras',
            type=int,
            default=EngineArgs.max_cpu_loras,
            help=('Maximum number of LoRAs to store in CPU memory. '
663
664
                  'Must be >= than max_loras. '
                  'Defaults to max_loras.'))
665
666
667
668
669
670
671
672
        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.'))
673
674
675
676
677
678
679
680
681
682
683
        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')
684
685
686
        parser.add_argument("--device",
                            type=str,
                            default=EngineArgs.device,
687
                            choices=DEVICE_OPTIONS,
688
                            help='Device type for vLLM execution.')
689
690
691
692
693
        parser.add_argument('--num-scheduler-steps',
                            type=int,
                            default=1,
                            help=('Maximum number of forward steps per '
                                  'scheduler call.'))
694

695
696
        parser.add_argument(
            '--multi-step-stream-outputs',
697
698
699
700
701
702
            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')
703
704
705
706
        parser.add_argument(
            '--scheduler-delay-factor',
            type=float,
            default=EngineArgs.scheduler_delay_factor,
707
            help='Apply a delay (of delay factor multiplied by previous '
708
            'prompt latency) before scheduling next prompt.')
709
710
        parser.add_argument(
            '--enable-chunked-prefill',
711
712
713
714
            action=StoreBoolean,
            default=EngineArgs.enable_chunked_prefill,
            nargs="?",
            const="True",
715
            help='If set, the prefill requests can be chunked based on the '
716
            'max_num_batched_tokens.')
717
718
719

        parser.add_argument(
            '--speculative-model',
720
            type=nullable_str,
721
            default=EngineArgs.speculative_model,
722
723
            help=
            'The name of the draft model to be used in speculative decoding.')
724
725
726
727
728
729
        # Quantization settings for speculative model.
        parser.add_argument(
            '--speculative-model-quantization',
            type=nullable_str,
            choices=[*QUANTIZATION_METHODS, None],
            default=EngineArgs.speculative_model_quantization,
730
            help='Method used to quantize the weights of speculative model. '
731
732
733
734
735
            '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.')
736
737
738
        parser.add_argument(
            '--num-speculative-tokens',
            type=int,
739
            default=EngineArgs.num_speculative_tokens,
740
            help='The number of speculative tokens to sample from '
741
            'the draft model in speculative decoding.')
742
743
744
745
746
747
        parser.add_argument(
            '--speculative-disable-mqa-scorer',
            action='store_true',
            help=
            'If set to True, the MQA scorer will be disabled in speculative '
            ' and fall back to batch expansion')
748
749
750
751
752
753
754
        parser.add_argument(
            '--speculative-draft-tensor-parallel-size',
            '-spec-draft-tp',
            type=int,
            default=EngineArgs.speculative_draft_tensor_parallel_size,
            help='Number of tensor parallel replicas for '
            'the draft model in speculative decoding.')
755

756
757
        parser.add_argument(
            '--speculative-max-model-len',
758
            type=int,
759
760
761
762
763
            default=EngineArgs.speculative_max_model_len,
            help='The maximum sequence length supported by the '
            'draft model. Sequences over this length will skip '
            'speculation.')

764
765
766
767
768
769
770
        parser.add_argument(
            '--speculative-disable-by-batch-size',
            type=int,
            default=EngineArgs.speculative_disable_by_batch_size,
            help='Disable speculative decoding for new incoming requests '
            'if the number of enqueue requests is larger than this value.')

771
772
773
774
775
776
777
778
779
780
781
782
783
784
        parser.add_argument(
            '--ngram-prompt-lookup-max',
            type=int,
            default=EngineArgs.ngram_prompt_lookup_max,
            help='Max size of window for ngram prompt lookup in speculative '
            'decoding.')

        parser.add_argument(
            '--ngram-prompt-lookup-min',
            type=int,
            default=EngineArgs.ngram_prompt_lookup_min,
            help='Min size of window for ngram prompt lookup in speculative '
            'decoding.')

785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
        parser.add_argument(
            '--spec-decoding-acceptance-method',
            type=str,
            default=EngineArgs.spec_decoding_acceptance_method,
            choices=['rejection_sampler', 'typical_acceptance_sampler'],
            help='Specify the acceptance method to use during draft token '
            'verification in speculative decoding. Two types of acceptance '
            'routines are supported: '
            '1) RejectionSampler which does not allow changing the '
            'acceptance rate of draft tokens, '
            '2) TypicalAcceptanceSampler which is configurable, allowing for '
            'a higher acceptance rate at the cost of lower quality, '
            'and vice versa.')

        parser.add_argument(
            '--typical-acceptance-sampler-posterior-threshold',
            type=float,
            default=EngineArgs.typical_acceptance_sampler_posterior_threshold,
            help='Set the lower bound threshold for the posterior '
            'probability of a token to be accepted. This threshold is '
            'used by the TypicalAcceptanceSampler to make sampling decisions '
            'during speculative decoding. Defaults to 0.09')

        parser.add_argument(
            '--typical-acceptance-sampler-posterior-alpha',
            type=float,
            default=EngineArgs.typical_acceptance_sampler_posterior_alpha,
            help='A scaling factor for the entropy-based threshold for token '
            'acceptance in the TypicalAcceptanceSampler. Typically defaults '
            'to sqrt of --typical-acceptance-sampler-posterior-threshold '
            'i.e. 0.3')

817
818
        parser.add_argument(
            '--disable-logprobs-during-spec-decoding',
819
            action=StoreBoolean,
820
            default=EngineArgs.disable_logprobs_during_spec_decoding,
821
822
            nargs="?",
            const="True",
823
824
825
826
827
828
829
830
            help='If set to True, token log probabilities are not returned '
            'during speculative decoding. If set to False, log probabilities '
            'are returned according to the settings in SamplingParams. If '
            'not specified, it defaults to True. Disabling log probabilities '
            'during speculative decoding reduces latency by skipping logprob '
            'calculation in proposal sampling, target sampling, and after '
            'accepted tokens are determined.')

831
        parser.add_argument('--model-loader-extra-config',
832
                            type=nullable_str,
833
834
835
836
837
838
                            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.')
839
840
841
842
843
844
        parser.add_argument(
            '--ignore-patterns',
            action="append",
            type=str,
            default=[],
            help="The pattern(s) to ignore when loading the model."
845
            "Default to `original/**/*` to avoid repeated loading of llama's "
846
            "checkpoints.")
847
        parser.add_argument(
848
            '--preemption-mode',
849
850
            type=str,
            default=None,
851
852
853
            help='If \'recompute\', the engine performs preemption by '
            'recomputing; If \'swap\', the engine performs preemption by '
            'block swapping.')
854

855
856
857
858
859
860
861
862
863
864
        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 "
865
            "same as the ``--model`` argument. Noted that this name(s) "
866
            "will also be used in `model_name` tag content of "
867
            "prometheus metrics, if multiple names provided, metrics "
868
            "tag will take the first one.")
869
870
871
872
        parser.add_argument('--qlora-adapter-name-or-path',
                            type=str,
                            default=None,
                            help='Name or path of the QLoRA adapter.')
873
874
875
876
877
878

        parser.add_argument(
            '--otlp-traces-endpoint',
            type=str,
            default=None,
            help='Target URL to which OpenTelemetry traces will be sent.')
879
880
881
882
883
884
        parser.add_argument(
            '--collect-detailed-traces',
            type=str,
            default=None,
            help="Valid choices are " +
            ",".join(ALLOWED_DETAILED_TRACE_MODULES) +
885
            ". It makes sense to set this only if ``--otlp-traces-endpoint`` is"
886
887
888
            " 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.")
889

890
891
892
893
894
895
        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.")
896

897
898
899
900
901
902
903
904
905
906
        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).')

907
        parser.add_argument(
908
909
            '--override-neuron-config',
            type=json.loads,
910
            default=None,
911
            help="Override or set neuron device configuration. "
912
            "e.g. ``{\"cast_logits_dtype\": \"bloat16\"}``.")
913
        parser.add_argument(
914
915
            '--override-pooler-config',
            type=PoolerConfig.from_json,
916
            default=None,
917
            help="Override or set the pooling method for pooling models. "
918
            "e.g. ``{\"pooling_type\": \"mean\", \"normalize\": false}``.")
919

920
921
922
923
924
925
926
927
928
929
930
931
        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, '
932
933
934
935
                            'use a JSON string.\n'
                            'Following the convention of traditional '
                            'compilers, using -O without space is also '
                            'supported. -O3 is equivalent to -O 3.')
936

937
938
939
940
941
942
        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.')

943
944
945
946
947
948
        parser.add_argument(
            '--worker-cls',
            type=str,
            default="auto",
            help='The worker class to use for distributed execution.')

949
950
951
952
953
954
955
956
957
958
        parser.add_argument(
            "--generation-config",
            type=nullable_str,
            default=None,
            help="The folder path to the generation config. "
            "Defaults to None, will use the default generation config in vLLM. "
            "If set to 'auto', the generation config will be automatically "
            "loaded from model. If set to a folder path, the generation config "
            "will be loaded from the specified folder path.")

959
960
961
962
963
964
        parser.add_argument("--enable-sleep-mode",
                            action="store_true",
                            default=False,
                            help="Enable sleep mode for the engine. "
                            "(only cuda platform is supported)")

965
        return parser
966
967

    @classmethod
968
    def from_cli_args(cls, args: argparse.Namespace):
969
970
971
        # 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
972
973
        engine_args = cls(**{attr: getattr(args, attr) for attr in attrs})
        return engine_args
974

975
976
    def create_model_config(self) -> ModelConfig:
        return ModelConfig(
977
            model=self.model,
978
            task=self.task,
979
980
            # We know this is not None because we set it in __post_init__
            tokenizer=cast(str, self.tokenizer),
981
982
            tokenizer_mode=self.tokenizer_mode,
            trust_remote_code=self.trust_remote_code,
983
            allowed_local_media_path=self.allowed_local_media_path,
984
985
986
987
988
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
            rope_scaling=self.rope_scaling,
989
            rope_theta=self.rope_theta,
990
            hf_overrides=self.hf_overrides,
991
992
993
994
995
996
997
998
999
            tokenizer_revision=self.tokenizer_revision,
            max_model_len=self.max_model_len,
            quantization=self.quantization,
            quantization_param_path=self.quantization_param_path,
            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,
            skip_tokenizer_init=self.skip_tokenizer_init,
1000
            served_model_name=self.served_model_name,
1001
            limit_mm_per_prompt=self.limit_mm_per_prompt,
1002
            use_async_output_proc=not self.disable_async_output_proc,
1003
            config_format=self.config_format,
1004
            mm_processor_kwargs=self.mm_processor_kwargs,
1005
            disable_mm_preprocessor_cache=self.disable_mm_preprocessor_cache,
1006
1007
            override_neuron_config=self.override_neuron_config,
            override_pooler_config=self.override_pooler_config,
1008
            logits_processor_pattern=self.logits_processor_pattern,
1009
1010
1011
            generation_config=self.generation_config,
            enable_sleep_mode=self.enable_sleep_mode,
        )
1012

1013
1014
1015
1016
1017
1018
1019
1020
    def create_load_config(self) -> LoadConfig:
        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,
        )

1021
1022
1023
1024
1025
1026
    def create_engine_config(self,
                             usage_context: Optional[UsageContext] = None
                             ) -> VllmConfig:
        if envs.VLLM_USE_V1:
            self._override_v1_engine_args(usage_context)

1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
        # 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"

        # bitsandbytes quantization needs a specific model loader
        # so we make sure the quant method and the load format are consistent
        if (self.quantization == "bitsandbytes" or
           self.qlora_adapter_name_or_path is not None) and \
           self.load_format != "bitsandbytes":
            raise ValueError(
                "BitsAndBytes quantization and QLoRA adapter only support "
                f"'bitsandbytes' load format, but got {self.load_format}")

        if (self.load_format == "bitsandbytes" or
            self.qlora_adapter_name_or_path is not None) and \
            self.quantization != "bitsandbytes":
            raise ValueError(
                "BitsAndBytes load format and QLoRA adapter only support "
                f"'bitsandbytes' quantization, but got {self.quantization}")

        assert self.cpu_offload_gb >= 0, (
            "CPU offload space must be non-negative"
            f", but got {self.cpu_offload_gb}")

        device_config = DeviceConfig(device=self.device)
        model_config = self.create_model_config()

1054
1055
1056
1057
1058
        if (model_config.is_multimodal_model and not envs.VLLM_USE_V1
                and self.enable_prefix_caching):
            logger.warning("--enable-prefix-caching is currently not "
                           "supported for multimodal models in v0 and "
                           "has been disabled.")
1059
1060
            self.enable_prefix_caching = False

1061
        cache_config = CacheConfig(
1062
            block_size=self.block_size,
1063
1064
1065
            gpu_memory_utilization=self.gpu_memory_utilization,
            swap_space=self.swap_space,
            cache_dtype=self.kv_cache_dtype,
1066
            is_attention_free=model_config.is_attention_free,
1067
1068
            num_gpu_blocks_override=self.num_gpu_blocks_override,
            sliding_window=model_config.get_sliding_window(),
1069
1070
1071
            enable_prefix_caching=self.enable_prefix_caching,
            cpu_offload_gb=self.cpu_offload_gb,
        )
1072
        parallel_config = ParallelConfig(
1073
1074
1075
1076
1077
1078
            pipeline_parallel_size=self.pipeline_parallel_size,
            tensor_parallel_size=self.tensor_parallel_size,
            worker_use_ray=self.worker_use_ray,
            max_parallel_loading_workers=self.max_parallel_loading_workers,
            disable_custom_all_reduce=self.disable_custom_all_reduce,
            tokenizer_pool_config=TokenizerPoolConfig.create_config(
1079
1080
1081
                self.tokenizer_pool_size,
                self.tokenizer_pool_type,
                self.tokenizer_pool_extra_config,
1082
            ),
1083
            ray_workers_use_nsight=self.ray_workers_use_nsight,
1084
1085
1086
            distributed_executor_backend=self.distributed_executor_backend,
            worker_cls=self.worker_cls,
        )
1087

1088
1089
1090
1091
1092
1093
        max_model_len = model_config.max_model_len
        use_long_context = max_model_len > 32768
        if self.enable_chunked_prefill is None:
            # If not explicitly set, enable chunked prefill by default for
            # long context (> 32K) models. This is to avoid OOM errors in the
            # initial memory profiling phase.
1094

1095
1096
1097
1098
1099
1100
            # For multimodal models, chunked prefill is disabled by default in
            # V0, but enabled by design in V1
            if model_config.is_multimodal_model:
                self.enable_chunked_prefill = bool(envs.VLLM_USE_V1)

            elif use_long_context:
1101
1102
1103
1104
                is_gpu = device_config.device_type == "cuda"
                use_sliding_window = (model_config.get_sliding_window()
                                      is not None)
                use_spec_decode = self.speculative_model is not None
1105
                from vllm.platforms import current_platform
1106
1107
                if (is_gpu and not use_sliding_window and not use_spec_decode
                        and not self.enable_lora
1108
                        and not self.enable_prompt_adapter
1109
1110
                        and model_config.runner_type != "pooling"
                        and not current_platform.is_rocm()):
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
                    self.enable_chunked_prefill = True
                    logger.warning(
                        "Chunked prefill is enabled by default for models with "
                        "max_model_len > 32K. Currently, chunked prefill might "
                        "not work with some features or models. If you "
                        "encounter any issues, please disable chunked prefill "
                        "by setting --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 "
                "errors during the initial memory profiling phase, or result "
                "in low performance due to small KV cache space. Consider "
                "setting --max-model-len to a smaller value.", max_model_len)
1127
1128
        elif (self.enable_chunked_prefill
              and model_config.runner_type == "pooling"):
1129
            msg = "Chunked prefill is not supported for pooling models"
1130
            raise ValueError(msg)
1131

1132

1133
1134
1135
1136
1137
        speculative_config = SpeculativeConfig.maybe_create_spec_config(
            target_model_config=model_config,
            target_parallel_config=parallel_config,
            target_dtype=self.dtype,
            speculative_model=self.speculative_model,
1138
1139
            speculative_model_quantization = \
                self.speculative_model_quantization,
1140
1141
            speculative_draft_tensor_parallel_size = \
                self.speculative_draft_tensor_parallel_size,
1142
            num_speculative_tokens=self.num_speculative_tokens,
1143
            speculative_disable_mqa_scorer=self.speculative_disable_mqa_scorer,
1144
1145
            speculative_disable_by_batch_size=self.
            speculative_disable_by_batch_size,
1146
1147
            speculative_max_model_len=self.speculative_max_model_len,
            enable_chunked_prefill=self.enable_chunked_prefill,
1148
            disable_log_stats=self.disable_log_stats,
1149
1150
            ngram_prompt_lookup_max=self.ngram_prompt_lookup_max,
            ngram_prompt_lookup_min=self.ngram_prompt_lookup_min,
1151
1152
1153
1154
1155
1156
            draft_token_acceptance_method=\
                self.spec_decoding_acceptance_method,
            typical_acceptance_sampler_posterior_threshold=self.
            typical_acceptance_sampler_posterior_threshold,
            typical_acceptance_sampler_posterior_alpha=self.
            typical_acceptance_sampler_posterior_alpha,
1157
            disable_logprobs=self.disable_logprobs_during_spec_decoding,
1158
1159
        )

1160
        # Reminder: Please update docs/source/features/compatibility_matrix.md
1161
        # If the feature combo become valid
1162
1163
1164
1165
        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)")
1166
1167
1168
            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")
1169
1170
1171
1172
1173
1174
            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
1175
1176
1177
1178
1179
1180
1181
1182
1183

        # 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

1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
        if not self.use_v2_block_manager:
            logger.warning(
                "[DEPRECATED] Block manager v1 has been removed, "
                "and setting --use-v2-block-manager to True or False has "
                "no effect on vLLM behavior. Please remove "
                "--use-v2-block-manager in your engine argument. "
                "If your use case is not supported by "
                "SelfAttnBlockSpaceManager (i.e. block manager v2),"
                " please file an issue with detailed information.")

1194
        scheduler_config = SchedulerConfig(
1195
            runner_type=model_config.runner_type,
1196
1197
1198
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
1199
            num_lookahead_slots=num_lookahead_slots,
1200
1201
            delay_factor=self.scheduler_delay_factor,
            enable_chunked_prefill=self.enable_chunked_prefill,
1202
            is_multimodal_model=model_config.is_multimodal_model,
1203
            preemption_mode=self.preemption_mode,
1204
            num_scheduler_steps=self.num_scheduler_steps,
1205
            multi_step_stream_outputs=self.multi_step_stream_outputs,
1206
1207
            send_delta_data=(envs.VLLM_USE_RAY_SPMD_WORKER
                             and parallel_config.use_ray),
1208
            policy=self.scheduling_policy)
1209
        lora_config = LoRAConfig(
1210
            bias_enabled=self.enable_lora_bias,
1211
1212
            max_lora_rank=self.max_lora_rank,
            max_loras=self.max_loras,
1213
            fully_sharded_loras=self.fully_sharded_loras,
1214
            lora_extra_vocab_size=self.lora_extra_vocab_size,
1215
            long_lora_scaling_factors=self.long_lora_scaling_factors,
1216
1217
1218
            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
1219

1220
1221
1222
1223
1224
1225
1226
        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

1227
        load_config = self.create_load_config()
1228

1229
1230
1231
1232
1233
        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

1234
1235
1236
        decoding_config = DecodingConfig(
            guided_decoding_backend=self.guided_decoding_backend)

1237
1238
1239
1240
1241
1242
1243
1244
        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}")
1245
        observability_config = ObservabilityConfig(
1246
1247
1248
1249
1250
1251
            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,
        )
1252

1253
        config = VllmConfig(
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
            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,
1264
            prompt_adapter_config=prompt_adapter_config,
1265
            compilation_config=self.compilation_config,
1266
            kv_transfer_config=self.kv_transfer_config,
1267
        )
1268

1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
        if envs.VLLM_USE_V1:
            self._override_v1_engine_config(config)
        return config

    def _override_v1_engine_args(self, usage_context: UsageContext) -> None:
        """
        Override the EngineArgs's args based on the usage context for V1.
        """
        assert envs.VLLM_USE_V1, "V1 is not enabled"

1279
1280
1281
1282
1283
        # V1 always uses chunked prefills.
        self.enable_chunked_prefill = True
        # When no user override, set the default values based on the usage
        # context.
        # TODO(woosuk): Tune the default values for different hardware.
1284
1285
1286
1287
1288
1289
1290
1291
        default_max_num_batched_tokens = {
            UsageContext.LLM_CLASS: 8192,
            UsageContext.OPENAI_API_SERVER: 2048,
        }
        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]
1292
1293
1294
            logger.warning(
                "Setting max_num_batched_tokens to %d for %s usage context.",
                self.max_num_batched_tokens, usage_context.value)
1295
1296
1297
1298
1299
1300
1301

    def _override_v1_engine_config(self, engine_config: VllmConfig) -> None:
        """
        Override the EngineConfig's configs based on the usage context for V1.
        """
        assert envs.VLLM_USE_V1, "V1 is not enabled"

1302

1303
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
1304
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
1305
    """Arguments for asynchronous vLLM engine."""
1306
    disable_log_requests: bool = False
1307
1308

    @staticmethod
1309
1310
    def add_cli_args(parser: FlexibleArgumentParser,
                     async_args_only: bool = False) -> FlexibleArgumentParser:
1311
1312
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
1313
1314
        parser.add_argument('--disable-log-requests',
                            action='store_true',
1315
                            help='Disable logging requests.')
1316
        return parser
1317
1318
1319
1320


# These functions are used by sphinx to build the documentation
def _engine_args_parser():
1321
    return EngineArgs.add_cli_args(FlexibleArgumentParser())
1322
1323
1324


def _async_engine_args_parser():
1325
    return AsyncEngineArgs.add_cli_args(FlexibleArgumentParser(),
1326
                                        async_args_only=True)