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

8
9
import torch

10
import vllm.envs as envs
11
12
13
14
from vllm.config import (CacheConfig, ConfigFormat, DecodingConfig,
                         DeviceConfig, EngineConfig, LoadConfig, LoadFormat,
                         LoRAConfig, ModelConfig, ObservabilityConfig,
                         ParallelConfig, PromptAdapterConfig, SchedulerConfig,
15
                         SpeculativeConfig, TokenizerPoolConfig)
16
from vllm.executor.executor_base import ExecutorBase
17
from vllm.logger import init_logger
18
from vllm.model_executor.layers.quantization import QUANTIZATION_METHODS
19
from vllm.transformers_utils.utils import check_gguf_file
20
from vllm.utils import FlexibleArgumentParser
21

22
if TYPE_CHECKING:
23
    from vllm.transformers_utils.tokenizer_group import BaseTokenizerGroup
24

25
26
logger = init_logger(__name__)

27
28
ALLOWED_DETAILED_TRACE_MODULES = ["model", "worker", "all"]

29
30
31
32
33
34
35
36
37
38
DEVICE_OPTIONS = [
    "auto",
    "cuda",
    "neuron",
    "cpu",
    "openvino",
    "tpu",
    "xpu",
]

39

40
41
42
43
44
45
def nullable_str(val: str):
    if not val or val == "None":
        return None
    return val


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

    out_dict: Dict[str, int] = {}
    for item in val.split(","):
61
62
63
64
65
        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
66
67

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

    return out_dict


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

158
    scheduler_delay_factor: float = 0.0
159
    enable_chunked_prefill: Optional[bool] = None
160

161
    guided_decoding_backend: str = 'outlines'
162
163
    # Speculative decoding configuration.
    speculative_model: Optional[str] = None
164
    speculative_model_quantization: Optional[str] = None
165
    speculative_draft_tensor_parallel_size: Optional[int] = None
166
    num_speculative_tokens: Optional[int] = None
167
    num_speculative_heads: Optional[int] = None
168
    speculative_max_model_len: Optional[int] = None
169
    speculative_disable_by_batch_size: Optional[int] = None
170
171
    ngram_prompt_lookup_max: Optional[int] = None
    ngram_prompt_lookup_min: Optional[int] = None
172
173
174
    spec_decoding_acceptance_method: str = 'rejection_sampler'
    typical_acceptance_sampler_posterior_threshold: Optional[float] = None
    typical_acceptance_sampler_posterior_alpha: Optional[float] = None
175
    qlora_adapter_name_or_path: Optional[str] = None
176
    disable_logprobs_during_spec_decoding: Optional[bool] = None
177

178
    otlp_traces_endpoint: Optional[str] = None
179
    collect_detailed_traces: Optional[str] = None
180
    disable_async_output_proc: bool = False
181
    override_neuron_config: Optional[Dict[str, Any]] = None
182
    mm_processor_kwargs: Optional[Dict[str, Any]] = None
183

184
    def __post_init__(self):
185
186
        if self.tokenizer is None:
            self.tokenizer = self.model
187
188

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

192
        # Model arguments
193
194
195
        parser.add_argument(
            '--model',
            type=str,
196
            default=EngineArgs.model,
197
            help='Name or path of the huggingface model to use.')
198
199
        parser.add_argument(
            '--tokenizer',
200
            type=nullable_str,
201
            default=EngineArgs.tokenizer,
202
203
            help='Name or path of the huggingface tokenizer to use. '
            'If unspecified, model name or path will be used.')
204
205
206
207
        parser.add_argument(
            '--skip-tokenizer-init',
            action='store_true',
            help='Skip initialization of tokenizer and detokenizer')
Jasmond L's avatar
Jasmond L committed
208
209
        parser.add_argument(
            '--revision',
210
            type=nullable_str,
Jasmond L's avatar
Jasmond L committed
211
            default=None,
212
            help='The specific model version to use. It can be a branch '
Jasmond L's avatar
Jasmond L committed
213
214
            'name, a tag name, or a commit id. If unspecified, will use '
            'the default version.')
215
216
        parser.add_argument(
            '--code-revision',
217
            type=nullable_str,
218
            default=None,
219
            help='The specific revision to use for the model code on '
220
221
            'Hugging Face Hub. It can be a branch name, a tag name, or a '
            'commit id. If unspecified, will use the default version.')
222
223
        parser.add_argument(
            '--tokenizer-revision',
224
            type=nullable_str,
225
            default=None,
226
227
228
            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.')
229
230
231
232
        parser.add_argument(
            '--tokenizer-mode',
            type=str,
            default=EngineArgs.tokenizer_mode,
233
            choices=['auto', 'slow', 'mistral'],
234
235
            help='The tokenizer mode.\n\n* "auto" will use the '
            'fast tokenizer if available.\n* "slow" will '
236
237
            'always use the slow tokenizer. \n* '
            '"mistral" will always use the `mistral_common` tokenizer.')
238
239
        parser.add_argument('--trust-remote-code',
                            action='store_true',
240
                            help='Trust remote code from huggingface.')
241
        parser.add_argument('--download-dir',
242
                            type=nullable_str,
Zhuohan Li's avatar
Zhuohan Li committed
243
                            default=EngineArgs.download_dir,
244
                            help='Directory to download and load the weights, '
245
                            'default to the default cache dir of '
246
                            'huggingface.')
247
248
249
250
        parser.add_argument(
            '--load-format',
            type=str,
            default=EngineArgs.load_format,
251
            choices=[f.value for f in LoadFormat],
252
253
            help='The format of the model weights to load.\n\n'
            '* "auto" will try to load the weights in the safetensors format '
254
            'and fall back to the pytorch bin format if safetensors format '
255
256
257
258
259
260
261
262
            '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 '
263
            'CoreWeave. See the Tensorize vLLM Model script in the Examples '
264
265
266
            'section for more information.\n'
            '* "bitsandbytes" will load the weights using bitsandbytes '
            'quantization.\n')
267
268
269
270
271
272
273
        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 ')
274
275
276
277
        parser.add_argument(
            '--dtype',
            type=str,
            default=EngineArgs.dtype,
Woosuk Kwon's avatar
Woosuk Kwon committed
278
279
280
            choices=[
                'auto', 'half', 'float16', 'bfloat16', 'float', 'float32'
            ],
281
282
283
284
285
286
287
288
            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.')
289
290
291
        parser.add_argument(
            '--kv-cache-dtype',
            type=str,
292
            choices=['auto', 'fp8', 'fp8_e5m2', 'fp8_e4m3'],
293
            default=EngineArgs.kv_cache_dtype,
294
            help='Data type for kv cache storage. If "auto", will use model '
295
            'data type. CUDA 11.8+ supports fp8 (=fp8_e4m3) and fp8_e5m2. '
zhuwenwen's avatar
zhuwenwen committed
296
            'ROCm (hcu) supports fp8 (=fp8_e4m3)')
297
298
        parser.add_argument(
            '--quantization-param-path',
299
            type=nullable_str,
300
301
302
303
304
305
            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. '
            'FP8_E5M2 (without scaling) is only supported on cuda version'
zhuwenwen's avatar
zhuwenwen committed
306
            'greater than 11.8. On ROCm (hcu), FP8_E4M3 is instead '
307
            'supported for common inference criteria.')
308
309
        parser.add_argument('--max-model-len',
                            type=int,
310
                            default=EngineArgs.max_model_len,
311
312
                            help='Model context length. If unspecified, will '
                            'be automatically derived from the model config.')
313
314
315
316
317
318
        parser.add_argument(
            '--guided-decoding-backend',
            type=str,
            default='outlines',
            choices=['outlines', 'lm-format-enforcer'],
            help='Which engine will be used for guided decoding'
319
320
321
322
323
            ' (JSON schema / regex etc) by default. Currently support '
            'https://github.com/outlines-dev/outlines and '
            'https://github.com/noamgat/lm-format-enforcer.'
            ' Can be overridden per request via guided_decoding_backend'
            ' parameter.')
324
        # Parallel arguments
325
326
327
328
329
330
331
332
333
334
335
        parser.add_argument(
            '--distributed-executor-backend',
            choices=['ray', 'mp'],
            default=EngineArgs.distributed_executor_backend,
            help='Backend to use for distributed serving. When more than 1 GPU '
            'is used, will be automatically set to "ray" if installed '
            'or "mp" (multiprocessing) otherwise.')
        parser.add_argument(
            '--worker-use-ray',
            action='store_true',
            help='Deprecated, use --distributed-executor-backend=ray.')
336
337
338
        parser.add_argument('--pipeline-parallel-size',
                            '-pp',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
339
                            default=EngineArgs.pipeline_parallel_size,
340
                            help='Number of pipeline stages.')
341
342
343
        parser.add_argument('--tensor-parallel-size',
                            '-tp',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
344
                            default=EngineArgs.tensor_parallel_size,
345
                            help='Number of tensor parallel replicas.')
346
347
348
        parser.add_argument(
            '--max-parallel-loading-workers',
            type=int,
349
            default=EngineArgs.max_parallel_loading_workers,
350
            help='Load model sequentially in multiple batches, '
351
            'to avoid RAM OOM when using tensor '
352
            'parallel and large models.')
353
354
355
        parser.add_argument(
            '--ray-workers-use-nsight',
            action='store_true',
356
            help='If specified, use nsight to profile Ray workers.')
357
        # KV cache arguments
358
359
        parser.add_argument('--block-size',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
360
                            default=EngineArgs.block_size,
361
                            choices=[8, 16, 32],
362
                            help='Token block size for contiguous chunks of '
363
364
                            'tokens. This is ignored on neuron devices and '
                            'set to max-model-len')
365
366
367

        parser.add_argument('--enable-prefix-caching',
                            action='store_true',
368
                            help='Enables automatic prefix caching.')
369
370
371
372
        parser.add_argument('--disable-sliding-window',
                            action='store_true',
                            help='Disables sliding window, '
                            'capping to sliding window size')
373
374
        parser.add_argument('--use-v2-block-manager',
                            action='store_true',
375
                            help='Use BlockSpaceMangerV2.')
376
377
378
379
380
381
382
383
        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.')
384

385
386
387
        parser.add_argument('--seed',
                            type=int,
                            default=EngineArgs.seed,
388
                            help='Random seed for operations.')
389
        parser.add_argument('--swap-space',
390
                            type=float,
Zhuohan Li's avatar
Zhuohan Li committed
391
                            default=EngineArgs.swap_space,
392
                            help='CPU swap space size (GiB) per GPU.')
393
394
395
396
397
398
399
400
401
402
403
404
405
406
        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 '
            'a 34 GB GPU. Then you can load a 13B model with BF16 weight,'
            'which requires at least 26GB GPU memory. Note that this '
            'requires fast CPU-GPU interconnect, as part of the model is'
            'loaded from CPU memory to GPU memory on the fly in each '
            'model forward pass.')
407
408
409
410
        parser.add_argument(
            '--gpu-memory-utilization',
            type=float,
            default=EngineArgs.gpu_memory_utilization,
411
412
413
414
            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, '
            'will use the default value of 0.9.')
415
        parser.add_argument(
416
            '--num-gpu-blocks-override',
417
418
419
420
            type=int,
            default=None,
            help='If specified, ignore GPU profiling result and use this number'
            'of GPU blocks. Used for testing preemption.')
421
422
        parser.add_argument('--max-num-batched-tokens',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
423
                            default=EngineArgs.max_num_batched_tokens,
424
425
                            help='Maximum number of batched tokens per '
                            'iteration.')
426
427
        parser.add_argument('--max-num-seqs',
                            type=int,
Zhuohan Li's avatar
Zhuohan Li committed
428
                            default=EngineArgs.max_num_seqs,
429
                            help='Maximum number of sequences per iteration.')
430
431
432
433
        parser.add_argument(
            '--max-logprobs',
            type=int,
            default=EngineArgs.max_logprobs,
434
435
            help=('Max number of log probs to return logprobs is specified in'
                  ' SamplingParams.'))
436
437
        parser.add_argument('--disable-log-stats',
                            action='store_true',
438
                            help='Disable logging statistics.')
439
440
441
        # Quantization settings.
        parser.add_argument('--quantization',
                            '-q',
442
                            type=nullable_str,
443
                            choices=[*QUANTIZATION_METHODS, None],
444
                            default=EngineArgs.quantization,
445
446
447
448
449
450
                            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.')
451
452
453
454
455
        parser.add_argument('--rope-scaling',
                            default=None,
                            type=json.loads,
                            help='RoPE scaling configuration in JSON format. '
                            'For example, {"type":"dynamic","factor":2.0}')
456
457
458
459
460
461
        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.')
462
463
464
465
466
467
468
469
        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.')
        parser.add_argument('--max-context-len-to-capture',
                            type=int,
                            default=EngineArgs.max_context_len_to_capture,
470
                            help='Maximum context length covered by CUDA '
471
                            'graphs. When a sequence has context length '
472
                            'larger than this, we fall back to eager mode. '
473
                            '(DEPRECATED. Use --max-seq-len-to-capture instead'
474
                            ')')
475
        parser.add_argument('--max-seq-len-to-capture',
476
477
478
479
                            type=int,
                            default=EngineArgs.max_seq_len_to_capture,
                            help='Maximum sequence length covered by CUDA '
                            'graphs. When a sequence has context length '
480
481
482
483
                            '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.')
484
485
486
        parser.add_argument('--disable-custom-all-reduce',
                            action='store_true',
                            default=EngineArgs.disable_custom_all_reduce,
487
                            help='See ParallelConfig.')
488
489
490
491
492
493
494
495
496
497
498
499
500
        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',
501
                            type=nullable_str,
502
503
504
505
506
                            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.')
507
508
509
510
511
512
513
514
515
516
517
518
519
520

        # 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.'))
521
522
523
524
525
526
        parser.add_argument(
            '--mm-processor-kwargs',
            default=None,
            type=json.loads,
            help=('Overrides for the multimodal input mapping/processing,'
                  'e.g., image processor. For example: {"num_crops": 4}.'))
527

528
529
530
531
532
533
534
535
536
537
538
539
        # LoRA related configs
        parser.add_argument('--enable-lora',
                            action='store_true',
                            help='If True, enable handling of LoRA adapters.')
        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.')
540
541
542
543
544
545
546
547
        parser.add_argument('--merge-lora',
                            type=bool,
                            default=False,
                            help='If set to True, the weights of the base layer will be merged with the weights of Lora.')
        parser.add_argument('--lora-target-modules',
                            nargs='*',
                            default=None,
                            help='List of lora module name, If not specified, modules will be chosen according to the model architecture.')
548
549
550
551
552
553
554
555
556
557
558
559
560
561
        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,
            choices=['auto', 'float16', 'bfloat16', 'float32'],
            help=('Data type for LoRA. If auto, will default to '
                  'base model dtype.'))
562
563
564
565
566
567
568
569
570
571
572
        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.'))
573
574
575
576
577
578
579
        parser.add_argument(
            '--max-cpu-loras',
            type=int,
            default=EngineArgs.max_cpu_loras,
            help=('Maximum number of LoRAs to store in CPU memory. '
                  'Must be >= than max_num_seqs. '
                  'Defaults to max_num_seqs.'))
580
581
582
583
584
585
586
587
        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.'))
588
589
590
591
592
593
594
595
596
597
598
        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')
599
600
601
        parser.add_argument("--device",
                            type=str,
                            default=EngineArgs.device,
602
                            choices=DEVICE_OPTIONS,
603
                            help='Device type for vLLM execution.')
604
605
606
607
608
        parser.add_argument('--num-scheduler-steps',
                            type=int,
                            default=1,
                            help=('Maximum number of forward steps per '
                                  'scheduler call.'))
609

610
611
612
613
        parser.add_argument(
            '--multi-step-stream-outputs',
            action='store_true',
            help='If True, then multi-step will stream outputs for every step')
614
615
616
617
618
619
        parser.add_argument(
            '--scheduler-delay-factor',
            type=float,
            default=EngineArgs.scheduler_delay_factor,
            help='Apply a delay (of delay factor multiplied by previous'
            'prompt latency) before scheduling next prompt.')
620
621
        parser.add_argument(
            '--enable-chunked-prefill',
622
623
624
625
            action=StoreBoolean,
            default=EngineArgs.enable_chunked_prefill,
            nargs="?",
            const="True",
626
            help='If set, the prefill requests can be chunked based on the '
627
            'max_num_batched_tokens.')
628
629
630

        parser.add_argument(
            '--speculative-model',
631
            type=nullable_str,
632
            default=EngineArgs.speculative_model,
633
634
            help=
            'The name of the draft model to be used in speculative decoding.')
635
636
637
638
639
640
641
642
643
644
645
646
        # Quantization settings for speculative model.
        parser.add_argument(
            '--speculative-model-quantization',
            type=nullable_str,
            choices=[*QUANTIZATION_METHODS, None],
            default=EngineArgs.speculative_model_quantization,
            help='Method used to quantize the weights of speculative model.'
            '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.')
647
648
649
        parser.add_argument(
            '--num-speculative-tokens',
            type=int,
650
            default=EngineArgs.num_speculative_tokens,
651
            help='The number of speculative tokens to sample from '
652
            'the draft model in speculative decoding.')
653
654
655
656
657
658
        parser.add_argument(
            '--num-speculative-heads',
            type=int,
            default=EngineArgs.num_speculative_heads,
            help='The number of speculative heads to sample from '
                 'the draft model in speculative decoding.')
659
660
661
662
663
664
665
        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.')
666

667
668
        parser.add_argument(
            '--speculative-max-model-len',
669
            type=int,
670
671
672
673
674
            default=EngineArgs.speculative_max_model_len,
            help='The maximum sequence length supported by the '
            'draft model. Sequences over this length will skip '
            'speculation.')

675
676
677
678
679
680
681
        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.')

682
683
684
685
686
687
688
689
690
691
692
693
694
695
        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.')

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
        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')

728
729
        parser.add_argument(
            '--disable-logprobs-during-spec-decoding',
730
            action=StoreBoolean,
731
            default=EngineArgs.disable_logprobs_during_spec_decoding,
732
733
            nargs="?",
            const="True",
734
735
736
737
738
739
740
741
            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.')

742
        parser.add_argument('--model-loader-extra-config',
743
                            type=nullable_str,
744
745
746
747
748
749
                            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.')
750
751
752
753
754
755
756
757
        parser.add_argument(
            '--ignore-patterns',
            action="append",
            type=str,
            default=[],
            help="The pattern(s) to ignore when loading the model."
            "Default to 'original/**/*' to avoid repeated loading of llama's "
            "checkpoints.")
758
        parser.add_argument(
759
            '--preemption-mode',
760
761
            type=str,
            default=None,
762
763
764
            help='If \'recompute\', the engine performs preemption by '
            'recomputing; If \'swap\', the engine performs preemption by '
            'block swapping.')
765

766
767
768
769
770
771
772
773
774
775
776
777
778
779
        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 "
            "same as the `--model` argument. Noted that this name(s)"
            "will also be used in `model_name` tag content of "
            "prometheus metrics, if multiple names provided, metrics"
            "tag will take the first one.")
780
781
782
783
        parser.add_argument('--qlora-adapter-name-or-path',
                            type=str,
                            default=None,
                            help='Name or path of the QLoRA adapter.')
784
785
786
787
788
789

        parser.add_argument(
            '--otlp-traces-endpoint',
            type=str,
            default=None,
            help='Target URL to which OpenTelemetry traces will be sent.')
790
791
792
793
794
795
796
797
798
799
        parser.add_argument(
            '--collect-detailed-traces',
            type=str,
            default=None,
            help="Valid choices are " +
            ",".join(ALLOWED_DETAILED_TRACE_MODULES) +
            ". It makes sense to set this only if --otlp-traces-endpoint is"
            " 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.")
800

801
802
803
804
805
806
        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.")
807
808
809
810
811
812
813
814
815
816
        parser.add_argument(
            '--override-neuron-config',
            type=lambda configs: {
                str(key): value
                for key, value in
                (config.split(':') for config in configs.split(','))
            },
            default=None,
            help="override or set neuron device configuration.")

817
        return parser
818
819

    @classmethod
820
    def from_cli_args(cls, args: argparse.Namespace):
821
822
823
        # 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
824
825
        engine_args = cls(**{attr: getattr(args, attr) for attr in attrs})
        return engine_args
826

827
828
    def create_model_config(self) -> ModelConfig:
        return ModelConfig(
829
830
831
832
833
834
835
836
837
            model=self.model,
            tokenizer=self.tokenizer,
            tokenizer_mode=self.tokenizer_mode,
            trust_remote_code=self.trust_remote_code,
            dtype=self.dtype,
            seed=self.seed,
            revision=self.revision,
            code_revision=self.code_revision,
            rope_scaling=self.rope_scaling,
838
            rope_theta=self.rope_theta,
839
840
841
842
843
844
845
846
847
848
            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_context_len_to_capture=self.max_context_len_to_capture,
            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,
849
            served_model_name=self.served_model_name,
850
            limit_mm_per_prompt=self.limit_mm_per_prompt,
851
            use_async_output_proc=not self.disable_async_output_proc,
852
853
            override_neuron_config=self.override_neuron_config,
            config_format=self.config_format,
854
            mm_processor_kwargs=self.mm_processor_kwargs,
855
856
        )

857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
    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,
        )

    def create_engine_config(self) -> EngineConfig:
        # 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()

893
894
895
896
897
898
899
        if model_config.is_multimodal_model:
            if self.enable_prefix_caching:
                logger.warning(
                    "--enable-prefix-caching is currently not "
                    "supported for multimodal models and has been disabled.")
            self.enable_prefix_caching = False

900
        cache_config = CacheConfig(
901
902
            block_size=self.block_size if self.device != "neuron" else
            self.max_model_len,  # neuron needs block_size = max_model_len
903
904
905
906
907
            gpu_memory_utilization=self.gpu_memory_utilization,
            swap_space=self.swap_space,
            cache_dtype=self.kv_cache_dtype,
            num_gpu_blocks_override=self.num_gpu_blocks_override,
            sliding_window=model_config.get_sliding_window(),
908
909
910
            enable_prefix_caching=self.enable_prefix_caching,
            cpu_offload_gb=self.cpu_offload_gb,
        )
911
        parallel_config = ParallelConfig(
912
913
914
915
916
917
            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(
918
919
920
                self.tokenizer_pool_size,
                self.tokenizer_pool_type,
                self.tokenizer_pool_extra_config,
921
            ),
922
            ray_workers_use_nsight=self.ray_workers_use_nsight,
923
            distributed_executor_backend=self.distributed_executor_backend)
924

925
926
927
928
929
930
        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.
931
932
933
934

            # Chunked prefill is currently disabled for multimodal models by
            # default.
            if use_long_context and not model_config.is_multimodal_model:
935
936
937
938
                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
939
940
941
                has_seqlen_agnostic_layers = (
                    model_config.contains_seqlen_agnostic_layers(
                        parallel_config))
942
943
944
                if (is_gpu and not use_sliding_window and not use_spec_decode
                        and not self.enable_lora
                        and not self.enable_prompt_adapter
945
                        and not has_seqlen_agnostic_layers):
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
                    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)

963
964
965
966
967
968
        if self.num_scheduler_steps > 1 and not self.use_v2_block_manager:
            self.use_v2_block_manager = True
            logger.warning(
                "Enabled BlockSpaceManagerV2 because it is "
                "required for multi-step (--num-scheduler-steps > 1)")

969
970
971
972
973
        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,
974
975
            speculative_model_quantization = \
                self.speculative_model_quantization,
976
977
            speculative_draft_tensor_parallel_size = \
                self.speculative_draft_tensor_parallel_size,
978
            num_speculative_tokens=self.num_speculative_tokens,
979
980
            speculative_disable_by_batch_size=self.
            speculative_disable_by_batch_size,
981
982
983
            speculative_max_model_len=self.speculative_max_model_len,
            enable_chunked_prefill=self.enable_chunked_prefill,
            use_v2_block_manager=self.use_v2_block_manager,
984
            disable_log_stats=self.disable_log_stats,
985
986
            ngram_prompt_lookup_max=self.ngram_prompt_lookup_max,
            ngram_prompt_lookup_min=self.ngram_prompt_lookup_min,
987
988
989
990
991
992
            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,
993
            disable_logprobs=self.disable_logprobs_during_spec_decoding,
994
            num_speculative_heads=self.num_speculative_heads
995
996
        )

997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
        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)")
            if self.enable_chunked_prefill:
                raise ValueError("Chunked prefill is not supported with "
                                 "multi-step (--num-scheduler-steps > 1)")

        # 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

1013
        scheduler_config = SchedulerConfig(
1014
1015
1016
1017
            max_num_batched_tokens=self.max_num_batched_tokens,
            max_num_seqs=self.max_num_seqs,
            max_model_len=model_config.max_model_len,
            use_v2_block_manager=self.use_v2_block_manager,
1018
            num_lookahead_slots=num_lookahead_slots,
1019
1020
            delay_factor=self.scheduler_delay_factor,
            enable_chunked_prefill=self.enable_chunked_prefill,
1021
            embedding_mode=model_config.embedding_mode,
1022
            is_multimodal_model=model_config.is_multimodal_model,
1023
            preemption_mode=self.preemption_mode,
1024
            num_scheduler_steps=self.num_scheduler_steps,
1025
            multi_step_stream_outputs=self.multi_step_stream_outputs,
1026
1027
            send_delta_data=(envs.VLLM_USE_RAY_SPMD_WORKER
                             and parallel_config.use_ray),
1028
        )
1029
1030
1031
        lora_config = LoRAConfig(
            max_lora_rank=self.max_lora_rank,
            max_loras=self.max_loras,
1032
            fully_sharded_loras=self.fully_sharded_loras,
1033
            lora_extra_vocab_size=self.lora_extra_vocab_size,
1034
            long_lora_scaling_factors=self.long_lora_scaling_factors,
1035
1036
            lora_dtype=self.lora_dtype,
            max_cpu_loras=self.max_cpu_loras if self.max_cpu_loras
1037
1038
1039
            and self.max_cpu_loras > 0 else None,
            merge_lora=self.merge_lora,
            lora_target_modules=self.lora_target_modules) if self.enable_lora else None
1040

1041
1042
1043
1044
1045
1046
1047
        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

1048
        load_config = self.create_load_config()
1049

1050
1051
1052
1053
1054
        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

1055
1056
1057
        decoding_config = DecodingConfig(
            guided_decoding_backend=self.guided_decoding_backend)

1058
1059
1060
1061
1062
1063
1064
1065
        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}")
1066
        observability_config = ObservabilityConfig(
1067
1068
1069
1070
1071
1072
            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,
        )
1073

1074
        if (model_config.get_sliding_window() is not None
1075
1076
                and scheduler_config.chunked_prefill_enabled
                and not scheduler_config.use_v2_block_manager):
1077
            raise ValueError(
1078
1079
                "Chunked prefill is not supported with sliding window. "
                "Set --disable-sliding-window to disable sliding window.")
1080

1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
        return EngineConfig(
            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,
1092
            prompt_adapter_config=prompt_adapter_config,
1093
        )
1094
1095


1096
@dataclass
Zhuohan Li's avatar
Zhuohan Li committed
1097
class AsyncEngineArgs(EngineArgs):
Woosuk Kwon's avatar
Woosuk Kwon committed
1098
    """Arguments for asynchronous vLLM engine."""
1099
    disable_log_requests: bool = False
1100
1101

    @staticmethod
1102
1103
    def add_cli_args(parser: FlexibleArgumentParser,
                     async_args_only: bool = False) -> FlexibleArgumentParser:
1104
1105
        if not async_args_only:
            parser = EngineArgs.add_cli_args(parser)
1106
1107
        parser.add_argument('--disable-log-requests',
                            action='store_true',
1108
                            help='Disable logging requests.')
1109
        return parser
1110
1111


1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
class StoreBoolean(argparse.Action):

    def __call__(self, parser, namespace, values, option_string=None):
        if values.lower() == "true":
            setattr(namespace, self.dest, True)
        elif values.lower() == "false":
            setattr(namespace, self.dest, False)
        else:
            raise ValueError(f"Invalid boolean value: {values}. "
                             "Expected 'true' or 'false'.")


1124
1125
# These functions are used by sphinx to build the documentation
def _engine_args_parser():
1126
    return EngineArgs.add_cli_args(FlexibleArgumentParser())
1127
1128
1129


def _async_engine_args_parser():
1130
    return AsyncEngineArgs.add_cli_args(FlexibleArgumentParser(),
1131
                                        async_args_only=True)