eagle.py 56.6 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4
import ast
from dataclasses import replace
5
from importlib.util import find_spec
6

7
import numpy as np
8
9
10
import torch
import torch.nn as nn

11
from vllm.config import (
12
    CompilationMode,
13
14
15
16
    CUDAGraphMode,
    VllmConfig,
    get_layers_from_vllm_config,
)
17
from vllm.distributed.parallel_state import get_pp_group
18
from vllm.forward_context import set_forward_context
19
from vllm.logger import init_logger
20
from vllm.model_executor.layers.attention_layer_base import AttentionLayerBase
21
from vllm.model_executor.model_loader import get_model
22
from vllm.model_executor.models import supports_multimodal
23
from vllm.model_executor.models.deepseek_v2 import DeepseekV32IndexerCache
24
from vllm.model_executor.models.llama_eagle3 import Eagle3LlamaForCausalLM
25
from vllm.multimodal import MULTIMODAL_REGISTRY
26
from vllm.platforms import current_platform
27
from vllm.utils.platform_utils import is_pin_memory_available
28
from vllm.v1.attention.backends.flash_attn import FlashAttentionMetadata
29
30
31
32
from vllm.v1.attention.backends.tree_attn import (
    TreeAttentionMetadata,
    TreeAttentionMetadataBuilder,
)
33
from vllm.v1.attention.backends.triton_attn import TritonAttentionMetadata
34
35
36
37
from vllm.v1.attention.backends.utils import (
    AttentionMetadataBuilder,
    CommonAttentionMetadata,
)
38
from vllm.v1.kv_cache_interface import KVCacheConfig
39
from vllm.v1.sample.metadata import SamplingMetadata
40
from vllm.v1.sample.sampler import _SAMPLING_EPS
41
42
from vllm.v1.spec_decode.metadata import SpecDecodeMetadata
from vllm.v1.utils import CpuGpuBuffer
Rémi Delacourt's avatar
Rémi Delacourt committed
43
from vllm.v1.worker.dp_utils import coordinate_batch_across_dp
44
from vllm.v1.worker.gpu_input_batch import CachedRequestState, InputBatch
45

46
47
logger = init_logger(__name__)

48
49
PADDING_SLOT_ID = -1

50
51
52
53
54
55

class EagleProposer:
    def __init__(
        self,
        vllm_config: VllmConfig,
        device: torch.device,
Jiayi Yao's avatar
Jiayi Yao committed
56
        runner=None,
57
58
    ):
        self.vllm_config = vllm_config
59
        self.speculative_config = vllm_config.speculative_config
60
        assert self.speculative_config is not None
61
62
        self.draft_model_config = self.speculative_config.draft_model_config
        self.method = self.speculative_config.method
63

Jiayi Yao's avatar
Jiayi Yao committed
64
        self.runner = runner
65
        self.device = device
66
        self.dtype = vllm_config.model_config.dtype
67
68
        self.max_model_len = vllm_config.model_config.max_model_len
        self.block_size = vllm_config.cache_config.block_size
Rémi Delacourt's avatar
Rémi Delacourt committed
69
        self.dp_rank = vllm_config.parallel_config.data_parallel_rank
70
71
        self.num_speculative_tokens = self.speculative_config.num_speculative_tokens
        self.max_num_tokens = vllm_config.scheduler_config.max_num_batched_tokens
72
        self.token_arange_np = np.arange(self.max_num_tokens)
73
74
75
76
        # We need to get the hidden size from the draft model config because
        # the draft model's hidden size can be different from the target model's
        # hidden size (e.g., Llama 3.3 70B).
        self.hidden_size = self.draft_model_config.get_hidden_size()
77

78
79
80
        # Multi-modal data support
        self.mm_registry = MULTIMODAL_REGISTRY
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
81
82
            vllm_config.model_config
        )
83

84
85
        self.attn_metadata_builder: AttentionMetadataBuilder | None = None
        self.draft_indexer_metadata_builder: AttentionMetadataBuilder | None = None
86
87
        self.attn_layer_names: list[str] = []
        self.indexer_layer_names: list[str] = []
88
89
90
        self.eagle3_use_aux_hidden_state: bool = (
            self._get_eagle3_use_aux_hidden_state_from_config()
        )
91

92
93
        self.use_cuda_graph = False

94
95
96
        self.compilation_config = self.vllm_config.compilation_config
        if self.compilation_config.mode == CompilationMode.VLLM_COMPILE:
            cudagraph_mode = self.compilation_config.cudagraph_mode
97
98
99
100
101
102
103
104
105
106
107
108
109
110
            if cudagraph_mode != CUDAGraphMode.NONE and not cudagraph_mode.has_mode(
                CUDAGraphMode.PIECEWISE
            ):
                logger.warning(
                    "Currently the eagle proposer only supports cudagraph_mode "
                    "PIECEWISE, if you want the drafter to use cuda graphs, "
                    "please set compilation_config.cudagraph_mode to PIECEWISE "
                    "or FULL_AND_PIECEWISE"
                )
            self.use_cuda_graph = (
                cudagraph_mode.has_mode(CUDAGraphMode.PIECEWISE)
                and not self.speculative_config.enforce_eager
            )

111
        # persistent buffers for cuda graph
112
113
114
        self.input_ids = torch.zeros(
            self.max_num_tokens, dtype=torch.int32, device=device
        )
115
116
        self.uses_mrope = self.vllm_config.model_config.uses_mrope
        if self.uses_mrope:
117
118
119
120
121
122
123
124
125
126
            # NOTE: `mrope_positions` is implemented with one additional dummy
            # position on purpose to make it non-contiguous so that it can work
            # with torch compile.
            # See detailed explanation in https://github.com/vllm-project/vllm/pull/12128#discussion_r1926431923

            # NOTE: When M-RoPE is enabled, position ids are 3D regardless of
            # the modality of inputs. For text-only inputs, each dimension has
            # identical position IDs, making M-RoPE functionally equivalent to
            # 1D-RoPE.
            # See page 5 of https://arxiv.org/abs/2409.12191
127
            self.mrope_positions = torch.zeros(
128
                (3, self.max_num_tokens + 1), dtype=torch.int64, device=device
129
            )
130
131
        else:
            # RoPE need (max_num_tokens,)
132
133
134
            self.positions = torch.zeros(
                self.max_num_tokens, dtype=torch.int64, device=device
            )
135
        self.hidden_states = torch.zeros(
136
137
            (self.max_num_tokens, self.hidden_size), dtype=self.dtype, device=device
        )
138

139
140
        # We need +1 here because the arange is used to set query_start_loc,
        # which has one more element than batch_size.
141
        max_batch_size = vllm_config.scheduler_config.max_num_seqs
142
        max_num_slots_for_arange = max(max_batch_size + 1, self.max_num_tokens)
143
144
145
        self.arange = torch.arange(
            max_num_slots_for_arange, device=device, dtype=torch.int32
        )
146

147
        self.inputs_embeds = torch.zeros(
148
149
            (self.max_num_tokens, self.hidden_size), dtype=self.dtype, device=device
        )
150

151
152
153
154
155
        self.backup_next_token_ids = CpuGpuBuffer(
            max_batch_size,
            dtype=torch.int32,
            pin_memory=is_pin_memory_available(),
            device=device,
156
157
            with_numpy=True,
        )
158

159
        # Determine allowed attention backends once during initialization.
160
161
        from vllm.attention.backends.registry import AttentionBackendEnum

162
        self.allowed_attn_types: tuple | None = None
163
164
        if current_platform.is_rocm():
            rocm_types = [TritonAttentionMetadata, FlashAttentionMetadata]
165
166
167
168
            # ROCM_AITER_FA is an optional backend
            if find_spec(
                AttentionBackendEnum.ROCM_AITER_FA.get_path(include_classname=False)
            ):
169
                from vllm.v1.attention.backends.rocm_aiter_fa import (
170
171
172
                    AiterFlashAttentionMetadata,
                )

173
174
175
                rocm_types.append(AiterFlashAttentionMetadata)
            self.allowed_attn_types = tuple(rocm_types)

176
177
        # Parse the speculative token tree.
        spec_token_tree = self.speculative_config.speculative_token_tree
178
        self.tree_choices: list[tuple[int, ...]] = ast.literal_eval(spec_token_tree)
179
180
181
182
183
184
185
186
        tree_depth = len(self.tree_choices[-1])
        # Precompute per-level properties of the tree.
        num_drafts_per_level = [0] * tree_depth
        for node in self.tree_choices:
            num_drafts_per_level[len(node) - 1] += 1
        self.cu_drafts_per_level = [num_drafts_per_level[0]]
        self.child_drafts_per_level = [num_drafts_per_level[0]]
        for level in range(1, tree_depth):
187
188
189
190
191
192
            self.cu_drafts_per_level.append(
                self.cu_drafts_per_level[-1] + num_drafts_per_level[level]
            )
            self.child_drafts_per_level.append(
                num_drafts_per_level[level] // num_drafts_per_level[level - 1]
            )
193
194
195
196
197
198
199
200
        # Precompute draft position offsets in flattened tree.
        self.tree_draft_pos_offsets = torch.arange(
            1,
            len(self.tree_choices) + 1,
            device=device,
            dtype=torch.int32,
        ).repeat(max_batch_size, 1)

201
202
203
204
205
206
207
208
209
210
211
    def _get_positions(self, num_tokens: int):
        if self.uses_mrope:
            return self.mrope_positions[:, :num_tokens]
        return self.positions[:num_tokens]

    def _set_positions(self, num_tokens: int, positions: torch.Tensor):
        if self.uses_mrope:
            self.mrope_positions[:, :num_tokens] = positions
        else:
            self.positions[:num_tokens] = positions

212
213
214
215
    def propose(
        self,
        # [num_tokens]
        target_token_ids: torch.Tensor,
216
        # [num_tokens] or [3, num_tokens] when M-RoPE is enabled
217
218
219
220
221
        target_positions: torch.Tensor,
        # [num_tokens, hidden_size]
        target_hidden_states: torch.Tensor,
        # [batch_size]
        next_token_ids: torch.Tensor,
222
        last_token_indices: torch.Tensor | None,
223
        common_attn_metadata: CommonAttentionMetadata,
224
        sampling_metadata: SamplingMetadata,
225
        mm_embed_inputs: tuple[list[torch.Tensor], torch.Tensor] | None = None,
226
    ) -> torch.Tensor:
227
228
        num_tokens = target_token_ids.shape[0]
        batch_size = next_token_ids.shape[0]
229
230
231

        if last_token_indices is None:
            last_token_indices = common_attn_metadata.query_start_loc[1:] - 1
232

233
234
235
        if self.method == "eagle3":
            assert isinstance(self.model, Eagle3LlamaForCausalLM)
            target_hidden_states = self.model.combine_hidden_states(
236
237
                target_hidden_states
            )
238
            assert target_hidden_states.shape[-1] == self.hidden_size
239
240
        # Shift the input ids by one token.
        # E.g., [a1, b1, b2, c1, c2, c3] -> [b1, b2, c1, c2, c3, c3]
241
        self.input_ids[: num_tokens - 1] = target_token_ids[1:]
242
243
        # Replace the last token with the next token.
        # E.g., [b1, b2, c1, c2, c3, c3] -> [a2, b2, b3, c2, c3, c4]
244
        self.input_ids[last_token_indices] = next_token_ids
245

246
        assert self.runner is not None
Jiayi Yao's avatar
Jiayi Yao committed
247

248
249
250
251
252
        if self.attn_metadata_builder is None:
            attn_metadata_builder = self._get_attention_metadata_builder()
        else:
            attn_metadata_builder = self.attn_metadata_builder

253
        attn_metadata = attn_metadata_builder.build_for_drafting(
254
255
            common_attn_metadata=common_attn_metadata, draft_index=0
        )
256
257
258
259
260
261
        # FIXME: support hybrid kv for draft model (remove separate indexer)
        if self.draft_indexer_metadata_builder:
            draft_indexer_metadata = (
                self.draft_indexer_metadata_builder.build_for_drafting(
                    common_attn_metadata=common_attn_metadata,
                    draft_index=0,
262
263
                )
            )
264
265
        else:
            draft_indexer_metadata = None
266
267
268
269
270
        # At this moment, we assume all eagle layers belong to the same KV
        # cache group, thus using the same attention metadata.
        per_layer_attn_metadata = {}
        for layer_name in self.attn_layer_names:
            per_layer_attn_metadata[layer_name] = attn_metadata
271

272
273
274
275
        for layer_name in self.indexer_layer_names:
            assert draft_indexer_metadata is not None
            per_layer_attn_metadata[layer_name] = draft_indexer_metadata

Rémi Delacourt's avatar
Rémi Delacourt committed
276
277
278
279
280
        num_tokens_dp_padded, num_tokens_across_dp = self._pad_batch_across_dp(
            num_tokens_unpadded=num_tokens,
            num_tokens_padded=num_tokens,
        )

281
        cudagraph_runtime_mode = CUDAGraphMode.NONE
282
283
        if (
            self.use_cuda_graph
Rémi Delacourt's avatar
Rémi Delacourt committed
284
285
            and num_tokens_dp_padded
            <= self.compilation_config.max_cudagraph_capture_size
286
        ):
Rémi Delacourt's avatar
Rémi Delacourt committed
287
            num_input_tokens = self.vllm_config.pad_for_cudagraph(num_tokens_dp_padded)
288
            cudagraph_runtime_mode = CUDAGraphMode.PIECEWISE
289
        else:
Rémi Delacourt's avatar
Rémi Delacourt committed
290
291
292
293
            num_input_tokens = num_tokens_dp_padded
        if num_tokens_across_dp is not None:
            num_tokens_across_dp[self.dp_rank] = num_input_tokens

294
        # copy inputs to buffer for cudagraph
295
        self._set_positions(num_tokens, target_positions)
296
        self.hidden_states[:num_tokens] = target_hidden_states
297
298
299
300

        if self.supports_mm_inputs:
            mm_embeds, is_mm_embed = mm_embed_inputs or (None, None)

301
            self.inputs_embeds[:num_tokens] = self.model.embed_input_ids(
302
303
304
                self.input_ids[:num_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
305
            )
306

307
            input_ids = None
308
            inputs_embeds = self.inputs_embeds[:num_input_tokens]
309
310
        else:
            input_ids = self.input_ids[:num_input_tokens]
311
            inputs_embeds = None
312

313
        with set_forward_context(
314
315
316
            per_layer_attn_metadata,
            self.vllm_config,
            num_tokens=num_input_tokens,
Rémi Delacourt's avatar
Rémi Delacourt committed
317
            num_tokens_across_dp=num_tokens_across_dp,
318
            cudagraph_runtime_mode=cudagraph_runtime_mode,
319
        ):
Jiayi Yao's avatar
Jiayi Yao committed
320
            ret_hidden_states = self.model(
321
                input_ids=input_ids,
322
                positions=self._get_positions(num_input_tokens),
323
324
                hidden_states=self.hidden_states[:num_input_tokens],
                inputs_embeds=inputs_embeds,
325
            )
326
            if self.method == "mtp":
Jiayi Yao's avatar
Jiayi Yao committed
327
                last_hidden_states = ret_hidden_states
328
                hidden_states = last_hidden_states
Jiayi Yao's avatar
Jiayi Yao committed
329
330
            else:
                last_hidden_states, hidden_states = ret_hidden_states
331
        sample_hidden_states = last_hidden_states[last_token_indices]
332
        logits = self.model.compute_logits(sample_hidden_states)
333
334
335
336
337
338

        # Early exit if there is only one draft token to be generated.
        if self.num_speculative_tokens == 1:
            draft_token_ids = logits.argmax(dim=-1)
            return draft_token_ids.view(-1, 1)

339
340
341
342
        if self.uses_mrope:
            positions = target_positions[:, last_token_indices]
        else:
            positions = target_positions[last_token_indices]
343
344
345
346
347
348
        if self.method in (
            "deepseek_mtp",
            "ernie_mtp",
            "longcat_flash_mtp",
            "pangu_ultra_moe_mtp",
        ):
XuruiYang's avatar
XuruiYang committed
349
350
351
            hidden_states = self.hidden_states[last_token_indices]
        else:
            hidden_states = hidden_states[last_token_indices]
352
353
354

        if isinstance(attn_metadata, TreeAttentionMetadata):
            # Draft using tree attention.
355
356
357
358
359
360
361
362
363
364
            draft_token_ids_list = self.propose_tree(
                batch_size=batch_size,
                logits=logits,
                positions=positions,
                hidden_states=hidden_states,
                common_attn_metadata=common_attn_metadata,
            )
            # [batch_size, num_tree_tokens]
            return torch.cat(draft_token_ids_list, dim=1)

365
        draft_token_ids = logits.argmax(dim=-1)
366

367
368
369
        if self.allowed_attn_types is not None and not isinstance(
            attn_metadata, self.allowed_attn_types
        ):
370
371
372
373
            raise ValueError(
                f"Unsupported attention metadata type for speculative "
                "decoding with num_speculative_tokens > 1: "
                f"{type(attn_metadata)}. Supported types are: "
374
375
                f"{self.allowed_attn_types}"
            )
376

377
378
379
        # Generate the remaining draft tokens.
        draft_token_ids_list = [draft_token_ids]

Rémi Delacourt's avatar
Rémi Delacourt committed
380
381
382
383
384
        batch_size_dp_padded, batch_size_across_dp = self._pad_batch_across_dp(
            num_tokens_unpadded=batch_size,
            num_tokens_padded=batch_size,
        )

385
386
        if (
            self.use_cuda_graph
Rémi Delacourt's avatar
Rémi Delacourt committed
387
388
            and batch_size_dp_padded
            <= self.compilation_config.max_cudagraph_capture_size
389
        ):
Rémi Delacourt's avatar
Rémi Delacourt committed
390
            input_batch_size = self.vllm_config.pad_for_cudagraph(batch_size_dp_padded)
391
            cudagraph_runtime_mode = CUDAGraphMode.PIECEWISE
392
        else:
Rémi Delacourt's avatar
Rémi Delacourt committed
393
            input_batch_size = batch_size_dp_padded
394
            cudagraph_runtime_mode = CUDAGraphMode.NONE
Rémi Delacourt's avatar
Rémi Delacourt committed
395
396
        if batch_size_across_dp is not None:
            batch_size_across_dp[self.dp_rank] = input_batch_size
397
398
399

        common_attn_metadata.num_actual_tokens = batch_size
        common_attn_metadata.max_query_len = 1
400
        common_attn_metadata.query_start_loc = self.arange[: batch_size + 1]
401
        common_attn_metadata.query_start_loc_cpu = torch.from_numpy(
402
403
            self.token_arange_np[: batch_size + 1]
        ).clone()
404
        for token_index in range(self.num_speculative_tokens - 1):
405
            # Update the inputs.
406
407
408
            # cast to int32 is crucial when eagle model is compiled.
            # tensor.argmax() returns int64 by default.
            input_ids = draft_token_ids_list[-1].int()
409
410
411
412
413
414
415
416
417
418
419
420
421
            if self.uses_mrope:
                positions += 1
                # NOTE(woosuk): We should handle the case where the draft model
                # generates tokens beyond the max model length.
                # Since it is complex to remove such requests from the batch,
                # we keep them in the batch but adjust the position ids
                # and slot mappings to avoid the
                # out-of-range access during the model execution.
                # The draft tokens generated with this adjustment
                # should be ignored.
                exceeds_max_model_len = positions[0] >= self.max_model_len
                # Mask out the position ids that exceed the max model length.
                # Otherwise, we may get out-of-range error in RoPE.
422
423
424
425
426
                clamped_positions = torch.where(
                    exceeds_max_model_len.unsqueeze(0),
                    torch.zeros_like(positions),
                    positions,
                )
427
428
429
            else:
                positions += 1
                exceeds_max_model_len = positions >= self.max_model_len
430
                clamped_positions = torch.where(exceeds_max_model_len, 0, positions)
431
432
433
            # For data integrity when async scheduling, we shouldn't use in place
            # operations in case they are modified in next step's `prepare_input`
            # of main model.
434
            # Increment the sequence lengths.
435
            common_attn_metadata.seq_lens += 1
436
437
            # This is an out-of-place operation to avoid modifying the original tensor.
            common_attn_metadata.seq_lens_cpu = common_attn_metadata.seq_lens_cpu + 1
438
439
            # For the requests that exceed the max model length, we set the
            # sequence length to 1 to minimize their overheads in attention.
440

441
            common_attn_metadata.seq_lens.masked_fill_(exceeds_max_model_len, 1)
442

443
            common_attn_metadata.num_computed_tokens_cpu = (
444
                common_attn_metadata.seq_lens_cpu - 1
445
            )
446

447
            # Compute the slot mapping.
448
449
450
451
452
            if self.uses_mrope:
                # all dimensions of positions are the same
                block_numbers = clamped_positions[0] // self.block_size
            else:
                block_numbers = clamped_positions // self.block_size
453
            block_ids = common_attn_metadata.block_table_tensor.gather(
454
455
                dim=1, index=block_numbers.view(-1, 1)
            )
456
            block_ids = block_ids.view(-1)
457
458
            if self.uses_mrope:
                common_attn_metadata.slot_mapping = (
459
460
                    block_ids * self.block_size + clamped_positions[0] % self.block_size
                )
461
462
            else:
                common_attn_metadata.slot_mapping = (
463
464
                    block_ids * self.block_size + clamped_positions % self.block_size
                )
465
466
467
            # Mask out the slot mappings that exceed the max model length.
            # Otherwise, the KV cache will be inadvertently updated with the
            # padding tokens.
468
            common_attn_metadata.slot_mapping.masked_fill_(
469
470
                exceeds_max_model_len, PADDING_SLOT_ID
            )
471
472

            # Rebuild attention metadata
473
            attn_metadata = attn_metadata_builder.build_for_drafting(  # type: ignore
474
475
                common_attn_metadata=common_attn_metadata, draft_index=token_index + 1
            )
476
477
            for layer_name in self.attn_layer_names:
                per_layer_attn_metadata[layer_name] = attn_metadata
478

479
480
            # copy inputs to buffer for cudagraph
            self.input_ids[:batch_size] = input_ids
481
            self._set_positions(batch_size, clamped_positions)
482
            self.hidden_states[:batch_size] = hidden_states
483
            if self.supports_mm_inputs:
484
                self.inputs_embeds[:batch_size] = self.model.embed_input_ids(input_ids)
485

486
                input_ids = None
487
                inputs_embeds = self.inputs_embeds[:input_batch_size]
488
489
            else:
                input_ids = self.input_ids[:input_batch_size]
490
                inputs_embeds = None
491

492
            # Run the model.
493
            with set_forward_context(
494
495
496
                per_layer_attn_metadata,
                self.vllm_config,
                num_tokens=input_batch_size,
Rémi Delacourt's avatar
Rémi Delacourt committed
497
                num_tokens_across_dp=batch_size_across_dp,
498
                cudagraph_runtime_mode=cudagraph_runtime_mode,
499
            ):
500
                ret_hidden_states = self.model(
501
                    input_ids=input_ids,
502
                    positions=self._get_positions(input_batch_size),
503
504
                    hidden_states=self.hidden_states[:input_batch_size],
                    inputs_embeds=inputs_embeds,
505
                )
506
                if self.method == "mtp":
507
508
509
510
                    last_hidden_states = ret_hidden_states
                    hidden_states = ret_hidden_states
                else:
                    last_hidden_states, hidden_states = ret_hidden_states
511
            hidden_states = hidden_states[:batch_size]
512
            logits = self.model.compute_logits(last_hidden_states[:batch_size])
513
            draft_token_ids = logits.argmax(dim=-1)
514
515
516
517
            draft_token_ids_list.append(draft_token_ids)

        # [batch_size, num_speculative_tokens]
        draft_token_ids = torch.stack(draft_token_ids_list, dim=1)
518
        return draft_token_ids
519

520
    def prepare_next_token_ids_cpu(
521
        self,
522
        sampled_token_ids: list[list[int]],
523
524
525
526
        requests: dict[str, CachedRequestState],
        gpu_input_batch: InputBatch,
        num_scheduled_tokens: dict[str, int],
    ) -> torch.Tensor:
527
528
529
530
531
532
533
534
535
536
        """
        This function is used to prepare the inputs for speculative decoding.
        It calculates the next token ids for each request based on the sampled
        token ids from the CPU. If a request has no sampled token ids (e.g.,
        during the initial decoding steps), it falls back to using the request
        state to get the next token id.
        """
        req_ids = gpu_input_batch.req_ids
        next_token_ids: list[int] = []
        for i, token_ids in enumerate(sampled_token_ids):
537
            if token_ids:
538
539
540
541
542
543
544
                # Common case.
                next_token_id = token_ids[-1]
            else:
                # Partial prefill (rare case).
                # Get the next token id from the request state.
                req_id = req_ids[i]
                req_state = requests[req_id]
545
                seq_len = req_state.num_computed_tokens + num_scheduled_tokens[req_id]
546
547
                next_token_id = req_state.get_token_id(seq_len)
            next_token_ids.append(next_token_id)
548
        next_token_ids = torch.tensor(
549
550
            next_token_ids, dtype=torch.int32, device=self.input_ids.device
        )
551
        return next_token_ids
552

553
554
555
556
557
558
559
560
561
    def prepare_next_token_ids_padded(
        self,
        common_attn_metadata: CommonAttentionMetadata,
        sampled_token_ids: torch.Tensor,
        requests: dict[str, CachedRequestState],
        gpu_input_batch: InputBatch,
        discard_request_indices: torch.Tensor,
        num_discarded_requests: int,
    ) -> tuple[torch.Tensor, torch.Tensor]:
562
563
564
565
566
567
568
569
570
571
572
573
574
        """
        This function is used to prepare the inputs for speculative decoding.
        It calculates the next token ids and the number of valid sampled tokens
        for each request, considering the "discarded" requests whose next token
        is not sampled and comes from `request.get_token_id()` instead.
        It also accounts for the rejected tokens in `sampled_token_ids`.
        This function must use device functions to operate on the inputs, and
        should not introduce any blocking CPU-GPU synchronization.
        """
        # TODO(Ben): Combine this into a custom fused kernel

        # Precompute get_token_id for when there is no valid next token
        num_reqs = gpu_input_batch.num_reqs
575
576
577
578
579
580
581
582
        self.backup_next_token_ids.np[:num_reqs] = np.array(
            [
                requests[gpu_input_batch.req_ids[i]].get_token_id(
                    common_attn_metadata.seq_lens_cpu[i].item()
                )
                for i in range(num_reqs)
            ]
        )
583
584
585
        self.backup_next_token_ids.copy_to_gpu(num_reqs)

        # Mask out the sampled tokens indices that should not be sampled.
586
587
588
        discard_sampled_tokens_req_indices = discard_request_indices[
            :num_discarded_requests
        ]
589
590
591

        valid_sampled_token_ids_gpu = sampled_token_ids.clone()
        valid_sampled_token_ids_gpu.index_fill_(
592
593
            0, discard_sampled_tokens_req_indices, -1
        )
594
595

        # Generate a mask for all valid tokens within those requests
596
597
598
        valid_mask = (valid_sampled_token_ids_gpu != -1) & (
            valid_sampled_token_ids_gpu < gpu_input_batch.vocab_size
        )
599
600
601
602
603
604
605
606
607
608
609

        # Count the number of valid tokens in each request
        valid_sampled_tokens_count = valid_mask.sum(dim=1)

        # Get the rightmost valid index per row
        last_valid_indices = valid_sampled_tokens_count - 1
        last_valid_indices_safe = torch.clamp(last_valid_indices, min=0)

        # Get last valid token from each row
        # (assume undefined state where there is no valid token)
        selected_tokens = torch.gather(
610
611
            valid_sampled_token_ids_gpu, 1, last_valid_indices_safe.unsqueeze(1)
        ).squeeze(1)
612
613
614
615

        # Use last token if valid, pre-computed backup if not
        batch_size = valid_sampled_token_ids_gpu.shape[0]
        next_token_ids = torch.where(
616
617
618
619
            last_valid_indices != -1,
            selected_tokens,
            self.backup_next_token_ids.gpu[:batch_size],
        )
620
621
622

        return next_token_ids, valid_sampled_tokens_count

623
624
625
626
627
628
    def prepare_inputs_padded(
        self,
        common_attn_metadata: CommonAttentionMetadata,
        spec_decode_metadata: SpecDecodeMetadata,
        valid_sampled_tokens_count: torch.Tensor,
    ) -> tuple[CommonAttentionMetadata, torch.Tensor, torch.Tensor]:
629
630
631
632
633
634
635
636
        """
        This function is used to prepare the inputs for speculative decoding
        It updates the common_attn_metadata for speculative decoding,
        but does not consider the rejected tokens. Instead, all tokens
        are included as inputs to the speculator, with the rejected tokens
        used as padding and filtered out later by `token_indices_to_sample`.
        No blocking CPU operations should be introduced in this function.
        """
637
638
639
640
641
642
643
        num_draft_tokens_gpu = torch.cat(
            [
                spec_decode_metadata.cu_num_draft_tokens[0:1],
                spec_decode_metadata.cu_num_draft_tokens[1:]
                - spec_decode_metadata.cu_num_draft_tokens[:-1],
            ]
        )
644
645
646
647

        num_rejected_tokens_gpu = torch.where(
            num_draft_tokens_gpu > 0,
            num_draft_tokens_gpu + 1 - valid_sampled_tokens_count,
648
649
            torch.zeros_like(num_draft_tokens_gpu),
        )
650
651
652

        query_start_loc_cpu = common_attn_metadata.query_start_loc_cpu

653
        new_query_len_per_req = query_start_loc_cpu[1:] - query_start_loc_cpu[:-1]
654
655
656
657
658
659
660
661
662

        total_num_tokens = query_start_loc_cpu[-1].item()
        token_indices = self.arange[:total_num_tokens]

        spec_common_attn_metadata = CommonAttentionMetadata(
            query_start_loc=common_attn_metadata.query_start_loc,
            seq_lens=common_attn_metadata.seq_lens,
            query_start_loc_cpu=query_start_loc_cpu,
            seq_lens_cpu=common_attn_metadata.seq_lens_cpu,
663
            num_computed_tokens_cpu=common_attn_metadata.num_computed_tokens_cpu,
664
665
666
667
668
669
670
            num_reqs=common_attn_metadata.num_reqs,
            num_actual_tokens=total_num_tokens,
            max_query_len=new_query_len_per_req.max().item(),
            max_seq_len=common_attn_metadata.seq_lens_cpu.max().item(),
            block_table_tensor=common_attn_metadata.block_table_tensor,
            slot_mapping=common_attn_metadata.slot_mapping[token_indices],
            causal=True,
671
            dcp_local_seq_lens=common_attn_metadata.dcp_local_seq_lens,
672
673
        )

674
675
676
        token_indices_to_sample = (
            common_attn_metadata.query_start_loc[1:] - 1 - num_rejected_tokens_gpu
        )
677
678
679

        return spec_common_attn_metadata, token_indices, token_indices_to_sample

680
681
682
683
684
685
686
687
688
689
690
    def propose_tree(
        self,
        batch_size: int,
        # [num_tokens, vocab_size]
        logits: torch.Tensor,
        # [num_tokens]
        positions: torch.Tensor,
        # [num_tokens, hidden_size]
        hidden_states: torch.Tensor,
        common_attn_metadata: CommonAttentionMetadata,
    ) -> list[torch.Tensor]:
691
692
693
694
        tree_attn_metadata_builder = self.runner.attn_groups[0][
            0
        ].get_metadata_builder()
        assert isinstance(tree_attn_metadata_builder, TreeAttentionMetadataBuilder)
695

696
        total_num_drafts = self.cu_drafts_per_level[0]
697
698
        level_num_drafts = total_num_drafts
        # Sample a draft token for each child at the tree root level.
699
        num_children = self.child_drafts_per_level[0]
700
701
702
        if num_children == 1:
            draft_token_ids = logits.argmax(dim=-1).view(batch_size, -1)
        else:
703
704
705
            draft_token_ids = torch.topk(logits, num_children, dim=-1).indices.view(
                batch_size, -1
            )
706
707
708
709
        draft_token_ids_list = [draft_token_ids]
        draft_hidden_states = hidden_states.view(batch_size, 1, -1)

        # Initialize empty tensors for concatenation with the level outputs.
710
711
712
713
714
715
716
717
718
        tree_input_ids = torch.empty(
            0, device=self.input_ids.device, dtype=self.input_ids.dtype
        )
        tree_positions = torch.empty(
            0, device=self.positions.device, dtype=self.positions.dtype
        )
        tree_hidden_states = torch.empty(
            0, device=self.hidden_states.device, dtype=self.hidden_states.dtype
        )
719
720
        # Precompute the draft token positions.
        flattened_draft_positions = (
721
722
            positions.view(batch_size, -1) + self.tree_draft_pos_offsets[:batch_size, :]
        )
723
        tree_depth = len(self.cu_drafts_per_level)
724
        for level in range(tree_depth - 1):
725
726
            # Get draft positions for RoPE.
            draft_positions = positions + (level + 1)
727
            exceeds_max_model_len = (positions + total_num_drafts) >= self.max_model_len
728
729
            # Mask out the position ids that exceed the max model length.
            # Otherwise, we may get out-of-range error in RoPE.
730
            draft_positions = torch.where(
731
732
733
                exceeds_max_model_len,
                0,
                draft_positions,
734
735
            ).view(batch_size, -1)

736
737
            if level_num_drafts > 1:
                # Repeat the positions for each draft at this level.
738
                draft_positions = draft_positions.repeat_interleave(
739
740
                    level_num_drafts, dim=1
                )
741
742
743
744

            if num_children > 1:
                # Repeat draft hidden states for each child.
                draft_hidden_states = draft_hidden_states.repeat_interleave(
745
746
                    num_children, dim=1
                )
747
748

            # Concatenate the draft tokens, positions, and hidden states.
749
750
            tree_input_ids = torch.cat([tree_input_ids, draft_token_ids], dim=1)
            tree_positions = torch.cat([tree_positions, draft_positions], dim=1)
751
            tree_hidden_states = torch.cat(
752
753
                [tree_hidden_states, draft_hidden_states], dim=1
            )
754
755
756

            # Build new attention metadata for the next level of drafts.
            # This is necessary to support tree attention.
757
            query_len = total_num_drafts
758
759
            common_attn_metadata = replace(
                common_attn_metadata,
760
                query_start_loc=query_len * self.arange[: batch_size + 1],
761
762
763
764
765
766
                seq_lens=common_attn_metadata.seq_lens + level_num_drafts,
                num_actual_tokens=batch_size * query_len,
                max_query_len=query_len,
            )
            attn_metadata = tree_attn_metadata_builder.build_for_drafting(
                common_attn_metadata=common_attn_metadata,
767
                draft_index=level + 1,
768
769
770
771
772
773
774
775
            )

            # Apply new attention metadata to all layers.
            per_layer_attn_metadata = {}
            for layer_name in self.attn_layer_names:
                per_layer_attn_metadata[layer_name] = attn_metadata

            # Consider max model length.
776
777
778
            attn_metadata.max_seq_len = min(
                attn_metadata.max_seq_len, self.max_model_len
            )
779
780
781
782
783
            # For the requests that exceed the max model length, we set the
            # sequence length to 1 to minimize their overheads in attention.
            attn_metadata.seq_lens.masked_fill_(exceeds_max_model_len, 1)

            # Compute the slot mapping.
784
            query_positions = flattened_draft_positions[:, level : level + query_len]
785
            block_numbers = query_positions // self.block_size
786
787
788
789
            block_ids = attn_metadata.block_table.gather(dim=1, index=block_numbers)
            slot_mapping = (
                block_ids * self.block_size + query_positions % self.block_size
            )
790
791
792
793
794
795
796
797
798
799
800
            # Mask out the slot mappings that exceed the max model length.
            # Otherwise, the KV cache will be inadvertently updated with the
            # padding tokens.
            slot_mapping[exceeds_max_model_len] = PADDING_SLOT_ID
            attn_metadata.slot_mapping = slot_mapping.view(-1)

            # Copy inputs to buffer for cudagraph.
            num_tokens = attn_metadata.num_actual_tokens
            input_ids = tree_input_ids.view(-1)
            self.input_ids[:num_tokens] = input_ids
            self.positions[:num_tokens] = tree_positions.view(-1)
801
            self.hidden_states[:num_tokens] = tree_hidden_states.view(num_tokens, -1)
802

803
804
805
806
            if (
                self.use_cuda_graph
                and num_tokens <= self.compilation_config.max_cudagraph_capture_size
            ):
807
                num_input_tokens = self.vllm_config.pad_for_cudagraph(num_tokens)
808
                cudagraph_runtime_mode = CUDAGraphMode.PIECEWISE
809
810
            else:
                num_input_tokens = num_tokens
811
                cudagraph_runtime_mode = CUDAGraphMode.NONE
812
            # Run the model.
813
            with set_forward_context(
814
815
816
817
                per_layer_attn_metadata,
                self.vllm_config,
                num_tokens=num_input_tokens,
                cudagraph_runtime_mode=cudagraph_runtime_mode,
818
            ):
819
820
821
822
823
824
825
826
827
                last_hidden_states, hidden_states = self.model(
                    input_ids=self.input_ids[:num_input_tokens],
                    positions=self.positions[:num_input_tokens],
                    hidden_states=self.hidden_states[:num_input_tokens],
                    inputs_embeds=None,
                )

            # Get the output hidden states for the draft tokens.
            draft_hidden_states = hidden_states[:num_tokens].view(
828
829
                batch_size, query_len, -1
            )[:, -level_num_drafts:]
830
            draft_last_hidden_states = last_hidden_states[:num_tokens].view(
831
832
                batch_size, query_len, -1
            )[:, -level_num_drafts:]
833
834
835

            # Get the output logits for the draft tokens.
            logits = self.model.compute_logits(
836
837
                draft_last_hidden_states.reshape(batch_size * level_num_drafts, -1)
            )
838
839
840
841
842
843

            # Sample a draft token for each child at the next tree level.
            num_children = self.child_drafts_per_level[level + 1]
            if num_children == 1:
                draft_token_ids = logits.argmax(dim=-1).view(batch_size, -1)
            else:
844
845
846
                draft_token_ids = torch.topk(logits, num_children, dim=-1).indices.view(
                    batch_size, -1
                )
847
848
849
            draft_token_ids_list.append(draft_token_ids)

            # Update the # drafts counters for the next tree level.
850
            level_num_drafts = self.cu_drafts_per_level[level + 1] - total_num_drafts
851
852
853
            total_num_drafts = self.cu_drafts_per_level[level + 1]
        return draft_token_ids_list

854
    def prepare_inputs(
855
856
        self,
        common_attn_metadata: CommonAttentionMetadata,
857
858
        sampled_token_ids: list[list[int]],
        num_draft_tokens: list[int],
859
860
    ) -> tuple[CommonAttentionMetadata, torch.Tensor]:
        """
861
        This function is used to prepare the inputs for speculative decoding.
862
863
864
865
866
867
        It updates to the common_attn_metadata to account for the rejected
        tokens (and newly sampled tokens). It also returns the token indices
        of the tokens that should be fed to the speculator.
        """
        # E.g.
        #  common_attn_metadata.query_start_loc{_cpu}:
868
        #       [0, q1, q1 + q2, q1 + q2 + q3]
869
870
871
872
873
874
        #  common_attn_metadata.seq_lens{_cpu}: [s1, s2, s3]
        #  num_rejected_tokens: [n1, n2, n3]
        # This function computes the intermediate values:
        #  num_tokens_per_req: [q1 - n1, q2 - n2, q3 - n3]
        # And returns:
        #  common_attn_metadata.query_start_loc{_cpu}:
875
        #       [0, q1 - n1, q1 + q2 - n1 - n2, q1 + q2 + q3 - n1 - n2 - n3]
876
        #  common_attn_metadata.seq_lens{_cpu}:
877
        #       [s1 - n1 + 1, s2 - n2 + 1, s3 - n3 + 1]
878
        #  token_indices: [0, 1, ..., q1 - n1 - 1,
879
880
        #                 q1, q1 + 1, ..., q1 + q2 - n2 - 1,
        #                 q1 + q2, q1 + q2 + 1, ..., q1 + q2 + q3 - n3 - 1]
881

882
883
884
885
        num_rejected_tokens = [
            n + 1 - len(sampled_token_ids[i]) if n > 0 else 0
            for i, n in enumerate(num_draft_tokens)
        ]
886
        num_rejected_tokens = torch.tensor(num_rejected_tokens, dtype=torch.int32)
887

888
889
        device = common_attn_metadata.query_start_loc.device
        query_start_loc_cpu = common_attn_metadata.query_start_loc_cpu
890
        new_seq_lens_cpu = common_attn_metadata.seq_lens_cpu - num_rejected_tokens
891
892

        # [0, q1, q1 + q2, q1 + q2 + q3] -> [q1, q2, q3]
893
        new_query_len_per_req = query_start_loc_cpu[1:] - query_start_loc_cpu[:-1]
894
895
896
897
898
899
900
901
        # [q1, q2, q3] -> [q1 - n1, q2 - n2, q3 - n3]
        new_num_tokens_per_req = new_query_len_per_req - num_rejected_tokens
        new_num_tokens_per_req_np = new_num_tokens_per_req.numpy()

        # [q1 - n1, q2 - n2, q3 - n3] ->
        # [0, q1 - n1, q1 + q2 - n1 - n2, q1 + q2 + q3 - n1 - n2 - n3]
        new_query_start_loc_cpu = torch.zeros(
            query_start_loc_cpu.shape,
902
            dtype=torch.int32,
903
904
            pin_memory=is_pin_memory_available(),
        )
905
906
907
908
909
910
911
912
913
        new_query_start_loc_np = new_query_start_loc_cpu.numpy()
        np.cumsum(new_num_tokens_per_req_np, out=new_query_start_loc_np[1:])

        total_num_tokens = new_query_start_loc_np[-1]
        # Example assuming num_tokens_per_req_np = [2, 4, 3]
        # this implies that `new_query_start_locs` is:
        # [0, 2, 6, 9] ->
        # [0, 0, 2, 2, 2, 2, 6, 6, 6]
        #  _r1_  ____r2____  ___r3__
914
915
916
        new_query_start_locs_expanded = np.repeat(
            new_query_start_loc_np[:-1], new_num_tokens_per_req_np
        )
917
918
919
        # [0, 1, 2, 3, 4, 5, 6, 7, 8] ->
        # [0, 1, 0, 1, 2, 3, 0, 1, 2]
        #  _r1_  ____r2____  ___r3__
920
921
922
        token_offests = (
            self.token_arange_np[:total_num_tokens] - new_query_start_locs_expanded
        )
923
924
925
926
927
928

        # Expand starting positions to match token pattern
        # [0, q1, q1 + q2] ->
        # [0, 0, q1, q1, q1, q1, q1 + q2, q1 + q2, q1 + q2]
        #  _r1_  _____r2_______  ___________r3____________
        old_query_start_locs_expanded = np.repeat(
929
930
            query_start_loc_cpu[:-1].numpy(), new_num_tokens_per_req_np
        )
931
        # Final token indices are:
932
933
934
        # [0, 1,                                // req 1
        #  q1 + 0, q1 + 1, q1 + 2, q1 + 3,       // req 2
        #  q1 + q2 + 0, q1 + q2 + 1, q1 + q2 + 2] // req 3
935
        token_indices_np = token_offests + old_query_start_locs_expanded
936
        token_indices = torch.from_numpy(token_indices_np).to(device, non_blocking=True)
937
938

        spec_common_attn_metadata = CommonAttentionMetadata(
939
            query_start_loc=new_query_start_loc_cpu.to(device, non_blocking=True),
940
941
942
            seq_lens=new_seq_lens_cpu.to(device, non_blocking=True),
            query_start_loc_cpu=new_query_start_loc_cpu,
            seq_lens_cpu=new_seq_lens_cpu,
943
            num_computed_tokens_cpu=common_attn_metadata.num_computed_tokens_cpu,
944
945
946
            num_reqs=common_attn_metadata.num_reqs,
            num_actual_tokens=total_num_tokens,
            max_query_len=new_query_len_per_req.max().item(),
947
            max_seq_len=new_seq_lens_cpu.max().item(),
948
949
            block_table_tensor=common_attn_metadata.block_table_tensor,
            slot_mapping=common_attn_metadata.slot_mapping[token_indices],
950
            causal=True,
951
            dcp_local_seq_lens=common_attn_metadata.dcp_local_seq_lens,
952
        )
953
954

        return spec_common_attn_metadata, token_indices
955

956
    def get_model_name(self, model: nn.Module) -> str:
957
        if hasattr(model, "module"):  # multi-GPU
958
959
960
            model = model.module
        return model.__class__.__name__

961
    def load_model(self, target_model: nn.Module) -> None:
962
        draft_model_config = self.vllm_config.speculative_config.draft_model_config
963
        target_attn_layer_names = set(
964
            get_layers_from_vllm_config(self.vllm_config, AttentionLayerBase).keys()
965
        )
966
967
        # FIXME: support hybrid kv for draft model
        target_indexer_layer_names = set(
968
969
970
971
            get_layers_from_vllm_config(
                self.vllm_config, DeepseekV32IndexerCache
            ).keys()
        )
972

973
        from vllm.compilation.backends import set_model_tag
974

975
        with set_model_tag("eagle_head"):
976
977
978
            self.model = get_model(
                vllm_config=self.vllm_config, model_config=draft_model_config
            )
979

980
        draft_attn_layer_names = (
981
            get_layers_from_vllm_config(self.vllm_config, AttentionLayerBase).keys()
982
983
984
985
986
987
            - target_attn_layer_names
        )
        indexer_layers = get_layers_from_vllm_config(
            self.vllm_config, DeepseekV32IndexerCache
        )
        draft_indexer_layer_names = indexer_layers.keys() - target_indexer_layer_names
988
        self.attn_layer_names = list(draft_attn_layer_names - draft_indexer_layer_names)
989
990
991
992
993
        self.indexer_layer_names = list(draft_indexer_layer_names)

        if self.indexer_layer_names:
            first_layer = self.indexer_layer_names[0]
            self.draft_indexer_metadata_builder = (
994
995
996
                indexer_layers[first_layer]
                .get_attn_backend()
                .get_builder_cls()(
997
                    indexer_layers[first_layer].get_kv_cache_spec(self.vllm_config),
998
999
1000
                    self.indexer_layer_names,
                    self.vllm_config,
                    self.device,
1001
1002
                )
            )
1003
1004
        else:
            self.draft_indexer_metadata_builder = None
1005

1006
        if self.supports_mm_inputs:
1007
1008
1009
            # Even if the target model is multimodal, we can also use
            # text-only draft models
            try:
1010
                dummy_input_ids = torch.tensor([[1]], device=self.input_ids.device)
1011
                self.model.embed_input_ids(dummy_input_ids, multimodal_embeddings=None)
1012
1013
1014
            except (NotImplementedError, AttributeError, TypeError):
                logger.warning(
                    "Draft model does not support multimodal inputs, "
1015
1016
                    "falling back to text-only mode"
                )
1017
                self.supports_mm_inputs = False
1018

1019
1020
        if supports_multimodal(target_model):
            # handle multimodality
1021
1022
1023
1024
1025
            if (
                self.get_model_name(target_model)
                == "Qwen2_5_VLForConditionalGeneration"
            ):
                self.model.config.image_token_index = target_model.config.image_token_id
1026
1027
            else:
                self.model.config.image_token_index = (
1028
1029
                    target_model.config.image_token_index
                )
1030
1031
1032
            target_language_model = target_model.get_language_model()
        else:
            target_language_model = target_model
1033

1034
        # share embed_tokens with the target model if needed
1035
        if get_pp_group().world_size == 1:
1036
            if hasattr(target_language_model.model, "embed_tokens"):
1037
                target_embed_tokens = target_language_model.model.embed_tokens
1038
            elif hasattr(target_language_model.model, "embedding"):
1039
1040
1041
                target_embed_tokens = target_language_model.model.embedding
            else:
                raise AttributeError(
1042
1043
                    "Target model does not have 'embed_tokens' or 'embedding' attribute"
                )
1044

1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
            share_embeddings = False
            if hasattr(self.model, "has_own_embed_tokens"):
                # EAGLE model
                if not self.model.has_own_embed_tokens:
                    share_embeddings = True
                    logger.info(
                        "Detected EAGLE model without its own embed_tokens in the"
                        " checkpoint. Sharing target model embedding weights with the"
                        " draft model."
                    )
                elif (
                    isinstance(target_embed_tokens.weight, torch.Tensor)
                    and isinstance(self.model.model.embed_tokens.weight, torch.Tensor)
1058
1059
1060
                    # TODO: Offload to CPU for comparison to avoid extra GPU memory
                    # usage in CI testing environments with limited GPU memory
                    and torch.equal(
1061
1062
                        target_embed_tokens.weight.cpu(),
                        self.model.model.embed_tokens.weight.cpu(),
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
                    )
                ):
                    share_embeddings = True
                    logger.info(
                        "Detected EAGLE model with embed_tokens identical to the target"
                        " model. Sharing target model embedding weights with the draft"
                        " model."
                    )
                else:
                    logger.info(
                        "Detected EAGLE model with distinct embed_tokens weights. "
                        "Keeping separate embedding weights from the target model."
                    )
1076
            else:
1077
1078
                # MTP model
                share_embeddings = True
1079
                logger.info(
1080
1081
                    "Detected MTP model. "
                    "Sharing target model embedding weights with the draft model."
1082
                )
1083
1084
1085
1086
1087

            if share_embeddings:
                if hasattr(self.model.model, "embed_tokens"):
                    del self.model.model.embed_tokens
                self.model.model.embed_tokens = target_embed_tokens
1088
        else:
1089
            logger.info(
1090
                "The draft model's vocab embedding will be loaded separately"
1091
1092
                " from the target model."
            )
1093
1094

        # share lm_head with the target model if needed
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
        share_lm_head = False
        if hasattr(self.model, "has_own_lm_head"):
            # EAGLE model
            if not self.model.has_own_lm_head:
                share_lm_head = True
                logger.info(
                    "Detected EAGLE model without its own lm_head in the checkpoint. "
                    "Sharing target model lm_head weights with the draft model."
                )
            elif (
                hasattr(target_language_model, "lm_head")
                and isinstance(target_language_model.lm_head.weight, torch.Tensor)
                and isinstance(self.model.lm_head.weight, torch.Tensor)
1108
1109
                # TODO: Offload to CPU for comparison to avoid extra GPU memory
                # usage in CI testing environments with limited GPU memory
1110
                and torch.equal(
1111
1112
                    target_language_model.lm_head.weight.cpu(),
                    self.model.lm_head.weight.cpu(),
1113
                )
1114
            ):
1115
                share_lm_head = True
1116
                logger.info(
1117
1118
                    "Detected EAGLE model with lm_head identical to the target model. "
                    "Sharing target model lm_head weights with the draft model."
1119
                )
1120
1121
            else:
                logger.info(
1122
1123
                    "Detected EAGLE model with distinct lm_head weights. "
                    "Keeping separate lm_head weights from the target model."
1124
                )
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
        else:
            # MTP model
            share_lm_head = True
            logger.info(
                "Detected MTP model. "
                "Sharing target model lm_head weights with the draft model."
            )

        if share_lm_head and hasattr(target_language_model, "lm_head"):
            if hasattr(self.model, "lm_head"):
                del self.model.lm_head
            self.model.lm_head = target_language_model.lm_head
1137

1138
1139
1140
1141
    @torch.inference_mode()
    def dummy_run(
        self,
        num_tokens: int,
1142
        use_cudagraphs=True,
Rémi Delacourt's avatar
Rémi Delacourt committed
1143
        is_graph_capturing=False,
1144
    ) -> None:
1145
1146
        # Determine if CUDA graphs should be used for this run.
        cudagraphs_enabled = use_cudagraphs and self.use_cuda_graph
1147

Rémi Delacourt's avatar
Rémi Delacourt committed
1148
1149
1150
1151
        # FIXME: when using tree-based specdec, adjust number of forward-passes
        # according to the depth of the tree.
        for fwd_idx in range(
            self.num_speculative_tokens if not is_graph_capturing else 1
1152
        ):
Rémi Delacourt's avatar
Rémi Delacourt committed
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
            if fwd_idx <= 1:
                num_tokens_dp_padded, num_tokens_across_dp = self._pad_batch_across_dp(
                    num_tokens_unpadded=num_tokens,
                    num_tokens_padded=num_tokens,
                )
                if (
                    cudagraphs_enabled
                    and num_tokens_dp_padded
                    <= self.compilation_config.max_cudagraph_capture_size
                ):
                    num_input_tokens = self.vllm_config.pad_for_cudagraph(
                        num_tokens_dp_padded
                    )
                else:
                    num_input_tokens = num_tokens_dp_padded
                if num_tokens_across_dp is not None:
                    num_tokens_across_dp[self.dp_rank] = num_input_tokens
1170

Rémi Delacourt's avatar
Rémi Delacourt committed
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
            with set_forward_context(
                None,
                self.vllm_config,
                num_tokens=num_input_tokens,
                num_tokens_across_dp=num_tokens_across_dp,
                cudagraph_runtime_mode=CUDAGraphMode.PIECEWISE
                if cudagraphs_enabled
                else CUDAGraphMode.NONE,
            ):
                if self.supports_mm_inputs:
                    input_ids = None
                    inputs_embeds = self.inputs_embeds[:num_input_tokens]
                else:
                    input_ids = self.input_ids[:num_input_tokens]
                    inputs_embeds = None

                self.model(
                    input_ids=input_ids,
                    positions=self._get_positions(num_input_tokens),
                    hidden_states=self.hidden_states[:num_input_tokens],
                    inputs_embeds=inputs_embeds,
                )
1193

1194
    def _get_attention_metadata_builder(self) -> AttentionMetadataBuilder:
1195
        """Find and return the attention metadata builders for EAGLE layers.
1196

1197
1198
        Returns:
            The metadata builders for EAGLE layers.
1199

1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
        Raises:
            AssertionError: If no metadata builders are found for EAGLE layers.
        """
        builder = None
        chosen_layer = self.attn_layer_names[0]

        for kv_cache_group in self.runner.attn_groups:
            for attn_group in kv_cache_group:
                if chosen_layer in attn_group.layer_names:
                    builder = attn_group.get_metadata_builder()
                    break
            if builder is not None:
                break

        assert builder is not None, (
1215
1216
            "Failed to find attention metadata builder for EAGLE layers."
        )
1217
1218
        return builder

1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
    def _get_eagle3_use_aux_hidden_state_from_config(self) -> bool:
        """
        Some eagle3 heads (e.g., nvidia/gpt-oss-120b-Eagle3-v2) do not use auxiliary
        hidden states and directly uses the last layer output just like eagle1.
        They might indicate this by setting "use_aux_hidden_state" to False
        inside the "eagle_config" dict of their hf_config.
        """
        if self.method != "eagle3":
            return False
        # Assume that eagle3 heads use aux hidden states by default
        use_aux_hidden_state = True
        eagle_config = getattr(self.draft_model_config.hf_config, "eagle_config", None)
        if eagle_config is not None:
            use_aux_hidden_state = eagle_config.get("use_aux_hidden_state", True)
        return use_aux_hidden_state

1235
    def validate_same_kv_cache_group(self, kv_cache_config: KVCacheConfig) -> None:
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
        """
        Validate that all eagle layers belong to the same KVCacheGroup.
        Need this assumption to ensure all eagle layers can use the
        same AttentionMetadata.
        May extend to multiple AttentionMetadata in the future.
        """
        kv_cache_groups: dict[str, int] = {}
        for id, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
            for layer_name in kv_cache_group.layer_names:
                kv_cache_groups[layer_name] = id
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
        assert (
            len(
                set(
                    [
                        kv_cache_groups[layer_name]
                        for layer_name in self.attn_layer_names
                    ]
                )
            )
            == 1
        ), "All eagle layers should belong to the same kv cache group"
1257

Rémi Delacourt's avatar
Rémi Delacourt committed
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
    def _pad_batch_across_dp(
        self,
        num_tokens_unpadded: int,
        num_tokens_padded: int,
    ) -> tuple[int, torch.Tensor]:
        # TODO(Flechman): support DBO ubatching
        ubatch_slices, num_toks_across_dp = coordinate_batch_across_dp(
            num_tokens_unpadded=num_tokens_unpadded,
            parallel_config=self.vllm_config.parallel_config,
            allow_microbatching=False,
            allow_dp_padding=self.use_cuda_graph,
            num_tokens_padded=num_tokens_padded,
            uniform_decode=None,
            num_scheduled_tokens_per_request=None,
        )
        assert ubatch_slices is None, "DBO ubatching not implemented for EAGLE"

        num_tokens_dp_padded = num_tokens_padded
        if num_toks_across_dp is not None:
            num_tokens_dp_padded = int(num_toks_across_dp[self.dp_rank].item())
        return num_tokens_dp_padded, num_toks_across_dp

1280

1281
1282
1283
1284
# NOTE(woosuk): Currently, the below code is not used and we always use argmax
# to sample the draft tokens. We will use this after we find a way to manage
# the draft prob tensor.
# Refer to https://github.com/vllm-project/vllm/pull/16899 for the details.
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# FIXME(woosuk): The logic here is duplicated with the main sampling code.
# We should refactor this to reuse the same sampling implementation.
def compute_probs_and_sample_next_token(
    logits: torch.Tensor,
    sampling_metadata: SamplingMetadata,
) -> tuple[torch.Tensor, torch.Tensor]:
    if sampling_metadata.all_greedy:
        # For greedy requests, draft_probs is not used in rejection sampling.
        # Therefore, we can just return the logits.
        probs = logits
        next_token_ids = logits.argmax(dim=-1)
        return next_token_ids, probs

1298
1299
1300
1301
1302
1303
1304
1305
1306
    assert sampling_metadata.temperature is not None

    # Use epsilon comparison to detect greedy sampling (temperature ~ 0.0)
    # consistent with sampler.py's _SAMPLING_EPS threshold
    temperature = sampling_metadata.temperature
    # Avoid division by zero if there are greedy requests.
    if not sampling_metadata.all_random:
        is_greedy = temperature < _SAMPLING_EPS
        temperature = torch.where(is_greedy, 1.0, temperature)
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
    logits.div_(temperature.view(-1, 1))
    probs = logits.softmax(dim=-1, dtype=torch.float32)

    # NOTE(woosuk): Currently, we ignore most of the sampling parameters in
    # generating the draft tokens. We only use the temperature. While this
    # could degrade the acceptance rate, it does not affect the distribution
    # of the generated tokens after rejection sampling.

    # TODO(woosuk): Consider seeds.
    q = torch.empty_like(probs)
    q.exponential_()
1318
1319
1320
    # NOTE(woosuk): We shouldn't use `probs.div_(q)` because the draft_probs
    # will be used later for rejection sampling.
    next_token_ids = probs.div(q).argmax(dim=-1).view(-1)
1321
1322
1323
1324
1325
1326
1327
1328
    if not sampling_metadata.all_random:
        greedy_token_ids = probs.argmax(dim=-1)
        next_token_ids = torch.where(
            is_greedy,
            greedy_token_ids,
            next_token_ids,
        )
    return next_token_ids, probs