Skip to content

guidellm.data.finalizers.finalizer

DatasetFinalizer

Bases: Protocol[DataT_co]

Protocol for finalizing dataset rows into a desired data type.

Source code in src/guidellm/data/finalizers/finalizer.py
@runtime_checkable
class DatasetFinalizer(Protocol[DataT_co]):
    """
    Protocol for finalizing dataset rows into a desired data type.
    """

    def __init__(self, config: DataFinalizerArgs) -> None: ...

    def __call__(self, items: list[dict[str, Any]]) -> DataT_co: ...

FinalizerRegistry

Bases: RegistryMixin[type[DatasetFinalizer]]

Source code in src/guidellm/data/finalizers/finalizer.py
class FinalizerRegistry(RegistryMixin[type[DatasetFinalizer]]):
    @classmethod
    def create(cls, config: DataFinalizerArgs) -> DatasetFinalizer:
        """
        Factory method to create a DatasetFinalizer instance based on configuration.

        :param config: A DataFinalizerArgs object containing the configuration.
        """
        kind = config.kind
        finalizer_cls = cls.get_registered_object(kind)

        if finalizer_cls is None:
            raise ValueError(
                f"DatasetFinalizer type '{kind}' is not registered."
                f"Available types: {list(cls.registry.keys()) if cls.registry else []}"
            )

        return finalizer_cls(config)

create(config) classmethod

Factory method to create a DatasetFinalizer instance based on configuration.

Parameters:

Name Type Description Default
config DataFinalizerArgs

A DataFinalizerArgs object containing the configuration.

required
Source code in src/guidellm/data/finalizers/finalizer.py
@classmethod
def create(cls, config: DataFinalizerArgs) -> DatasetFinalizer:
    """
    Factory method to create a DatasetFinalizer instance based on configuration.

    :param config: A DataFinalizerArgs object containing the configuration.
    """
    kind = config.kind
    finalizer_cls = cls.get_registered_object(kind)

    if finalizer_cls is None:
        raise ValueError(
            f"DatasetFinalizer type '{kind}' is not registered."
            f"Available types: {list(cls.registry.keys()) if cls.registry else []}"
        )

    return finalizer_cls(config)