InputTags

yohou.utils.tags.InputTags dataclass

Tags describing input requirements.

Parameters

Name	Type	Description	Default
requires_time_column	bool	Whether the estimator requires a "time" column in input DataFrames. All yohou estimators require this for temporal ordering.	True
pairwise	bool	Whether the estimator expects pairwise inputs (e.g., distance matrices).	False
allow_nan	bool	Whether NaN values are allowed in inputs.	False
min_value	float or None	Minimum value constraint for inputs. If not None, inputs must be greater than this value (exclusive). For example, log transforms require min_value=0.0 (inputs must be > 0).	None

Source Code

View on GitHub

Show/Hide source

@dataclass
class InputTags:
    """Tags describing input requirements.

    Parameters
    ----------
    requires_time_column : bool, default=True
        Whether the estimator requires a "time" column in input DataFrames.
        All yohou estimators require this for temporal ordering.
    pairwise : bool, default=False
        Whether the estimator expects pairwise inputs (e.g., distance matrices).
    allow_nan : bool, default=False
        Whether NaN values are allowed in inputs.
    min_value : float or None, default=None
        Minimum value constraint for inputs. If not None, inputs must be
        greater than this value (exclusive). For example, log transforms
        require min_value=0.0 (inputs must be > 0).

    """

    requires_time_column: bool = True
    pairwise: bool = False
    allow_nan: bool = False
    min_value: float | None = None