Skip to content

Replace {func} with mkdocs style links #18610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion vllm/model_executor/models/llava_next.py
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ def forward(
Unlike in LLaVA-1.5, the number of image tokens inputted to the language
model depends on the original size of the input image. Including the
original image token in the input, the required number of image tokens
is given by {func}`get_llava_next_image_feature_size`.
is given by [get_llava_next_image_feature_size][].

This way, the `positions` and `attn_metadata` are consistent
with the `input_ids`.
Expand Down
2 changes: 1 addition & 1 deletion vllm/multimodal/processing.py
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ def modality(self) -> str:


def full_groupby_modality(values: Iterable[_M]) -> ItemsView[str, list[_M]]:
"""Convenience function to apply {func}`full_groupby` based on modality."""
"""Convenience function to apply [full_groupby][] based on modality."""
return full_groupby(values, key=lambda x: x.modality)


Expand Down
4 changes: 2 additions & 2 deletions vllm/platforms/interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ def is_out_of_tree(self) -> bool:
return self._enum == PlatformEnum.OOT

def is_cuda_alike(self) -> bool:
"""Stateless version of {func}`torch.cuda.is_available`."""
"""Stateless version of [torch.cuda.is_available][]."""
return self._enum in (PlatformEnum.CUDA, PlatformEnum.ROCM)

def is_sleep_mode_available(self) -> bool:
Expand Down Expand Up @@ -194,7 +194,7 @@ def get_device_capability(
cls,
device_id: int = 0,
) -> Optional[DeviceCapability]:
"""Stateless version of {func}`torch.cuda.get_device_capability`."""
"""Stateless version of [torch.cuda.get_device_capability][]."""
return None

@classmethod
Expand Down
2 changes: 1 addition & 1 deletion vllm/sequence.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@


def array_full(token_id: int, count: int):
"""{class}`array` equivalent of {func}`numpy.full`."""
"""{class}`array` equivalent of [numpy.full][]."""
return array(VLLM_TOKEN_ID_ARRAY_TYPE, [token_id]) * count


Expand Down
2 changes: 1 addition & 1 deletion vllm/v1/worker/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ def gather_mm_placeholders(
"""
Reconstructs the embeddings from the placeholder tokens.

This is the operation of {func}`scatter_mm_placeholders`.
This is the operation of [scatter_mm_placeholders][].
"""
if is_embed is None:
return placeholders
Expand Down