mirror of
https://git.datalinker.icu/vllm-project/vllm.git
synced 2025-12-23 05:55:01 +08:00
2c174420f5
Signed-off-by: Alec Solder <alecs@fb.com> Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Co-authored-by: Alec Solder <alecs@fb.com> Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
79 lines
3.3 KiB
Python
79 lines
3.3 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
|
|
|
from typing import Any, Literal
|
|
|
|
from pydantic import model_validator
|
|
from pydantic.dataclasses import dataclass
|
|
from typing_extensions import Self
|
|
|
|
from vllm.config.utils import config
|
|
from vllm.utils.hashing import safe_hash
|
|
|
|
StructuredOutputsBackend = Literal[
|
|
"auto", "xgrammar", "guidance", "outlines", "lm-format-enforcer"
|
|
]
|
|
|
|
|
|
@config
|
|
@dataclass
|
|
class StructuredOutputsConfig:
|
|
"""Dataclass which contains structured outputs config for the engine."""
|
|
|
|
backend: StructuredOutputsBackend = "auto"
|
|
"""Which engine will be used for structured outputs (e.g. JSON schema,
|
|
regex, etc) by default. With "auto", we will make opinionated choices
|
|
based on request contents and what the backend libraries currently support,
|
|
so the behavior is subject to change in each release."""
|
|
disable_fallback: bool = False
|
|
"""If `True`, vLLM will not fallback to a different backend on error."""
|
|
disable_any_whitespace: bool = False
|
|
"""If `True`, json output will always be compact without any whitespace.
|
|
If `False`, the model may generate whitespace between JSON fields,
|
|
which is still valid JSON. This is only supported for xgrammar
|
|
and guidance backends."""
|
|
disable_additional_properties: bool = False
|
|
"""If `True`, the `guidance` backend will not use `additionalProperties`
|
|
in the JSON schema. This is only supported for the `guidance` backend and
|
|
is used to better align its behaviour with `outlines` and `xgrammar`."""
|
|
reasoning_parser: str = ""
|
|
"""Select the reasoning parser depending on the model that you're using.
|
|
This is used to parse the reasoning content into OpenAI API format."""
|
|
reasoning_parser_plugin: str = ""
|
|
"""Path to a dynamically reasoning parser plugin that can be dynamically
|
|
loaded and registered."""
|
|
enable_in_reasoning: bool = False
|
|
"""Whether to use structured input for reasoning."""
|
|
|
|
def compute_hash(self) -> str:
|
|
"""
|
|
WARNING: Whenever a new field is added to this config,
|
|
ensure that it is included in the factors list if
|
|
it affects the computation graph.
|
|
|
|
Provide a hash that uniquely identifies all the configs
|
|
that affect the structure of the computation
|
|
graph from input ids/embeddings to the final hidden states,
|
|
excluding anything before input ids/embeddings and after
|
|
the final hidden states.
|
|
"""
|
|
# no factors to consider.
|
|
# this config will not affect the computation graph.
|
|
factors: list[Any] = []
|
|
hash_str = safe_hash(str(factors).encode(), usedforsecurity=False).hexdigest()
|
|
return hash_str
|
|
|
|
@model_validator(mode="after")
|
|
def _validate_structured_output_config(self) -> Self:
|
|
if self.disable_any_whitespace and self.backend not in ("xgrammar", "guidance"):
|
|
raise ValueError(
|
|
"disable_any_whitespace is only supported for "
|
|
"xgrammar and guidance backends."
|
|
)
|
|
if self.disable_additional_properties and self.backend != "guidance":
|
|
raise ValueError(
|
|
"disable_additional_properties is only supported "
|
|
"for the guidance backend."
|
|
)
|
|
return self
|