nemo_automodel.components.moe.megatron.token_dispatcher
nemo_automodel.components.moe.megatron.token_dispatcher
Module Contents
Classes
Functions
Data
API
Prepare HybridEP’s process-global buffer before pipeline traffic.
Identify the single HybridEP buffer owned by this process.
Return the immutable configuration served by the global buffer.
Return the EP-group maximum JIT capacity for this batch.
Initialize the group capacity when the upcoming pipeline shape grows.
Parameters:
Maximum number of tokens in the upcoming pipeline microbatch.
Runtime device used for group capacity exchange and initialization.
Raises:
ValueError: If the token capacity is not positive.RuntimeError: If the process-global resource signature conflicts or initialization fails.
Match HybridEP’s token-capacity floor and rounding for its JIT key.
Parameters:
Requested local token count.
Returns: int
Normalized token capacity used by HybridEP’s compiled runtime.
Flex token dispatcher supporting DeepEP, HybridEP, and UCCL-EP backends.
Initialize the routing map and probs to a unified format covering the TPxEP group. This design decouples the communication group from underlying model parallelism groups, such that the communication strategy of tokens can be agnostic of TP size and EP size.
Performs all-to-all communication to combine tokens after expert processing.
Post-processes the combined hidden states after all-to-all communication.
This method reshapes the combined hidden states to match the original input shape.
Pre-processes the hidden states before combining them after expert processing.
This method restores the hidden states to their original ordering before expert processing by using the communication manager’s restoration function.
Performs all-to-all communication to dispatch tokens across expert parallel ranks.
Post-processes the dispatched hidden states after all-to-all communication.
This method retrieves the permuted hidden states by experts, calculates the number of tokens per expert, and returns the processed data ready for expert processing.
Preprocesses the hidden states and routing information before dispatching tokens to experts. Args: hidden_states (torch.Tensor): Input hidden states to be processed num_local_tokens (int): Number of tokens to be processed probs (torch.Tensor): Routing probabilities for each token-expert pair
Returns:
Tuple containing:
Prepare hidden states and routing metadata for dispatch.
DeepEP consumes token_indices[T, K] and token_probs[T, K] directly. HybridEP
uses its established dense routing map by default. Compact routing can be enabled to
keep top-k indices for metadata communication while expanding probabilities to [T, E]
so the existing dense router-gradient layout is preserved.
Parameters:
Hidden states with shape […, hidden].
Number of tokens before expert-parallel dispatch.
Top-k routing probabilities with shape [tokens, top_k].
Expert indices with shape [tokens, top_k].
Returns: torch.Tensor
Flattened hidden states with shape [tokens, hidden] and routing probabilities with
Return model-owned initializers needed before a pipeline step.
Parameters:
Hidden dimension dispatched to experts.
Hidden-state data type used by the expert module.
Returns: tuple[HybridEPPipelineRuntimeInitializer, ...]
A HybridEP initializer for HybridEP dispatchers, otherwise an empty tuple.
Permutes tokens according to probs and dispatches them to experts.
This method implements the token permutation process in three steps:
- Preprocess the hidden states
- Perform all-to-all communication to dispatch tokens
- Post-process the dispatched tokens for expert processing
Permutes tokens according to probs and dispatches them to experts.
This method implements the token permutation process in three steps:
- Preprocess the hidden states
- Perform all-to-all communication to dispatch tokens
- Post-process the dispatched tokens for expert processing
Reverses the token permutation process to restore the original token order.
This method implements the token unpermutation process in three steps:
- Pre-process the hidden states to restore their original ordering
- Perform all-to-all communication to combine tokens
- Post-process the combined tokens to match the original input shape
Configuration for MoE token dispatch and combine backends.
Benchmark-only (mirrors BackendConfig.benchmark_static_routing, validated there): routing is forced-balanced with no noise, so every dispatch permutes the same token count. Persist num_permuted_tokens across dispatches to keep HybridEP on its non-blocking size path instead of waiting on a device-side count per microbatch.
Use asynchronous DeepEP/UCCL-EP dispatch/combine and communication-stream allocations.
Number of SMs to use for DeepEP backend.
Enable DeepEP for efficient token dispatching and combine in MoE models.
moe_expert_capacity_factor (float): The capacity factor for each expert, None means no token will be dropped. The default is None.
Backend for the flex token dispatcher. Options: ‘deepep’, ‘hybridep’, or ‘uccl_ep’.
HybridEP capacity mode (mirrors BackendConfig.dispatcher_capacity_factor): after one blocking calibration dispatch, size every later dispatch to the calibrated permuted row count times this factor and run it non-blocking. None keeps the blocking path.
Send compact top-k indices instead of a dense Boolean HybridEP routing map.
HybridEP (mirrors BackendConfig.dispatcher_equal_token_counts): every EP rank dispatches the same row count, so the per-dispatch pad-size all-reduce and its host sync are skipped.
Optional number of HybridEP dispatch permutation blocks.
Optional number of HybridEP combine unpermutation blocks.
Number of SMs to use for HybridEP dispatch and combine APIs.
Optional number of SMs used by HybridEP routing-metadata preprocessing.
Fuse HybridEP permutation with dispatch and unpermutation with combine.
Fuse token rearrangement ops during token dispatching.
Data type for routing and expert output weighted averaging. Using fp32 or fp64 can improve stability especially when the number of experts is large (e.g. finegrained-moe). None means no changes for dtype.
Number of tokens to pad to a multiple of for each expert.
Number of experts to route to for each token.
Share one communication manager instance across MoE layers for the configured backend.
Number of experts to use for MoE layer. When set, it replaces MLP with MoE layer. Set to None for no MoE.
Bases: _DispatchManager
A manager class to handle fused all-to-all communication processes for MoE models using DeepEP backend. See https://github.com/deepseek-ai/deepep for more details.
The workflow of the DeepEP dispatcher is: (1) setup_metadata(): Process routing map and probabilities to prepare dispatch metadata (2) dispatch():
- Use fused kernel to permute tokens and perform all-to-all communication in single step (3) get_permuted_hidden_states_by_instances():
- Convert routing map and probabilities to multihot format
- Permute tokens using fused kernel (4) get_restored_hidden_states_by_instances():
- Reverse permutation using fused kernel (5) combine():
- Reverse process using fused kernel to unpermute and perform all-to-all in single step
This implementation uses fused communication kernels (fused_dispatch/fused_combine) that combine permutation and communication operations for improved efficiency compared to separate permute+alltoall steps.
Converts a tensor of indices to a multihot vector.
Parameters:
[num_tokens, topk] token indices, where -1 means masked out.
[num_tokens, topk] token probabilities.
Returns:
Tuple[torch.Tensor, torch.Tensor]:
- routing_map: Multihot vector.
- probs: Multihot probabilities.
Reverse process using fused kernel to unpermute and perform all-to-all in single step
Dispatch the hidden_states
Get the number of tokens per expert.
- Convert routing map and probabilities to multihot format
- Permute tokens using fused kernel
Restore the hidden states to their original ordering before expert processing
Process routing map and probabilities to prepare dispatch metadata
A manager class to handle dispatch and combine processes for MoE models.
DispatcherManager handles token dispatching according to the routing_map of format [num_local_tokens, world_size, num_instances]. The routing_map is a 3D tensor where each element indicates whether a token should be sent to a specific rank.
num_instances is the maximum number of tokens instances dispatched into a target rank, it can be the number of local experts, or the size of sub_group.
Combine the hidden_states after expert processing.
Dispatch the hidden_states according to the routing_map.
Get the metadata of the dispatched hidden_states.
Get the permuted hidden states by instances.
Get the restored hidden states by instances.
Set up metadata of routing_map and probs.
Bases: _DispatchManager
A manager class to handle fused all-to-all communication processes for MoE models using HybridEP backend. See https://github.com/deepseek-ai/DeepEP/tree/hybrid-ep for more details.
The workflow of the HybridEP dispatcher is: (1) setup_metadata(): Process routing map and probabilities to prepare dispatch metadata (2) dispatch():
- Permute tokens for communication, perform all-to-all communication, and permute tokens for experts in single step (3) combine():
- Unpermute tokens for communication, perform all-to-all communication, and unpermute tokens for attention in single step
Turn the one blocking calibration dispatch into the capacity every later dispatch uses.
The blocking dispatch already brought tokens_per_expert to the host, so reading its sum is
free; the capacity is that count times hybridep_capacity_factor, rounded up to a multiple of
pad_multiple when one is set (HybridEP’s only requirement on the extent in non-blocking mode)
and otherwise to the 4-token alignment as slack, taken as the EP-group maximum once so every rank
allocates the same buffers.
Parameters:
[num_local_experts] integer tensor of routed rows per local expert, as
returned by the blocking calibration dispatch; its sum is read on the host here.
Device for the EP-group max all-reduce of the capacity.
Converts a tensor of indices to a multihot vector.
The num_permuted_tokens this dispatch hands to HybridEP, decided in one place.
None is the blocking path (HybridEP reads the count on the device and drains the compute
stream); a host value keeps the dispatch non-blocking. The static-routing pin is the first
dispatch’s count (a 0-d tensor); capacity mode passes the calibrated capacity (a host int)
once calibration has happened. Nothing is cached across dispatches otherwise: a stale value
would be reused under non-reentrant activation checkpointing.
Dispatch hidden states using compact top-k metadata when available.
Parameters:
Hidden states with shape [tokens, hidden].
Ignored because HybridEP does not expose asynchronous completion here.
Ignored because HybridEP owns its communication stream.
None (default) derives it from hybridep_capacity_factor; False
forces one blocking dispatch that neither uses nor calibrates the capacity (the
runtime warmup).
Returns: torch.Tensor
Dispatched hidden states with shape [dispatched_tokens, hidden].
Initialize HybridEP’s dispatch/combine kernels for a capacity without running a model stage.
HybridEP JIT-compiles dispatch and combine kernels on first use. Under pipeline parallelism, allowing that work to happen in the real schedule serializes the compile cost across PP stages while earlier stages have outstanding receives. Exercise the dispatcher directly so independent EP groups initialize concurrently before the PP schedule posts P2P work.
The synthetic tensors are local to the dispatcher and no model parameter
participates in autograd. Manager fields used by a real dispatch are
restored even if initialization fails. Capacity mode
(hybridep_capacity_factor) is suspended for the synthetic dispatch: its
capacity is calibrated from the first real batch, whose routing skew a
balanced synthetic batch cannot stand in for, so the factor and any
calibrated capacity are restored untouched.
Process routing map and probabilities to prepare dispatch metadata.
Convert from topk indices format to multihot routing_map format.
Bases: Module
Graphable conversion of top-k metadata for dense or compact HybridEP dispatch.
Convert top-k metadata while preserving the graph capture boundary.
Parameters:
Expert indices with shape [tokens, top_k]. Invalid slots contain -1.
Routing probabilities with shape [tokens, top_k].
Returns: torch.Tensor
Routing metadata and dense probabilities. In compact mode, the metadata aliases
Round count up to the next multiple of multiple.
Device-side guard: HybridEP truncates silently when the capacity is exceeded and sets
overflow_flag, the last handle item; fail loudly instead of training on dropped tokens.
Parameters:
HybridEP dispatch handle (tuple). Its last item is the one-element device
overflow_flag tensor, non-zero after a truncated dispatch. DeepEP keeps the flag last
precisely so callers read it as handle[-1] (the slot count changed at 10d4dd7, which
inserted num_of_valid_tokens before it).
Permuted-row capacity the dispatch buffers were sized to (quoted in the message).