Skip to content

check_reduction_strategy

yohou.testing.reduction.check_reduction_strategy(forecaster)

Check reduction_strategy parameter is valid.

Parameters

Name Type Description Default
forecaster BaseReductionForecaster

Reduction forecaster instance

 required

Raises

Type Description
AssertionError

If reduction_strategy is invalid

Source Code

View on GitHub

Show/Hide source 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def check_reduction_strategy(forecaster) -> None:
    """Check reduction_strategy parameter is valid.

    Parameters
    ----------
    forecaster : BaseReductionForecaster
        Reduction forecaster instance

    Raises
    ------
    AssertionError
        If reduction_strategy is invalid

    """
    if not hasattr(forecaster, "reduction_strategy"):
        # Not all reduction forecasters expose this parameter
        return

    strategy = forecaster.reduction_strategy
    valid_strategies = ["direct", "dir-rec", "multi-output"]

    assert strategy in valid_strategies, f"reduction_strategy should be in {valid_strategies}, got '{strategy}'"