Add pydocstyle to the ruff rules (#52136)
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: Harry Mellor <hej.mellor@gmail.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5
parent
804e5377aa
commit
8c1557a79c
@@ -785,7 +785,8 @@ class SpecDecodeBaseProposer:
|
||||
block_size: int,
|
||||
) -> torch.Tensor:
|
||||
"""Update positions, slot mappings, and sequence metadata for the
|
||||
next draft step. Returns the updated positions tensor."""
|
||||
next draft step. Returns the updated positions tensor.
|
||||
"""
|
||||
positions_1d = positions[0] if self.uses_mrope else positions
|
||||
if self.uses_mrope:
|
||||
out_pos = self.mrope_positions[0, :batch_size]
|
||||
@@ -1024,8 +1025,7 @@ class SpecDecodeBaseProposer:
|
||||
gpu_input_batch: InputBatch,
|
||||
num_scheduled_tokens: dict[str, int],
|
||||
) -> torch.Tensor:
|
||||
"""
|
||||
This function is used to prepare the inputs for speculative decoding.
|
||||
"""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
|
||||
@@ -1057,8 +1057,7 @@ class SpecDecodeBaseProposer:
|
||||
gpu_input_batch: InputBatch,
|
||||
discard_request_mask: torch.Tensor,
|
||||
) -> tuple[torch.Tensor, torch.Tensor]:
|
||||
"""
|
||||
This function is used to prepare the inputs for speculative decoding.
|
||||
"""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. This is denoted
|
||||
@@ -1107,8 +1106,7 @@ class SpecDecodeBaseProposer:
|
||||
spec_decode_metadata: SpecDecodeMetadata,
|
||||
valid_sampled_tokens_count: torch.Tensor,
|
||||
) -> tuple[CommonAttentionMetadata, torch.Tensor, torch.Tensor]:
|
||||
"""
|
||||
This function is used to prepare the inputs for speculative decoding
|
||||
"""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
|
||||
@@ -1166,8 +1164,7 @@ class SpecDecodeBaseProposer:
|
||||
sampled_token_ids: list[list[int]],
|
||||
num_draft_tokens: list[int],
|
||||
) -> tuple[CommonAttentionMetadata, torch.Tensor]:
|
||||
"""
|
||||
This function is used to prepare the inputs for speculative decoding.
|
||||
"""This function is used to prepare the inputs for speculative decoding.
|
||||
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.
|
||||
@@ -1309,8 +1306,7 @@ class SpecDecodeBaseProposer:
|
||||
return base
|
||||
|
||||
def _get_model(self) -> nn.Module:
|
||||
"""
|
||||
Default method to call get_model(). Can be overridden by subclasses which
|
||||
"""Default method to call get_model(). Can be overridden by subclasses which
|
||||
need to customize model loading.
|
||||
"""
|
||||
from vllm.compilation.backends import set_model_tag
|
||||
@@ -1422,8 +1418,7 @@ class SpecDecodeBaseProposer:
|
||||
self.parallel_drafting_hidden_state_tensor.copy_(flat_mask)
|
||||
|
||||
def _maybe_share_embeddings(self, target_language_model: nn.Module) -> None:
|
||||
"""
|
||||
Some draft models may not have their own embedding layers, and some may
|
||||
"""Some draft models may not have their own embedding layers, and some may
|
||||
have a duplicate copy of the target model's embedding layers. In these cases,
|
||||
we share the target model's embedding layers with the draft model to save
|
||||
memory.
|
||||
@@ -1515,8 +1510,7 @@ class SpecDecodeBaseProposer:
|
||||
)
|
||||
|
||||
def _maybe_share_lm_head(self, target_language_model: nn.Module) -> None:
|
||||
"""
|
||||
Some draft models may not have their own LM head, and some may have a
|
||||
"""Some draft models may not have their own LM head, and some may have a
|
||||
duplicate copy of the target model's LM head. In these cases, we share
|
||||
the target model's LM head with the draft model to save memory.
|
||||
"""
|
||||
@@ -1680,8 +1674,7 @@ class SpecDecodeBaseProposer:
|
||||
self.model(**kwargs)
|
||||
|
||||
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
|
||||
"""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.
|
||||
@@ -1696,8 +1689,7 @@ class SpecDecodeBaseProposer:
|
||||
return use_aux_hidden_state
|
||||
|
||||
def validate_same_kv_cache_group(self, kv_cache_config: KVCacheConfig) -> None:
|
||||
"""
|
||||
Validate that all drafting layers belong to the same KVCacheGroup.
|
||||
"""Validate that all drafting layers belong to the same KVCacheGroup.
|
||||
Need this assumption to ensure all drafting layers can use the
|
||||
same AttentionMetadata.
|
||||
May extend to multiple AttentionMetadata in the future.
|
||||
@@ -1723,8 +1715,7 @@ class SpecDecodeBaseProposer:
|
||||
kv_cache_config: KVCacheConfig,
|
||||
kernel_block_sizes: list[int] | None = None,
|
||||
) -> None:
|
||||
"""
|
||||
Initialize AttentionGroups for draft layers using kv_cache_config.
|
||||
"""Initialize AttentionGroups for draft layers using kv_cache_config.
|
||||
Called from the model runner's initialize_metadata_builders.
|
||||
"""
|
||||
all_attn_layers = get_layers_from_vllm_config(
|
||||
|
||||
Reference in New Issue
Block a user