skore/skore-hub-project/src/skore_hub_project/metric/rmse.py at 5e014db22fb2ca920b65ef14cb908b302b086a8c · probabl-ai/skore · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
"""Class definition of the payload used to send a RMSE metric to ``hub``."""

from __future__ import annotations

from typing import ClassVar, Literal

from .metric import CrossValidationReportMetric, EstimatorReportMetric


class Rmse(EstimatorReportMetric):  # noqa: D101
    accessor: ClassVar[Literal["metrics.rmse"]] = "metrics.rmse"
    name: Literal["rmse"] = "rmse"
    verbose_name: Literal["RMSE"] = "RMSE"
    greater_is_better: Literal[False] = False
    position: Literal[3] = 3


class RmseTrain(Rmse):  # noqa: D101
    data_source: Literal["train"] = "train"


class RmseTest(Rmse):  # noqa: D101
    data_source: Literal["test"] = "test"


class RmseMean(CrossValidationReportMetric):  # noqa: D101
    accessor: ClassVar[Literal["metrics.rmse"]] = "metrics.rmse"
    aggregate: ClassVar[Literal["mean"]] = "mean"
    name: Literal["rmse_mean"] = "rmse_mean"
    verbose_name: Literal["RMSE - MEAN"] = "RMSE - MEAN"
    greater_is_better: Literal[False] = False
    position: Literal[3] = 3


class RmseTrainMean(RmseMean):  # noqa: D101
    data_source: Literal["train"] = "train"


class RmseTestMean(RmseMean):  # noqa: D101
    data_source: Literal["test"] = "test"


class RmseStd(CrossValidationReportMetric):  # noqa: D101
    accessor: ClassVar[Literal["metrics.rmse"]] = "metrics.rmse"
    aggregate: ClassVar[Literal["std"]] = "std"
    name: Literal["rmse_std"] = "rmse_std"
    verbose_name: Literal["RMSE - STD"] = "RMSE - STD"
    greater_is_better: Literal[False] = False
    position: None = None


class RmseTrainStd(RmseStd):  # noqa: D101
    data_source: Literal["train"] = "train"


class RmseTestStd(RmseStd):  # noqa: D101
    data_source: Literal["test"] = "test"