Skip to content

guidellm.benchmark.schemas.output

BenchmarkOutputArgs

Bases: PydanticClassRegistryMixin['BenchmarkOutputArgs'], ABC

Base class for output creation arguments.

This class serves as a base for defining argument models used in the creation of output instances. It inherits from PydanticClassRegistryMixin to enable automatic registration of subclasses, allowing for flexible and extensible output configurations.

Attributes:

Name Type Description
schema_discriminator str

Field name for polymorphic deserialization

Source code in src/guidellm/benchmark/schemas/output.py
class BenchmarkOutputArgs(PydanticClassRegistryMixin["BenchmarkOutputArgs"], ABC):
    """Base class for output creation arguments.

    This class serves as a base for defining argument models used in the creation
    of output instances. It inherits from PydanticClassRegistryMixin to enable
    automatic registration of subclasses, allowing for flexible and extensible
    output configurations.

    :cvar schema_discriminator: Field name for polymorphic deserialization
    """

    model_config = standard_model_config()

    schema_discriminator: ClassVar[str] = "kind"

    @classmethod
    def __pydantic_schema_base_type__(cls) -> type[BenchmarkOutputArgs]:
        """
        Return base type for polymorphic validation hierarchy.

        :return: Base BenchmarkOutputArgs class for schema validation
        """
        if cls.__name__ == "BenchmarkOutputArgs":
            return cls

        return BenchmarkOutputArgs

    kind: str = Field(
        description="Type identifier for the output configuration.",
    )

__pydantic_schema_base_type__() classmethod

Return base type for polymorphic validation hierarchy.

Returns:

Type Description
type[BenchmarkOutputArgs]

Base BenchmarkOutputArgs class for schema validation

Source code in src/guidellm/benchmark/schemas/output.py
@classmethod
def __pydantic_schema_base_type__(cls) -> type[BenchmarkOutputArgs]:
    """
    Return base type for polymorphic validation hierarchy.

    :return: Base BenchmarkOutputArgs class for schema validation
    """
    if cls.__name__ == "BenchmarkOutputArgs":
        return cls

    return BenchmarkOutputArgs