Skip to content

TargetTags

yohou.utils.tags.TargetTags dataclass

Tags describing target (y) requirements.

Parameters

Name Type Description Default
required bool

Whether fit() requires the y parameter. False for unsupervised transformers.

False
min_value float or None

Minimum value constraint for target. If not None, target values must be greater than this value (exclusive).

None

Source Code

Show/Hide source
@dataclass
class TargetTags:
    """Tags describing target (y) requirements.

    Parameters
    ----------
    required : bool, default=False
        Whether fit() requires the y parameter. False for unsupervised transformers.
    min_value : float or None, default=None
        Minimum value constraint for target. If not None, target values must be
        greater than this value (exclusive).

    """

    required: bool = False
    min_value: float | None = None