Skip to content

get_scorer

yohou.metrics.get_scorer(name)

Get a scorer instance by name.

Parameters

Name Type Description Default
name str

Name of the scorer (e.g., "mae", "coverage"). See _SCORER_REGISTRY for available names.

 required

Returns

Type Description
BaseScorer

A default-configured scorer instance.

Raises

Type Description
ValueError

If the name is not in the registry.

Examples

>>> scorer = get_scorer("mae")
>>> type(scorer).__name__
'MeanAbsoluteError'

Source Code

View on GitHub

Show/Hide source 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def get_scorer(name: str) -> BaseScorer:
    """Get a scorer instance by name.

    Parameters
    ----------
    name : str
        Name of the scorer (e.g., ``"mae"``, ``"coverage"``).
        See ``_SCORER_REGISTRY`` for available names.

    Returns
    -------
    BaseScorer
        A default-configured scorer instance.

    Raises
    ------
    ValueError
        If the name is not in the registry.

    Examples
    --------
    >>> scorer = get_scorer("mae")
    >>> type(scorer).__name__
    'MeanAbsoluteError'

    """
    if name not in _SCORER_REGISTRY:
        available = sorted(_SCORER_REGISTRY.keys())
        raise ValueError(f"Unknown scorer {name!r}. Available: {available}")
    return _SCORER_REGISTRY[name]()