Unverified Commit 7d921649 authored by Cyrus Leung's avatar Cyrus Leung Committed by GitHub
Browse files

[Doc] Update references to doc files (#18637)


Signed-off-by: default avatarDarkLight1337 <tlleungac@connect.ust.hk>
parent 0ddf88e1
...@@ -58,7 +58,7 @@ pull_request_rules: ...@@ -58,7 +58,7 @@ pull_request_rules:
- files~=^benchmarks/structured_schemas/ - files~=^benchmarks/structured_schemas/
- files=benchmarks/benchmark_serving_structured_output.py - files=benchmarks/benchmark_serving_structured_output.py
- files=benchmarks/run_structured_output_benchmark.sh - files=benchmarks/run_structured_output_benchmark.sh
- files=docs/source/features/structured_outputs.md - files=docs/features/structured_outputs.md
- files=examples/offline_inference/structured_outputs.py - files=examples/offline_inference/structured_outputs.py
- files=examples/online_serving/openai_chat_completion_structured_outputs.py - files=examples/online_serving/openai_chat_completion_structured_outputs.py
- files=examples/online_serving/openai_chat_completion_structured_outputs_with_reasoning.py - files=examples/online_serving/openai_chat_completion_structured_outputs_with_reasoning.py
...@@ -135,9 +135,7 @@ pull_request_rules: ...@@ -135,9 +135,7 @@ pull_request_rules:
- files~=^tests/entrypoints/openai/tool_parsers/ - files~=^tests/entrypoints/openai/tool_parsers/
- files=tests/entrypoints/openai/test_chat_with_tool_reasoning.py - files=tests/entrypoints/openai/test_chat_with_tool_reasoning.py
- files~=^vllm/entrypoints/openai/tool_parsers/ - files~=^vllm/entrypoints/openai/tool_parsers/
- files=docs/source/features/tool_calling.md - files=docs/features/tool_calling.md
- files=docs/source/getting_started/examples/openai_chat_completion_client_with_tools.md
- files=docs/source/getting_started/examples/chat_with_tools.md
- files~=^examples/tool_chat_* - files~=^examples/tool_chat_*
- files=examples/offline_inference/chat_with_tools.py - files=examples/offline_inference/chat_with_tools.py
- files=examples/online_serving/openai_chat_completion_client_with_tools_required.py - files=examples/online_serving/openai_chat_completion_client_with_tools_required.py
......
...@@ -2,8 +2,8 @@ ...@@ -2,8 +2,8 @@
# to run the OpenAI compatible server. # to run the OpenAI compatible server.
# Please update any changes made here to # Please update any changes made here to
# docs/source/contributing/dockerfile/dockerfile.md and # docs/contributing/dockerfile/dockerfile.md and
# docs/source/assets/contributing/dockerfile-stages-dependency.png # docs/assets/contributing/dockerfile-stages-dependency.png
ARG CUDA_VERSION=12.8.1 ARG CUDA_VERSION=12.8.1
#################### BASE BUILD IMAGE #################### #################### BASE BUILD IMAGE ####################
......
...@@ -130,9 +130,8 @@ The PR needs to meet the following code quality standards: ...@@ -130,9 +130,8 @@ The PR needs to meet the following code quality standards:
understand the code. understand the code.
- Include sufficient tests to ensure the project stays correct and robust. This - Include sufficient tests to ensure the project stays correct and robust. This
includes both unit tests and integration tests. includes both unit tests and integration tests.
- Please add documentation to `docs/source/` if the PR modifies the - Please add documentation to `docs/` if the PR modifies the user-facing behaviors of vLLM.
user-facing behaviors of vLLM. It helps vLLM users understand and utilize the It helps vLLM users understand and utilize the new features or changes.
new features or changes.
### Adding or Changing Kernels ### Adding or Changing Kernels
......
...@@ -24,7 +24,7 @@ if printf '%s\n' "${FILES[@]}" | grep -q "^docker/Dockerfile$"; then ...@@ -24,7 +24,7 @@ if printf '%s\n' "${FILES[@]}" | grep -q "^docker/Dockerfile$"; then
fi fi
# Define the target file path # Define the target file path
TARGET_GRAPH_FILE="docs/source/assets/contributing/dockerfile-stages-dependency.png" TARGET_GRAPH_FILE="docs/assets/contributing/dockerfile-stages-dependency.png"
# Ensure target directory exists # Ensure target directory exists
mkdir -p "$(dirname "$TARGET_GRAPH_FILE")" mkdir -p "$(dirname "$TARGET_GRAPH_FILE")"
......
...@@ -988,7 +988,7 @@ class ModelConfig: ...@@ -988,7 +988,7 @@ class ModelConfig:
self.use_async_output_proc = False self.use_async_output_proc = False
return return
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
from vllm.platforms import current_platform from vllm.platforms import current_platform
if not current_platform.is_async_output_supported(self.enforce_eager): if not current_platform.is_async_output_supported(self.enforce_eager):
...@@ -1004,7 +1004,7 @@ class ModelConfig: ...@@ -1004,7 +1004,7 @@ class ModelConfig:
if self.runner_type == "pooling": if self.runner_type == "pooling":
self.use_async_output_proc = False self.use_async_output_proc = False
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
if speculative_config: if speculative_config:
self.use_async_output_proc = False self.use_async_output_proc = False
......
...@@ -1084,7 +1084,7 @@ class EngineArgs: ...@@ -1084,7 +1084,7 @@ class EngineArgs:
disable_log_stats=self.disable_log_stats, disable_log_stats=self.disable_log_stats,
) )
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
if self.num_scheduler_steps > 1: if self.num_scheduler_steps > 1:
if speculative_config is not None: if speculative_config is not None:
......
...@@ -67,7 +67,7 @@ class MultiStepOutputProcessor(SequenceGroupOutputProcessor): ...@@ -67,7 +67,7 @@ class MultiStepOutputProcessor(SequenceGroupOutputProcessor):
@staticmethod @staticmethod
@functools.lru_cache @functools.lru_cache
def _log_prompt_logprob_unsupported_warning_once(): def _log_prompt_logprob_unsupported_warning_once():
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
logger.warning( logger.warning(
"Prompt logprob is not supported by multi step workers. " "Prompt logprob is not supported by multi step workers. "
......
...@@ -75,7 +75,7 @@ class CpuPlatform(Platform): ...@@ -75,7 +75,7 @@ class CpuPlatform(Platform):
import vllm.envs as envs import vllm.envs as envs
from vllm.utils import GiB_bytes from vllm.utils import GiB_bytes
model_config = vllm_config.model_config model_config = vllm_config.model_config
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
if not model_config.enforce_eager: if not model_config.enforce_eager:
model_config.enforce_eager = True model_config.enforce_eager = True
......
...@@ -114,7 +114,7 @@ def create_spec_worker(*args, **kwargs) -> "SpecDecodeWorker": ...@@ -114,7 +114,7 @@ def create_spec_worker(*args, **kwargs) -> "SpecDecodeWorker":
return spec_decode_worker return spec_decode_worker
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
class SpecDecodeWorker(LoRANotSupportedWorkerBase): class SpecDecodeWorker(LoRANotSupportedWorkerBase):
"""Worker which implements speculative decoding. """Worker which implements speculative decoding.
......
...@@ -85,7 +85,7 @@ MULTIMODAL_MODEL_MAX_NUM_BATCHED_TOKENS = 5120 ...@@ -85,7 +85,7 @@ MULTIMODAL_MODEL_MAX_NUM_BATCHED_TOKENS = 5120
# Exception strings for non-implemented encoder/decoder scenarios # Exception strings for non-implemented encoder/decoder scenarios
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
STR_NOT_IMPL_ENC_DEC_SWA = \ STR_NOT_IMPL_ENC_DEC_SWA = \
......
...@@ -824,7 +824,7 @@ def _pythonize_sampler_output( ...@@ -824,7 +824,7 @@ def _pythonize_sampler_output(
for sgdx, (seq_group, for sgdx, (seq_group,
sample_result) in enumerate(zip(seq_groups, samples_list)): sample_result) in enumerate(zip(seq_groups, samples_list)):
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
# (Check for Guided Decoding) # (Check for Guided Decoding)
if seq_group.sampling_params.logits_processors: if seq_group.sampling_params.logits_processors:
......
...@@ -14,7 +14,7 @@ def assert_enc_dec_mr_supported_scenario( ...@@ -14,7 +14,7 @@ def assert_enc_dec_mr_supported_scenario(
a supported scenario. a supported scenario.
''' '''
# Reminder: Please update docs/source/features/compatibility_matrix.md # Reminder: Please update docs/features/compatibility_matrix.md
# If the feature combo become valid # If the feature combo become valid
if enc_dec_mr.cache_config.enable_prefix_caching: if enc_dec_mr.cache_config.enable_prefix_caching:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment