PinballLoss#

class PinballLoss(multioutput='uniform_average', score_average=True, alpha=None)[source]#

Pinball 损失，也称为分位数损失，用于分位数/区间预测。

参数：
multioutput{'raw_values', 'uniform_average'} 或形如 (n_outputs,) 的类数组，默认='uniform_average'

定义是否以及如何跨变量聚合指标。

  • 如果为 'uniform_average'（默认），则误差在变量之间取平均值。

  • 如果为类数组，则误差在变量之间加权平均，值作为权重。

  • 如果为 'raw_values'，则不跨变量平均误差，保留列。

score_average布尔值，可选，默认 = True

指定是否应平均每个分位数的分数。

  • 如果为 True，则指标/损失在 y_pred 中存在的所有分位数上取平均值。

  • 如果为 False，则指标/损失不跨分位数平均。

alpha (可选)浮点数，浮点数列表，或 1D 类数组，默认=None

用于评估指标的分位数。如果在使用指标时没有显式指定分位数，则可以指定此参数，例如通过 evaluate 进行基准测试，或通过 ForecastingGridSearchCV 进行调优时。

示例

>>> import numpy as np
>>> import pandas as pd
>>> from sktime.performance_metrics.forecasting.probabilistic import PinballLoss
>>> y_true = pd.Series([3, -0.5, 2, 7, 2])
>>> y_pred = pd.DataFrame({
...     ('Quantiles', 0.05): [1.25, 0, 1, 4, 0.625],
...     ('Quantiles', 0.5): [2.5, 0, 2, 8, 1.25],
...     ('Quantiles', 0.95): [3.75, 0, 3, 12, 1.875],
... })
>>> pl = PinballLoss()
>>> pl(y_true, y_pred)
np.float64(0.1791666666666667)
>>> pl = PinballLoss(score_average=False)
>>> pl(y_true, y_pred).to_numpy()
array([0.16625, 0.275  , 0.09625])
>>> y_true = pd.DataFrame({
...     "Quantiles1": [3, -0.5, 2, 7, 2],
...     "Quantiles2": [4, 0.5, 3, 8, 3],
... })
>>> y_pred = pd.DataFrame({
...     ('Quantiles1', 0.05): [1.5, -1, 1, 4, 0.65],
...     ('Quantiles1', 0.5): [2.5, 0, 2, 8, 1.25],
...     ('Quantiles1', 0.95): [3.5, 4, 3, 12, 1.85],
...     ('Quantiles2', 0.05): [2.5, 0, 2, 8, 1.25],
...     ('Quantiles2', 0.5): [5.0, 1, 4, 16, 2.5],
...     ('Quantiles2', 0.95): [7.5, 2, 6, 24, 3.75],
... })
>>> pl = PinballLoss(multioutput='raw_values')
>>> pl(y_true, y_pred).to_numpy()
array([0.16233333, 0.465     ])
>>> pl = PinballLoss(multioutput=np.array([0.3, 0.7]))
>>> pl(y_true, y_pred)
np.float64(0.3742000000000001)

方法

__call__(y_true, y_pred, **kwargs)

使用底层指标函数计算指标值。

clone()

获取具有相同超参数和配置的对象的克隆。

clone_tags(estimator[, tag_names])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([parameter_set])

使用第一个测试参数集构造类的一个实例。

create_test_instances_and_names([parameter_set])

创建所有测试实例及其名称列表。

evaluate(y_true, y_pred[, multioutput])

在给定输入上评估所需指标。

evaluate_by_index(y_true, y_pred[, multioutput])

返回在每个时间点评估的指标。

get_class_tag(tag_name[, tag_value_default])

从类获取类标签值，具有来自父类的标签级继承。

get_class_tags()

从类获取类标签，具有来自父类的标签级继承。

get_config()

获取自身的配置标志。

get_param_defaults()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值，具有标签级继承和覆盖。

get_tags()

从实例获取标签，具有标签级继承和覆盖。

get_test_params([parameter_set])

检索测试参数。

is_composite()

检查对象是否由其他 BaseObject 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

从序列化内存容器加载对象。

reset()

将对象重置为初始状态后的干净状态。

save([path, serialization_format])

将序列化的自身保存到字节类对象或 (.zip) 文件。

set_config(**config_dict)

将配置标志设置为给定值。

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为自身设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

将实例级标签覆盖设置为给定值。
classmethod get_test_params(parameter_set='default')[source]#

检索测试参数。

__call__(y_true, y_pred, **kwargs)[source]#

使用底层指标函数计算指标值。

参数：
y_true形如 (fh,) 或 (fh, n_outputs) 的 pd.Series、pd.DataFrame 或 np.array，其中 fh 是预测范围

真实（正确）目标值。

y_pred概率预测方法的返回值对象，科学类型为 scitype:y_pred

必须与 y_true 具有相同的预测范围和变量。

返回值：
loss浮点数或包含计算出的指标值（或多个值）的 1 列 pd.DataFrame

如果 multioutput = “raw_values”，则指标始终在 fh 值上取平均（算术平均），

将具有对应于 y_true 中变量的列级别

如果 multioutput = multioutput = “uniform_average” 或类数组

条目将在输出变量列上取平均值

如果 score_average = False，

将具有对应于分位数/区间的列级别

如果 score_average = True，

条目将在分位数/区间列上取平均值

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是一个没有共享引用的不同对象，处于初始状态后。此函数等同于返回 self 的 sklearn.clone。

等同于使用 self 的参数构造 type(self) 的新实例，即 type(self)(**self.get_params(deep=False))。

如果在 self 上设置了配置，克隆也将具有与原始相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

值也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

引发：
如果由于 __init__ 有误导致克隆不符合规范，则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

从另一个对象克隆标签作为动态覆盖。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是实例 self 特定的键值对，它们是对象构造后不会更改的静态标志。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法应仅在对象的 __init__ 方法中调用，即在构造期间或通过 __init__ 构造之后直接调用。

动态标签设置为 estimator 中标签的值，名称在 tag_names 中指定。

tag_names 的默认值是将 estimator 中的所有标签写入 self。

当前的标签值可以通过 get_tags 或 get_tag 检查。

参数：
estimator:class:BaseObject 或其派生类的一个实例
tag_names字符串或字符串列表，默认 = None

要克隆的标签名称。默认值（None）克隆 estimator 中的所有标签。

返回值：
self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

使用第一个测试参数集构造类的一个实例。

参数：
parameter_set字符串，默认=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回值：
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例及其名称列表。

参数：
parameter_set字符串，默认=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回值：
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names字符串列表，长度与 objs 相同

第 i 个元素是 objs 中第 i 个实例在测试中的名称。命名约定是如果实例多于一个，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

evaluate(y_true, y_pred, multioutput=None, **kwargs)[source]#

在给定输入上评估所需指标。

参数：
y_true形如 (fh,) 或 (fh, n_outputs) 的 pd.Series、pd.DataFrame 或 np.array，其中 fh 是预测范围

真实（正确）目标值。

y_pred概率预测方法的返回值对象，科学类型为 scitype:y_pred

必须与 y_true 具有相同的预测范围和变量

multioutput字符串 “uniform_average” 或 “raw_values”，决定如何处理多输出结果。
返回值：
loss浮点数或包含计算出的指标值（或多个值）的 1 列 pd.DataFrame

如果 multioutput = “raw_values”，则指标始终在 fh 值上取平均（算术平均），

将具有对应于 y_true 中变量的列级别

如果 multioutput = multioutput = “uniform_average” 或类数组

条目将在输出变量列上取平均值

如果 score_average = False，

将具有对应于分位数/区间的列级别

如果 score_average = True，

条目将在分位数/区间列上取平均值

evaluate_by_index(y_true, y_pred, multioutput=None, **kwargs)[source]#

返回在每个时间点评估的指标。

参数：
y_true形如 (fh,) 或 (fh, n_outputs) 的 pd.Series、pd.DataFrame 或 np.array，其中 fh 是预测范围

真实（正确）目标值。

y_pred概率预测方法的返回值对象，科学类型为 scitype:y_pred

必须与 y_true 具有相同的预测范围和变量

multioutput字符串 “uniform_average” 或 “raw_values”，决定如何处理多输出结果。
返回值：
loss长度为 len(fh) 的 pd.DataFrame，包含计算出的指标值（或多个值）

如果 multioutput = “raw_values”，则第 i 列包含在第 i 个 fh 元素处预测的指标值（或多个值），

将具有对应于 y_true 中变量的列级别

如果 multioutput = multioutput = “uniform_average” 或类数组

条目将在输出变量列上取平均值

如果 score_average = False，

将具有对应于分位数/区间的列级别

如果 score_average = True，

条目将在分位数/区间列上取平均值

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类获取类标签值，具有来自父类的标签级继承。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是实例 self 特定的键值对，它们是对象构造后不会更改的静态标志。

get_class_tag 方法是一个类方法，只考虑类级标签值和覆盖来检索标签的值。

它从对象中返回名称为 tag_name 的标签值，考虑了标签覆盖，优先级顺序如下降序排列

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要检索可能具有实例覆盖的标签值，请使用 get_tag 方法代替。

参数：
tag_name字符串

标签值的名称。

tag_value_default任何类型

未找到标签时的默认/备用值。

返回值：
tag_value

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

从类获取类标签，具有来自父类的标签级继承。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是实例 self 特定的键值对，它们是对象构造后不会更改的静态标志。

get_class_tags 方法是一个类方法，只考虑类级标签值和覆盖来检索标签的值。

它返回一个字典，其键是类或其任何父类中设置的 _tags 任何属性的键。

值是相应的标签值，覆盖顺序如下降序排列

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

实例可以根据超参数覆盖这些标签。

要检索可能具有实例覆盖的标签，请使用 get_tags 方法代替。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖。

要包含来自动态标签的覆盖，请使用 get_tags。

返回值：
collected_tags字典

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

配置是 self 的键值对，通常用作控制行为的瞬态标志。

get_config 返回动态配置，这些配置会覆盖默认配置。

默认配置在类或其父类的 _config 类属性中设置，并被通过 set_config 设置的动态配置覆盖。

配置在 clone 或 reset 调用下保留。

返回值：
config_dict字典

config_dict字典

配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集，然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。

classmethod get_param_defaults()[source]#

返回值：
获取对象的参数默认值。

default_dict: dict[str, Any]

键是 cls 中所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

参数：
获取对象的参数名称。

sort布尔值，默认=True

返回值：
是否按字母顺序（True）或按它们在类 __init__ 中出现的顺序（False）返回参数名称。

param_names: list[str]

cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的顺序排列。如果 sort=True，则按字母顺序排列。

获取此对象的参数值字典。

参数：
get_params(deep=True)[source]#

deep布尔值，默认=True

  • 是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 dict，包括组件的参数（= BaseObject 类型参数）。

返回值：
如果为 False，将返回此对象的参数名称 : 值 dict，但不包括组件的参数。

params键为字符串类型的字典

  • 参数字典，paramname : paramvalue 键值对包括

  • 始终：此对象的所有参数，通过 get_param_names 获取的值是该键的参数值，此对象的值始终与构造时传递的值相同

  • 如果 deep=True，也包含组件参数的键/值对，组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数都以 paramname 及其值的形式出现

如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

从实例获取标签值，具有标签级继承和覆盖。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是实例 self 特定的键值对，它们是对象构造后不会更改的静态标志。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑了标签覆盖，优先级顺序如下降序排列

通过 set_tags 或 clone_tags 在实例上设置的标签，

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

参数：
tag_name字符串

在实例构造时。

要检索的标签名称

tag_value_default任何类型，可选；默认=None

未找到标签时的默认/备用值

raise_error布尔值

返回值：
未找到标签时是否引发 ValueError

tag_valueAny

引发：
self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发错误，否则返回 tag_value_default。

ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

从实例获取标签，具有标签级继承和覆盖。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是实例 self 特定的键值对，它们是对象构造后不会更改的静态标志。

get_tags()[source]#

值是相应的标签值，覆盖顺序如下降序排列

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑了标签覆盖，优先级顺序如下降序排列

通过 set_tags 或 clone_tags 在实例上设置的标签，

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签，

按继承顺序。

返回值：
collected_tags字典

get_tags 方法返回一个标签字典，其键是类或其任何父类中设置的 _tags 任何属性的键，或通过 set_tags 或 clone_tags 设置的标签。

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性收集任何覆盖和新标签。

检查对象是否由其他 BaseObject 组成。

is_composite()[source]#

返回值：
复合对象是包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。

composite: 布尔值

对象是否有任何参数的值是 BaseObject 的后代实例。

从文件位置加载对象。

参数：
classmethod load_from_path(serial)[source]#
返回值：
serialZipFile(path).open(“object) 的结果
反序列化的自身，结果位于 path 处的 cls.save(path) 的输出

从序列化内存容器加载对象。

参数：
classmethod load_from_serial(serial)[source]#
返回值：
serialcls.save(None) 输出的第一个元素
反序列化的自身，结果是 serial，即 cls.save(None) 的输出

将对象重置为初始状态后的干净状态。

reset()[source]#

导致将 self 设置为构造函数调用后直接的状态，具有相同的超参数。通过 set_config 设置的配置值也保留。

  • 调用 reset 会删除任何对象属性，除了

  • 超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数

  • 包含双下划线的对象属性，即字符串 “__”。例如，名为 “__myattr” 的属性会保留。

配置属性，配置不变地保留。也就是说，reset 前后 get_config 的结果是相同的。

类和对象方法以及类属性也不受影响。

等同于 clone，不同之处在于 reset 修改 self 而不是返回新对象。

返回值：
self

调用 self.reset() 后，self 的值和状态与构造函数调用 type(self)(**self.get_params(deep=False)) 后获得的对象相同。

类实例重置为初始状态后的干净状态，但保留当前超参数值。

将序列化的自身保存到字节类对象或 (.zip) 文件。

save(path=None, serialization_format='pickle')[source]#

行为：如果 path 为 None，则返回一个内存中的序列化自身；如果 path 是文件位置，则将自身存储在该位置作为 zip 文件

参数：
保存的文件是 zip 文件，包含以下内容： _metadata - 包含自身的类，即 type(self) _obj - 序列化的自身。此类使用默认序列化（pickle）。

pathNone 或文件位置（字符串或 Path）

  • 如果为 None，则将自身保存到内存对象中；如果为文件位置，则将自身保存到该文件位置。如果

  • path=”estimator”，则会在当前工作目录创建 zip 文件 estimator.zip。

path=”/home/stored/estimator”，则会创建一个 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format: 字符串，默认 = “pickle”

返回值：
用于序列化的模块。可用选项为 “pickle” 和 “cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - 包含文件引用的 ZipFile

将配置标志设置为给定值。

参数：
config_dict字典

set_config(**config_dict)[source]#

配置名称 : 配置值对的字典。下面列出了有效的配置、值及其含义

display字符串，“diagram”（默认），或 “text”

  • jupyter 内核如何显示自身实例

  • “diagram” = html 框图表示

“text” = 字符串打印输出

print_changed_only布尔值，默认=True

打印自身时是否只列出与默认值不同的自身参数 (False)，还是所有参数名称和值 (False)。不嵌套，即只影响自身而不影响组件估计器。

warnings字符串，“on”（默认），或 “off”

  • 是否引发警告，仅影响来自 sktime 的警告

  • “on” = 将引发来自 sktime 的警告

“off” = 将不引发来自 sktime 的警告

backend:parallel字符串，可选，默认=”None”

  • 广播/向量化时用于并行化的后端，以下之一

  • “None”：顺序执行循环，简单的列表推导式

  • “loky”、“multiprocessing” 和 “threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要环境中包含 dask 包

“ray”：使用 ray，需要环境中包含 ray 包

backend:parallel:params字典，可选，默认={}（不传递参数）

  • 作为配置传递给并行化后端的附加参数。有效键取决于 backend:parallel 的值

  • “None”：无附加参数，backend_params 被忽略

  • “loky”、“multiprocessing” 和 “threading”：默认 joblib 后端，此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，但 backend 除外，因为它由 backend 直接控制。如果未传递 n_jobs，则默认为 -1，其他参数将默认为 joblib 的默认值。

  • “joblib”：自定义和第三方 joblib 后端，例如 spark。此处可以传递 joblib.Parallel 的任何有效键，例如 n_jobs，在这种情况下，backend 必须作为 backend_params 的一个键传递。如果未传递 n_jobs，则默认为 -1，其他参数将默认为 joblib 的默认值。

  • “dask”：可以传递 dask.compute 的任何有效键，例如 scheduler

    • “ray”：可以传递以下键

    • “ray_remote_args”：ray.init 的有效键字典

      “shutdown_ray”：布尔值，默认=True；False 阻止 ray 在并行化后

    • 关闭。

    • “logger_name”：字符串，默认=”ray”；要使用的日志记录器名称。

返回值：
“mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告

self自身的引用。

注意

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

设置此对象的参数。

set_params(**params)[source]#

参数：
此方法适用于简单的 skbase 对象以及复合对象。对于复合对象（即包含其他对象的对象），可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用明确（例如，没有两个组件参数具有相同的名称 <parameter>），也可以使用不带 <component>__ 的字符串 <parameter>。

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，如果它们在 get_params 键中是唯一的。

返回值：
self对 self 的引用（参数设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为自身设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希采样，并保证种子随机生成器的伪随机独立性。

根据 self_policy，适用于 self 中的 random_state 参数，以及当且仅当 deep=True 时适用于剩余的组件对象。

注意：即使 self 没有 random_state 参数，或者所有组件都没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使那些没有 random_state 参数的对象也会被重置。

参数：
random_stateint, RandomState 实例或 None, 默认 None

伪随机数生成器，用于控制随机整数的生成。传入 int 可使多次函数调用产生可复现的输出。

get_params(deep=True)[source]#

是否在 skbase 对象值参数中设置随机状态，即组件估计器。

  • 如果为 False，则只设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policystr, 以下之一: {“copy”, “keep”, “new”}, 默认 “copy”

  • “copy” : self.random_state 被设置为输入的 random_state

  • “keep” : self.random_state 保持不变

  • “new” : self.random_state 被设置为一个新的随机状态，

从输入的 random_state 派生，通常与输入的不同

返回值：
self对 self 的引用
set_tags(**tag_dict)[source]#

将实例级标签覆盖设置为给定值。

每个兼容 scikit-base 的对象都有一个标签字典。标签可用于存储对象的元数据，或控制对象的行为。

标签是实例 self 特定的键值对，它们是对象构造后不会更改的静态标志。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值，其中键是标签名称，字典值是要将标签设置到的值。

set_tags 方法只能在对象的 __init__ 方法中，在构造期间调用，或者在通过 __init__ 构造后直接调用。

当前的标签值可以通过 get_tags 或 get_tag 检查。

参数：
**tag_dict字典

标签名称：标签值 对的字典。

返回值：
Self

对 self 的引用。