From 4803181639b0aa1fb3a3df59f27a15fbbcee243c Mon Sep 17 00:00:00 2001 From: maang Date: Tue, 14 Jan 2025 22:45:06 +0800 Subject: [PATCH] Doc: Update `Engine Arguments` documents --- vllm/engine/arg_utils.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/vllm/engine/arg_utils.py b/vllm/engine/arg_utils.py index 0850bab6bb7e1..c31b206d6f60e 100644 --- a/vllm/engine/arg_utils.py +++ b/vllm/engine/arg_utils.py @@ -538,7 +538,7 @@ def add_cli_args(parser: FlexibleArgumentParser) -> FlexibleArgumentParser: default=None, type=json.loads, help='RoPE scaling configuration in JSON format. ' - 'For example, {"rope_type":"dynamic","factor":2.0}') + 'For example, ``{"rope_type":"dynamic","factor":2.0}``') parser.add_argument('--rope-theta', default=None, type=float, @@ -607,7 +607,7 @@ def add_cli_args(parser: FlexibleArgumentParser) -> FlexibleArgumentParser: default=None, type=json.loads, help=('Overrides for the multimodal input mapping/processing, ' - 'e.g., image processor. For example: {"num_crops": 4}.')) + 'e.g., image processor. For example: ``{"num_crops": 4}``.')) parser.add_argument( '--disable-mm-preprocessor-cache', action='store_true', @@ -908,13 +908,13 @@ def add_cli_args(parser: FlexibleArgumentParser) -> FlexibleArgumentParser: type=json.loads, default=None, help="Override or set neuron device configuration. " - "e.g. {\"cast_logits_dtype\": \"bloat16\"}.'") + "e.g. ``{\"cast_logits_dtype\": \"bloat16\"}``.") parser.add_argument( '--override-pooler-config', type=PoolerConfig.from_json, default=None, help="Override or set the pooling method for pooling models. " - "e.g. {\"pooling_type\": \"mean\", \"normalize\": false}.'") + "e.g. ``{\"pooling_type\": \"mean\", \"normalize\": false}``.") parser.add_argument('--compilation-config', '-O',