parallel.py 29.3 KB
Newer Older
1
2
3
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project

4
import os
5
from collections.abc import Callable
6
from typing import TYPE_CHECKING, Any, Literal
7
8

import torch
9
from pydantic import Field, field_validator, model_validator
10
11
12
13
14
15
from torch.distributed import ProcessGroup, ReduceOp
from typing_extensions import Self

import vllm.envs as envs
from vllm.config.utils import config
from vllm.logger import init_logger
16
from vllm.model_executor.layers.batch_invariant import (
17
    vllm_is_batch_invariant,
18
)
19
from vllm.platforms import current_platform
20
from vllm.utils.network_utils import get_open_ports_list
21
from vllm.utils.torch_utils import cuda_device_count_stateless
22
23
24
25
26

if TYPE_CHECKING:
    from ray.runtime_env import RuntimeEnv
    from ray.util.placement_group import PlacementGroup

27
    from vllm.v1.executor import Executor
28
29
30
else:
    RuntimeEnv = Any
    PlacementGroup = Any
31
    Executor = Any
32
33
34

logger = init_logger(__name__)

35
ExpertPlacementStrategy = Literal["linear", "round_robin"]
36
DistributedExecutorBackend = Literal["ray", "mp", "uni", "external_launcher"]
37
DataParallelBackend = Literal["ray", "mp"]
Mercykid-bash's avatar
Mercykid-bash committed
38
EPLBPolicyOption = Literal["default"]
39
40
41
42
43
All2AllBackend = Literal[
    "naive",
    "pplx",
    "deepep_high_throughput",
    "deepep_low_latency",
44
    "mori",
45
46
47
    "allgather_reducescatter",
    "flashinfer_all2allv",
]
48
49


50
51
52
53
54
55
56
57
58
59
60
61
62
63
@config
class EPLBConfig:
    """Configuration for Expert Parallel Load Balancing (EP)."""

    window_size: int = 1000
    """Window size for expert load recording."""
    step_interval: int = 3000
    """
    Interval for rearranging experts in expert parallelism.

    Note that if this is greater than the EPLB window size, only the metrics
    of the last `lb_window_size` steps will be used for rearranging experts.
    """

64
    num_redundant_experts: int = Field(default=0, ge=0)
65
66
67
68
69
70
71
    """Number of redundant experts to use for expert parallelism."""

    log_balancedness: bool = False
    """
    Log the balancedness each step of expert parallelism.
    This is turned off by default since it will cause communication overhead.
    """
72
73
74
75
    log_balancedness_interval: int = 1
    """
    Interval for logging the balancedness.
    """
76
77
78
79
    use_async: bool = False
    """
    Whether to use non-blocking EPLB.
    """
80

Mercykid-bash's avatar
Mercykid-bash committed
81
82
83
    policy: EPLBPolicyOption = "default"
    """The policy type for expert parallel load balancing (EPLB)."""

84
85
86
87
88
89
90
91
    @model_validator(mode="after")
    def _validate_eplb_config(self) -> Self:
        if self.use_async and self.policy != "default":
            raise ValueError("Async EPLB is only supported with the default policy.")
        if self.log_balancedness and self.log_balancedness_interval <= 0:
            raise ValueError("log_balancedness_interval must be greater than 0.")
        return self

92

93
94
95
96
97
98
99
100
@config
class ParallelConfig:
    """Configuration for the distributed execution."""

    pipeline_parallel_size: int = 1
    """Number of pipeline parallel groups."""
    tensor_parallel_size: int = 1
    """Number of tensor parallel groups."""
101
102
    prefill_context_parallel_size: int = 1
    """Number of prefill context parallel groups."""
103
104
105
106
107
108
109
    data_parallel_size: int = 1
    """Number of data parallel groups. MoE layers will be sharded according to
    the product of the tensor parallel size and data parallel size."""
    data_parallel_size_local: int = 1
    """Number of local data parallel groups."""
    data_parallel_rank: int = 0
    """Rank of the data parallel group."""
110
    data_parallel_rank_local: int | None = None
111
112
113
114
115
116
117
118
    """Local rank of the data parallel group,
    set only in SPMD mode."""
    data_parallel_master_ip: str = "127.0.0.1"
    """IP of the data parallel master."""
    data_parallel_rpc_port: int = 29550
    """Port for data parallel messaging."""
    data_parallel_master_port: int = 29500
    """Port of the data parallel master."""
119
    data_parallel_backend: DataParallelBackend = "mp"
120
121
122
123
    """Backend to use for data parallel, either "mp" or "ray"."""
    data_parallel_external_lb: bool = False
    """Whether to use "external" DP LB mode. Applies only to online serving
    and when data_parallel_size > 0. This is useful for a "one-pod-per-rank"
co63oc's avatar
co63oc committed
124
    wide-EP setup in Kubernetes. Set implicitly when --data-parallel-rank
125
126
127
128
129
130
131
132
    is provided explicitly to vllm serve."""
    data_parallel_hybrid_lb: bool = False
    """Whether to use "hybrid" DP LB mode. Applies only to online serving
    and when data_parallel_size > 0. Enables running an AsyncLLM
    and API server on a "per-node" basis where vLLM load balances
    between local data parallel ranks, but an external LB balances
    between vLLM nodes/replicas. Set explicitly in conjunction with
    --data-parallel-start-rank."""
133
134
    is_moe_model: bool | None = None
    """Whether the deployed model is MoE (if known)."""
135
136
137
138
    enable_expert_parallel: bool = False
    """Use expert parallelism instead of tensor parallelism for MoE layers."""
    enable_eplb: bool = False
    """Enable expert parallelism load balancing for MoE layers."""
139
    eplb_config: EPLBConfig = Field(default_factory=EPLBConfig)
140
    """Expert parallelism configuration."""
141
142
143
144
145
146
147
148
149
    expert_placement_strategy: ExpertPlacementStrategy = "linear"
    """The expert placement strategy for MoE layers:\n
    - "linear": Experts are placed in a contiguous manner. For example, with 4
      experts and 2 ranks, rank 0 will have experts [0, 1] and rank 1 will have
      experts [2, 3].\n
    - "round_robin": Experts are placed in a round-robin manner. For example,
      with 4 experts and 2 ranks, rank 0 will have experts [0, 2] and rank 1
      will have experts [1, 3]. This strategy can help improve load balancing
      for grouped expert models with no redundant experts."""
150
151
152
153
154
155
156
    all2all_backend: All2AllBackend = "allgather_reducescatter"
    """All2All backend for MoE expert parallel communication. Available options:

    - "naive": Naive all2all implementation using broadcasts\n
    - "allgather_reducescatter": All2all based on allgather and reducescatter\n
    - "deepep_high_throughput": Use deepep high-throughput kernels\n
    - "deepep_low_latency": Use deepep low-latency kernels\n
157
    - "mori": Use mori kernels\n
158
    - "flashinfer_all2allv": Use flashinfer alltoallv kernels for mnnvl"""
159

160
    max_parallel_loading_workers: int | None = None
161
162
163
164
165
166
167
    """Maximum number of parallel loading workers when loading model
    sequentially in multiple batches. To avoid RAM OOM when using tensor
    parallel and large models."""

    disable_custom_all_reduce: bool = False
    """Disable the custom all-reduce kernel and fall back to NCCL."""

168
    enable_dbo: bool = False
169
    """Enable dual batch overlap for the model executor."""
170
171
    ubatch_size: int = 0
    """Number of ubatch size."""
172
173

    dbo_decode_token_threshold: int = 32
174
175
176
177
178
179
180
181
182
    """The threshold for dual batch overlap for batches only containing decodes.
    If the number of tokens in the request is greater than this threshold,
    microbatching will be used. Otherwise, the request will be processed in a
    single batch."""
    dbo_prefill_token_threshold: int = 512  # TODO(lucas): tune
    """The threshold for dual batch overlap for batches that contain one or more
    prefills. If the number of tokens in the request is greater than this
    threshold, microbatching will be used. Otherwise, the request will be
    processed in a single batch."""
183

184
    disable_nccl_for_dp_synchronization: bool | None = Field(default=None)
185
    """Forces the dp synchronization logic in vllm/v1/worker/dp_utils.py 
186
187
188
189
    to use Gloo instead of NCCL for its all reduce.

    Defaults to True when async scheduling is enabled, False otherwise.
    """
190

191
192
193
    ray_workers_use_nsight: bool = False
    """Whether to profile Ray workers with nsight, see https://docs.ray.io/en/latest/ray-observability/user-guides/profiling.html#profiling-nsight-profiler."""

194
    ray_runtime_env: RuntimeEnv | None = None
195
196
    """Ray runtime environment to pass to distributed workers."""

197
    placement_group: PlacementGroup | None = None
198
199
    """ray distributed model workers placement group."""

200
    distributed_executor_backend: (
201
        str | DistributedExecutorBackend | type[Executor] | None
202
    ) = None
203
204
205
206
207
208
209
210
    """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, an error will be raised. To use "mp"
    you must also set nnodes, and to use "ray" you must manually set
    distributed_executor_backend to "ray".

    Note that tpu only support Ray for distributed inference."""
211
212
213
214
215
216
217
218
219
220
221
222

    worker_cls: str = "auto"
    """The full name of the worker class to use. If "auto", the worker class
    will be determined based on the platform."""
    sd_worker_cls: str = "auto"
    """The full name of the worker class to use for speculative decoding.
    If "auto", the worker class will be determined based on the platform."""
    worker_extension_cls: str = ""
    """The full name of the worker extension class to use. The worker extension
    class is dynamically inherited by the worker class. This is used to inject
    new attributes and methods to the worker class for use in collective_rpc
    calls."""
223
224
225
226
227
228
229
230
231
232
233
234
    master_addr: str = "127.0.0.1"
    """distributed master address for multi-node distributed 
    inference when distributed_executor_backend is mp."""
    master_port: int = 29501
    """distributed master port for multi-node distributed 
    inference when distributed_executor_backend is mp."""
    node_rank: int = 0
    """distributed node rank for multi-node distributed 
    inference when distributed_executor_backend is mp."""
    nnodes: int = 1
    """num of nodes for multi-node distributed 
    inference when distributed_executor_backend is mp."""
235

236
    world_size: int = Field(init=False)
237
238
239
240
241
    """world_size is TPxPP, it affects the number of workers we create."""

    rank: int = 0
    """Global rank in distributed setup."""

242
    _data_parallel_master_port_list: list[int] = Field(default_factory=list)
243
244
245
246
    """List of open port auto-queried for data parallel messaging.
    Set to be private as it's not intended to be configured by users.
    """

247
248
249
250
251
    decode_context_parallel_size: int = 1
    """Number of decode context parallel groups, because the world size does
    not change by dcp, it simply reuse the GPUs of TP group, and tp_size
    needs to be divisible by dcp_size."""

252
    dcp_kv_cache_interleave_size: int = 1
253
254
255
256
257
258
259
260
261
    """
    Interleave size of kv_cache storage while using DCP.
    dcp_kv_cache_interleave_size has been replaced by cp_kv_cache_interleave_size,
    and will be deprecated when PCP is fully supported.

    """
    cp_kv_cache_interleave_size: int = 1
    """Interleave size of kv_cache storage while using DCP or PCP.
    For `total_cp_rank = pcp_rank * dcp_world_size + dcp_rank`,
262
        and `total_cp_world_size = pcp_world_size * dcp_world_size`.
263
    store interleave_size tokens on total_cp_rank i,
264
    then store next interleave_size tokens on total_cp_rank i+1.
265
266
267
268
269
270
271
    Interleave_size=1: token-level alignment, where token `i` is stored on
        total_cp_rank `i % total_cp_world_size`.
    Interleave_size=block_size: block-level alignment, where tokens are
        first populated to the preceding ranks. Tokens are then stored
        in (rank i+1, block j) only after (rank i, block j) is fully occupied.
    Block_size should be greater than or equal to cp_kv_cache_interleave_size.
    Block_size should be divisible by cp_kv_cache_interleave_size.
272
273
    """

274
275
276
277
    data_parallel_index: int = Field(init=False)
    """Equal to the data parallel rank but not used for torch process groups
    and not overridden for dense models."""

278
    _api_process_count: int = Field(default=1, gt=0)
279
280
281
282
283
284
285
286
    """
    The number of API processes initialized.

    Note:
        This is an internal config that is only valid for and
        should only be set by API server scale-out.
    """

287
    _api_process_rank: int = Field(default=0, ge=-1)
288
289
290
291
292
293
294
295
296
    """
    The rank of this API process, or `-1` for engine core processes
    under API server scale-out.

    Note:
        This is an internal config that is only valid for and
        should only be set by API server scale-out.
    """

297
298
299
300
301
302
    @field_validator("disable_nccl_for_dp_synchronization", mode="wrap")
    @classmethod
    def _skip_none_validation(cls, value: Any, handler: Callable) -> Any:
        """Skip validation if the value is `None` when initialisation is delayed."""
        return None if value is None else handler(value)

303
304
305
306
307
308
309
310
311
    @model_validator(mode="after")
    def _validate_parallel_config(self) -> Self:
        if self._api_process_rank >= self._api_process_count:
            raise ValueError(
                "Invalid value of `_api_process_rank`. "
                f"Expected to be `-1` or `[0, {self._api_process_count})`, "
                f"but found: {self._api_process_rank}"
            )

312
313
314
315
316
317
318
        if self.all2all_backend == "pplx":
            logger.warning(
                "The 'pplx' all2all backend has been removed. "
                "Falling back to 'allgather_reducescatter'."
            )
            self.all2all_backend = "allgather_reducescatter"

319
320
321
322
323
324
325
326
327
328
329
330
        if self.data_parallel_size_local > self.data_parallel_size:
            raise ValueError(
                f"data_parallel_size_local ({self.data_parallel_size_local}) "
                f"must be <= data_parallel_size ({self.data_parallel_size})"
            )

        if self.data_parallel_size <= 1 and self.data_parallel_external_lb:
            raise ValueError(
                "data_parallel_external_lb can only be set when data_parallel_size > 1"
            )

        if self.enable_eplb:
331
            if not current_platform.is_cuda_alike():
332
333
                raise ValueError(
                    "Expert parallelism load balancing is only supported on "
334
                    "CUDA devices or ROCm devices now."
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
                )
            if not self.enable_expert_parallel:
                raise ValueError("enable_expert_parallel must be True to use EPLB.")
            if self.tensor_parallel_size * self.data_parallel_size <= 1:
                raise ValueError(
                    "EPLB requires tensor_parallel_size or data_parallel_size "
                    f"to be greater than 1, but got "
                    f"TP={self.tensor_parallel_size},DP={self.data_parallel_size}."
                )
        else:
            if self.eplb_config.num_redundant_experts != 0:
                raise ValueError(
                    "num_redundant_experts is set to "
                    f"{self.eplb_config.num_redundant_experts} but EPLB is not "
                    "enabled. Either enable EPLB or unset "
                    "num_redundant_experts."
                )

353
354
355
356
357
358
359
360
361
362
363
        # Note(hc): In the current implementation of decode context
        # parallel(DCP), tp_size needs to be divisible by dcp_size,
        # because the world size does not change by dcp, it simply
        # reuses the GPUs of TP group, and split one TP group into
        # tp_size//dcp_size DCP groups.
        if self.tensor_parallel_size % self.decode_context_parallel_size != 0:
            raise ValueError(
                f"tp_size={self.tensor_parallel_size} must be divisible by"
                f"dcp_size={self.decode_context_parallel_size}."
            )

364
365
        return self

366
367
368
369
370
371
    @property
    def world_size_across_dp(self) -> int:
        """world_size_across_dp is TPxPPxDP, it is the size of the world
        including data parallelism."""
        return self.world_size * self.data_parallel_size

372
373
374
375
376
377
378
379
    @property
    def use_ubatching(self) -> bool:
        return self.enable_dbo or self.ubatch_size > 1

    @property
    def num_ubatches(self) -> int:
        return 2 if self.enable_dbo else self.ubatch_size

380
381
382
383
384
385
386
387
    @property
    def local_engines_only(self) -> bool:
        """
        Client manages local+remote EngineCores in pure internal LB case.
        Client manages local EngineCores in hybrid and external LB case.
        """
        return self.data_parallel_external_lb or self.data_parallel_hybrid_lb

388
389
390
391
392
393
    def get_next_dp_init_port(self) -> int:
        """
        We might need to initialize process groups in multiple
        processes that is related to data parallelism,
        e.g. both in the worker and in the engine, which
        can live in different processes. To avoid port conflicts, we
394
395
        pop a new port from the prepared port list each time we need to
        initialize a new process group related to data parallelism.
396
        """
397
398
399
400
401
402
        if self._data_parallel_master_port_list:
            answer = self._data_parallel_master_port_list.pop()
        else:
            answer = self.data_parallel_master_port
            self.data_parallel_master_port += 1

403
404
405
406
407
408
409
410
411
412
413
414
415
        return answer

    def stateless_init_dp_group(self) -> ProcessGroup:
        # NOTE: In high-concurrency scenarios multiple processes
        # can pick the same (currently free) port through a race
        # condition when calling `get_open_port()`. When the first
        # process binds the port the others will subsequently fail
        # with `torch.distributed.DistNetworkError: EADDRINUSE`.
        # To make the initialization more robust we retry a few times
        # with a fresh port whenever this specific error is observed.
        from torch.distributed import DistNetworkError

        from vllm.distributed.utils import (
416
417
            stateless_init_torch_distributed_process_group,
        )
418
419

        max_retries = 5
420
        last_exc: Exception | None = None
421
422
423
424
425
426
427
428
        for _ in range(max_retries):
            try:
                # use gloo since the engine process might not have cuda device
                return stateless_init_torch_distributed_process_group(
                    self.data_parallel_master_ip,
                    self.get_next_dp_init_port(),
                    self.data_parallel_rank,
                    self.data_parallel_size,
429
                    backend=current_platform.dist_backend,
430
                )
431
432
433
            except DistNetworkError as e:
                # We only want to retry when the root cause is EADDRINUSE.
                if "EADDRINUSE" in str(e):
434
                    logger.warning("Address already in use. Retrying with a new port.")
435
436
437
438
439
440
441
442
                    last_exc = e
                    continue  # try again with a new port
                raise e

        # If we get here all retries have failed.
        assert last_exc is not None
        raise last_exc

443
444
445
446
447
448
449
450
451
452
    # The all_reduce at the end of attention (during o_proj) means that
    # inputs are replicated across each rank of the tensor parallel group.
    # If using expert-parallelism with DeepEP All2All ops, replicated
    # tokens results in useless duplicate computation and communication.
    #
    # In this case, ensure the input to the experts is sequence parallel
    # to avoid the excess work.
    #
    @property
    def use_sequence_parallel_moe(self) -> bool:
453
        return (
454
            self.all2all_backend
455
456
457
458
459
            in (
                "allgather_reducescatter",
                "naive",
                "deepep_high_throughput",
                "deepep_low_latency",
460
                "mori",
461
462
463
464
465
            )
            and self.enable_expert_parallel
            and self.tensor_parallel_size > 1
            and self.data_parallel_size > 1
        )
466

467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
    @property
    def node_rank_within_dp(self) -> int:
        return self.node_rank % self.nnodes_within_dp

    @property
    def nnodes_within_dp(self) -> int:
        if self.nnodes == 1:
            return 1
        data_parallel_node_size = (
            self.data_parallel_size // self.data_parallel_size_local
        )
        return self.nnodes // data_parallel_node_size

    @property
    def local_world_size(self) -> int:
        return self.world_size // self.nnodes_within_dp

484
    @staticmethod
485
486
    def has_unfinished_dp(dp_group: ProcessGroup, has_unfinished: bool) -> bool:
        tensor = torch.tensor([has_unfinished], dtype=torch.int32, device="cpu")
487
488
489
490
491
492
493
494
495
        # dp rank 0: has_unfinished_seqs=True
        # dp rank 1: has_unfinished_seqs=False
        # aggregated: has_unfinished_seqs=True
        # so this is an OR operation, i.e. MAX in integers
        torch.distributed.all_reduce(tensor, op=ReduceOp.MAX, group=dp_group)
        aggregated_has_unfinished = bool(tensor.item())
        return aggregated_has_unfinished

    @staticmethod
496
    def sync_kv_cache_memory_size(dp_group: ProcessGroup, kv_cache_memory: int) -> int:
497
498
        if kv_cache_memory == -1:
            kv_cache_memory = torch.iinfo(torch.int64).max
499
        tensor = torch.tensor([kv_cache_memory], dtype=torch.int64, device="cpu")
500
501
502
503
504
505
506
507
508
509
510
511
        # we cannot use broadcast for stateless dp group since it depends
        # on global rank
        torch.distributed.all_reduce(tensor, op=ReduceOp.MIN, group=dp_group)
        return tensor.item()

    def compute_hash(self):
        """
        Provide a hash that uniquely identifies all the configs
        that affect the structure of the computation
        graph from input ids/embeddings to the final hidden states,
        excluding anything before input ids/embeddings and after
        the final hidden states.
512
513
514

        This hash is also used for DP worker configuration validation
        to prevent hangs from mismatched collective communication patterns.
515
        """
516
517
518
519
        ignored_factors = {
            # Derived/runtime topology, networking, or launch details
            "data_parallel_rank",
            "data_parallel_rank_local",
520
            "data_parallel_size_local",
521
            "data_parallel_index",
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
            "data_parallel_backend",
            "data_parallel_external_lb",
            "data_parallel_hybrid_lb",
            "data_parallel_master_ip",
            "data_parallel_master_port",
            "_data_parallel_master_port_list",
            "data_parallel_rpc_port",
            "rank",
            "master_addr",
            "master_port",
            "node_rank",
            "nnodes",
            "max_parallel_loading_workers",
            "disable_custom_all_reduce",
            "ray_workers_use_nsight",
            "ray_runtime_env",
            "placement_group",
            "distributed_executor_backend",
            "worker_cls",
            "sd_worker_cls",
            "worker_extension_cls",
            "_api_process_count",
            "_api_process_rank",
        }

        from vllm.config.utils import get_hash_factors, hash_factors

        factors = get_hash_factors(self, ignored_factors)
        return hash_factors(factors)
551
552

    def __post_init__(self) -> None:
553
        # Continue with the rest of the initialization
554
555
556
557
558
        self.world_size = (
            self.pipeline_parallel_size
            * self.tensor_parallel_size
            * self.prefill_context_parallel_size
        )
559

560
561
562
563
        if self.distributed_executor_backend == "external_launcher":
            logger.info("Using external launcher for distributed inference.")
            self.world_size *= self.data_parallel_size

564
565
        if self.data_parallel_size > 1 or self.data_parallel_size_local == 0:
            # Data parallel was specified in the engine args.
566
567
568
            if self.distributed_executor_backend == "external_launcher":
                # For external launcher,
                # we need to set the data parallel rank automatically
569
570
571
572
573
574
575
                self.data_parallel_rank = int(os.environ["RANK"]) // (
                    self.world_size // self.data_parallel_size
                )
                logger.info(
                    "Set data_parallel_rank to %d automatically.",
                    self.data_parallel_rank,
                )
576
577
            if not self._data_parallel_master_port_list:
                self._data_parallel_master_port_list = get_open_ports_list(5)
578
            self.data_parallel_master_port = self._data_parallel_master_port_list.pop()
579
580
581
582

            if not (0 <= self.data_parallel_rank < self.data_parallel_size):
                raise ValueError(
                    f"data_parallel_rank ({self.data_parallel_rank})"
583
584
                    f" must be in the range [0, {self.data_parallel_size})"
                )
585
586
587
588
589
590
591
592
        else:
            # Otherwise fall back to env vars (e.g. for offline SPMD case).
            self.data_parallel_size = envs.VLLM_DP_SIZE
            self.data_parallel_rank = envs.VLLM_DP_RANK
            self.data_parallel_rank_local = envs.VLLM_DP_RANK_LOCAL
            self.data_parallel_master_ip = envs.VLLM_DP_MASTER_IP
            self.data_parallel_master_port = envs.VLLM_DP_MASTER_PORT

593
594
595
596
597
598
599
600
            if self.data_parallel_size > 1 and self.is_moe_model is False:
                raise ValueError(
                    "Offline data parallel mode is not supported/useful"
                    " for dense models."
                )

        self.data_parallel_index = self.data_parallel_rank

601
602
603
604
605
606
607
608
        if self.distributed_executor_backend == "external_launcher":
            os.environ["VLLM_ENABLE_V1_MULTIPROCESSING"] = "0"
            logger.info("Disabling V1 multiprocessing for external launcher.")

        if self.distributed_executor_backend is None and self.world_size > 1:
            # We use multiprocessing by default if world_size fits on the
            # current node and we aren't in a ray placement group.

609
            from vllm.v1.executor import ray_utils
610

611
612
            backend: DistributedExecutorBackend = "mp"
            ray_found = ray_utils.ray_is_available()
613
            if current_platform.is_tpu() and envs.VLLM_XLA_USE_SPMD:
614
                backend = "uni"
615
616
            elif current_platform.is_cuda() and self.nnodes > 1:
                backend = "mp"
617
618
619
620
            elif (
                current_platform.is_cuda()
                and cuda_device_count_stateless() < self.world_size
            ):
621
622
                gpu_count = cuda_device_count_stateless()
                raise ValueError(
623
624
625
626
627
                    f"World size ({self.world_size}) is larger than the number of "
                    f"available GPUs ({gpu_count}) in this node. If this is "
                    "intentional and you are using:\n"
                    "- ray, set '--distributed-executor-backend ray'.\n"
                    "- multiprocessing, set '--nnodes' appropriately."
628
                )
629
            elif self.data_parallel_backend == "ray":
630
631
632
633
                logger.info(
                    "Using ray distributed inference because "
                    "data_parallel_backend is ray"
                )
634
635
636
637
638
639
                backend = "ray"
            elif ray_found:
                if self.placement_group:
                    backend = "ray"
                else:
                    from ray import is_initialized as ray_is_initialized
640

641
642
                    if ray_is_initialized():
                        from ray.util import get_current_placement_group
643

644
645
646
                        if get_current_placement_group():
                            backend = "ray"
            self.distributed_executor_backend = backend
647
            logger.debug("Defaulting to use %s for distributed inference", backend)
648
649
650
651

        if self.distributed_executor_backend is None and self.world_size == 1:
            self.distributed_executor_backend = "uni"

652
653
654
655
656
        if self.max_parallel_loading_workers is not None:
            logger.warning(
                "max_parallel_loading_workers is currently "
                "not supported and will be ignored."
            )
657
658
659
660
661
        allowed_backends = ("mp", "uni", "external_launcher")
        if (
            self.distributed_executor_backend not in allowed_backends
            and self.nnodes > 1
        ):
662
            raise ValueError(
663
                "nnodes > 1 can only be set when distributed executor "
664
                "backend is mp, uni or external_launcher."
665
            )
666

667
668
669
670
    @property
    def use_ray(self) -> bool:
        return self.distributed_executor_backend == "ray" or (
            isinstance(self.distributed_executor_backend, type)
671
672
            and getattr(self.distributed_executor_backend, "uses_ray", False)
        )
673

674
    @model_validator(mode="after")
675
676
    def _verify_args(self) -> Self:
        # Lazy import to avoid circular import
677
        from vllm.v1.executor import Executor
678
679

        # Enable batch invariance settings if requested
680
        if vllm_is_batch_invariant():
681
            self.disable_custom_all_reduce = True
682
683
684
685
686
687

        if (
            self.distributed_executor_backend is not None
            and not isinstance(self.distributed_executor_backend, str)
            and not (
                isinstance(self.distributed_executor_backend, type)
688
                and issubclass(self.distributed_executor_backend, Executor)
689
690
            )
        ):
691
692
693
            raise ValueError(
                "Unrecognized distributed executor backend "
                f"{self.distributed_executor_backend}. Supported "
694
                "values are 'ray', 'mp' 'uni', 'external_launcher', "
695
                " custom Executor subclass or its import path."
696
            )
697
        if self.use_ray:
698
            from vllm.v1.executor import ray_utils
699

700
701
702
703
704
705
            ray_utils.assert_ray_available()

        if not current_platform.use_custom_allreduce():
            self.disable_custom_all_reduce = True
            logger.debug(
                "Disabled the custom all-reduce kernel because it is not "
706
707
                "supported on current platform."
            )
708
709
710
711
712
        if self.nnodes > 1:
            self.disable_custom_all_reduce = True
            logger.debug(
                "Disabled the custom all-reduce since we are running on multi-node."
            )
713
        if self.ray_workers_use_nsight and not self.use_ray:
714
715
716
            raise ValueError(
                "Unable to use nsight profiling unless workers run with Ray."
            )
717
718

        return self