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:
Harry Mellor
2026-09-16 16:44:29 +00:00
committed by GitHub
co-authored by Claude Opus 5
parent 804e5377aa
commit 8c1557a79c
2002 changed files with 15024 additions and 14269 deletions
+15 -12
View File
@@ -331,8 +331,7 @@ def select_common_block_size(
kv_manager_block_size: int,
backends: list[type[AttentionBackend]],
) -> int:
"""
Select a block size that is supported by all backends and is a factor of
"""Select a block size that is supported by all backends and is a factor of
kv_manager_block_size.
If kv_manager_block_size is supported by all backends, return it directly.
@@ -347,6 +346,7 @@ def select_common_block_size(
Raises:
ValueError: If no valid block size found.
"""
def block_size_is_supported(
@@ -458,8 +458,7 @@ def allocate_kv_cache(
def prepare_kernel_block_sizes(
kv_cache_config: KVCacheConfig, attn_groups: list[list[AttentionGroup]]
) -> list[int]:
"""
Generate kernel_block_sizes that matches each block_size.
"""Generate kernel_block_sizes that matches each block_size.
For attention backends that support virtual block splitting,
use the supported block sizes from the backend.
@@ -471,6 +470,7 @@ def prepare_kernel_block_sizes(
Returns:
List of kernel block sizes for each cache group.
"""
kernel_block_sizes = []
for kv_cache_gid, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
@@ -505,8 +505,7 @@ def sanity_check_mm_encoder_outputs(
mm_embeddings: MultiModalEmbeddings,
expected_num_items: int,
) -> None:
"""
Perform sanity checks for the result of
"""Perform sanity checks for the result of
[`vllm.model_executor.models.SupportsMultiModal.embed_multimodal`][].
"""
assert isinstance(mm_embeddings, (list, tuple, torch.Tensor)), (
@@ -532,8 +531,7 @@ def sanity_check_mm_encoder_outputs(
def request_memory(init_snapshot: MemorySnapshot, cache_config: CacheConfig) -> int:
"""
Calculate the amount of memory required by vLLM, then validate
"""Calculate the amount of memory required by vLLM, then validate
that the current amount of free memory is sufficient for that.
"""
requested_memory = math.ceil(
@@ -559,8 +557,7 @@ def add_kv_sharing_layers_to_kv_cache_groups(
kv_cache_groups: list[KVCacheGroupSpec],
runner_only_attn_layers: set[str] | None = None,
) -> None:
"""
Sets up KV cache sharing by reusing the allocated KV caches in `kv_caches`
"""Sets up KV cache sharing by reusing the allocated KV caches in `kv_caches`
for layers that do not allocate its own KV cache, based on the mapping in
`shared_kv_cache_layers`. Adds these layers to the corresponding KV cache
group, which is needed to ensure that attention metadata is assigned later.
@@ -571,6 +568,9 @@ def add_kv_sharing_layers_to_kv_cache_groups(
means this layer will perform attention using the keys and values
from the KV cache of `shared_kv_cache_layers[layer_name]`.
kv_cache_groups: The KV cache groups of the model.
runner_only_attn_layers: Attention layers handled by the runner only,
which are excluded from the KV cache groups.
"""
if not shared_kv_cache_layers:
return
@@ -595,8 +595,7 @@ def bind_kv_cache(
num_attn_module: int = 1,
kv_cache_groups: Sequence[KVCacheGroupSpec] | None = None,
) -> None:
"""
Bind the allocated KV cache to both ModelRunner and forward context so
"""Bind the allocated KV cache to both ModelRunner and forward context so
that the KV cache can be used in the forward pass.
This function:
@@ -607,9 +606,13 @@ def bind_kv_cache(
Args:
kv_caches: The allocated kv_caches with layer names as keys.
num_attn_module: Number of attention modules per layer entry.
forward_context: The global forward context containing all Attention
layers with layer names as keys.
runner_kv_caches: The kv_cache declared by ModelRunner.
kv_cache_groups: The KV cache groups of the model, used to resolve
layers that share a KV cache.
"""
# Bind kv_caches to ModelRunner
assert len(runner_kv_caches) == 0