MedianSquaredScaledError#

class MedianSquaredScaledError(multioutput='uniform_average', multilevel='uniform_average', sp=1, square_root=False, by_index=False)[source]#

中位数平方比例误差 (MdSSE) 或根中位数平方比例误差 (RMdSSE)。

如果 square_root 为 False，则计算 MdSSE，否则如果 square_root 为 True，则计算 RMdSSE。MdSSE 和 RMdSSE 的输出都是非负浮点数。最佳值为 0.0。

这是 MdASE 损失度量的平方变体。与 MASE 和其他比例性能度量一样，这个无量纲度量可用于在单个时间序列上或跨时间序列比较预测方法。

这个度量也适用于间歇需求时间序列，因为它不会给出无穷大或未定义的值，除非训练数据是平坦的时间序列。在这种情况下，函数返回一个很大的值而不是无穷大。

适用于具有同质季节周期的多输出（多元）时间序列数据。

参数:

spint, 默认 = 1

数据的季节周期。

square_rootbool, 默认 = False

是否对度量取平方根

multioutput{'raw_values', 'uniform_average'} 或形状为 (n_outputs,) 的类数组, 默认='uniform_average'

定义如何聚合多变量（多输出）数据的度量。

如果是类数组，则将其值用作平均误差的权重。
如果是 'raw_values'，则在多输出输入的情况下返回完整的误差集。
如果是 'uniform_average'，则所有输出的误差以均匀权重进行平均。

multilevel{'raw_values', 'uniform_average', 'uniform_average_time'}

定义如何聚合分层数据（含层级）的度量。

如果是 'uniform_average' (默认)，误差在各层级上取平均值。
如果是 'uniform_average_time'，度量应用于所有数据，忽略层级索引。
如果是 'raw_values'，则不对跨层级的误差进行平均，保留层级结构。

by_indexbool, 默认=False

确定在直接调用度量对象时是否对时间点进行平均。

如果为 False，则直接调用度量对象将对时间点进行平均，相当于调用 evaluate 方法。
如果为 True，则直接调用度量对象将计算每个时间点的度量，相当于调用 evaluate_by_index 方法。

另请参阅

MeanAbsoluteScaledError
MedianAbsoluteScaledError
MedianSquaredScaledError

参考

M5 竞赛指南。

https://mofc.unic.ac.cy/wp-content/uploads/2020/03/M5-Competitors-Guide-Final-10-March-2020.docx

Hyndman, R. J and Koehler, A. B. (2006). “Another look at measures of forecast accuracy”, International Journal of Forecasting, Volume 22, Issue 4.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import MedianSquaredScaledError
>>> y_train = np.array([5, 0.5, 4, 6, 3, 5, 2])
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> rmdsse = MedianSquaredScaledError(square_root=True)
>>> rmdsse(y_true, y_pred, y_train=y_train)
np.float64(0.16666666666666666)
>>> y_train = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> rmdsse(y_true, y_pred, y_train=y_train)
np.float64(0.1472819539849714)
>>> rmdsse = MedianSquaredScaledError(multioutput='raw_values', square_root=True)
>>> rmdsse(y_true, y_pred, y_train=y_train)
array([0.08687445, 0.20203051])
>>> rmdsse = MedianSquaredScaledError(multioutput=[0.3, 0.7], square_root=True)
>>> rmdsse(y_true, y_pred, y_train=y_train)
np.float64(0.16914781383660782)

方法

`__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, **kwargs)	在给定的输入上评估期望的度量。
`evaluate_by_index`(y_true, y_pred, **kwargs)	返回在每个时间点评估的度量。
`func`(y_pred[, sp, horizon_weight, ...])	中位数平方比例误差 (MdSSE) 或根中位数平方比例误差 (RMdSSE)。
`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)	将实例级别的标签覆盖设置为给定值。

func(y_pred, sp=1, horizon_weight=None, multioutput='uniform_average', square_root=False, **kwargs)[source]#

中位数平方比例误差 (MdSSE) 或根中位数平方比例误差 (RMdSSE)。

如果 square_root 为 False，则计算 MdSSE，否则如果 square_root 为 True，则计算 RMdSSE。MdSSE 和 RMdSSE 的输出都是非负浮点数。最佳值为 0.0。

这是 MdASE 损失度量的平方变体。与 MASE 和其他比例性能度量一样，这个无量纲度量可用于在单个时间序列上或跨时间序列比较预测方法。

这个度量也适用于间歇需求时间序列，因为它不会给出无穷大或未定义的值，除非训练数据是平坦的时间序列。在这种情况下，函数返回一个很大的值而不是无穷大。

适用于具有同质季节周期的多输出（多元）时间序列数据。

参数:

y_truepd.Series, pd.DataFrame 或 shape 为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围: 真实（正确）目标值。
y_predpd.Series, pd.DataFrame 或 shape 为 (fh,) 或 (fh, n_outputs) 的 np.array，其中 fh 是预测范围: 预测值。
y_trainpd.Series, pd.DataFrame 或 shape 为 (n_timepoints,) 或 (n_timepoints, n_outputs) 的 np.array, 默认 = None: 观测到的训练值。
spint: 训练数据的季节周期。
horizon_weightshape 为 (fh,) 的类数组, 默认=None: 预测范围权重。
multioutput{'raw_values', 'uniform_average'} 或形状为 (n_outputs,) 的类数组, 默认='uniform_average': 定义如何聚合多变量（多输出）数据的度量。如果是类数组，则将其值用作平均误差的权重。如果是“raw_values”，则在多输出输入的情况下返回完整的误差集。如果是“uniform_average”，则所有输出的误差以均匀权重进行平均。

返回:

lossfloat: RMdSSE 损失。如果 multioutput 是“raw_values”，则为每个输出单独返回 RMdSSE。如果 multioutput 是“uniform_average”或权重 ndarray，则返回所有输出误差的加权平均 RMdSSE。

另请参阅

mean_absolute_scaled_error
median_absolute_scaled_error
mean_squared_scaled_error

参考

M5 竞赛指南。

https://mofc.unic.ac.cy/wp-content/uploads/2020/03/M5-Competitors-Guide-Final-10-March-2020.docx

Hyndman, R. J and Koehler, A. B. (2006). “Another look at measures of forecast accuracy”, International Journal of Forecasting, Volume 22, Issue 4.

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import median_squared_scaled_error
>>> y_train = np.array([5, 0.5, 4, 6, 3, 5, 2])
>>> y_true = np.array([3, -0.5, 2, 7, 2])
>>> y_pred = np.array([2.5, 0.0, 2, 8, 1.25])
>>> median_squared_scaled_error(y_true, y_pred, y_train=y_train, square_root=True)
0.16666666666666666
>>> y_train = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_true = np.array([[0.5, 1], [-1, 1], [7, -6]])
>>> y_pred = np.array([[0, 2], [-1, 2], [8, -5]])
>>> median_squared_scaled_error(y_true, y_pred, y_train=y_train, square_root=True)
0.1472819539849714
>>> median_squared_scaled_error(y_true, y_pred, y_train=y_train,     multioutput='raw_values', square_root=True)
array([0.08687445, 0.20203051])
>>> median_squared_scaled_error(y_true, y_pred, y_train=y_train,     multioutput=[0.3, 0.7], square_root=True)
0.16914781383660782

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

返回估计器的测试参数设置。

参数:

parameter_setstr, 默认=”default”: 要返回的测试参数集的名称，用于测试。如果没有为值定义特殊参数，将返回 "default" 集。

返回:

paramsdict 或 list of dict, 默认 = {}: 用于创建类的测试实例的参数。每个 dict 都是用于构造一个“有趣”的测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

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

使用底层度量函数计算度量值。

参数:

y_true采用 sktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象的 scitype。

Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

关于数据格式的更多细节，请参阅 mtype 的术语表。用法请参阅预测教程 examples/01_forecasting.ipynb

y_pred采用 sktime 兼容数据容器格式的时间序列

用于评估预测值与真实值之间差异的值。必须与 y_true 格式相同，如果索引化，则索引和列也必须相同。

y_pred_benchmark可选，采用 sktime 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测，用于相对度量。仅当度量需要基准预测时才需要，如标签 requires-y-pred-benchmark 所示。否则，可以传递以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果索引化，则索引和列也必须相同。

y_train可选，采用 sktime 兼容数据容器格式的时间序列

用于归一化误差度量的训练数据。仅当度量需要训练数据时才需要，如标签 requires-y-train 所示。否则，可以传递以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果索引化，则列也必须相同，但不一定具有相同的索引。

sample_weight可选，1D 类数组或可调用对象，默认=None

每个时间点的样本权重。

如果是 None，则时间索引被视为具有相同的权重。
如果是数组，则必须是 1D。如果 y_true 和 y_pred 是单个时间序列，sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则传递的所有时间序列实例的每个个体时间序列的长度必须相同，并等于 sample_weight 的长度。
如果是可调用对象，则必须遵循 SampleWeightGenerator 接口，或者具有以下签名之一：y_true: pd.DataFrame -> 1D array-like 或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回:

lossfloat, np.ndarray, 或 pd.DataFrame

计算的度量，平均值或按变量计算。如果提供 sample_weight，则按其加权。

如果 multioutput="uniform_average" 或类数组，且 ``multilevel="uniform_average" 或 “uniform_average_time”`` 为 float。该值是跨变量和跨层级的平均度量（参见类文档字符串）
如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time"，则为 shape (y_true.columns,) 的 np.ndarray。第 i 个条目是为第 i 个变量计算的度量
如果 multilevel="raw_values"，则为 pd.DataFrame。如果 multioutput="uniform_average"，则 shape 为 (n_levels,)；如果 multioutput="raw_values"，则 shape 为 (n_levels, y_true.columns)。度量按层级应用，行平均（是/否）与 multioutput 中的方式相同。

clone()[source]#

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

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

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

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

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

抛出:

如果克隆不符合要求，则抛出 RuntimeError，这可能是由于错误的 __init__ 引起的。

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_namesstr 或 list of str, 默认 = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self: 对 self 的引用。

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

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

参数:

parameter_setstr, 默认=”default”: 要返回的测试参数集的名称，用于测试。如果没有为值定义特殊参数，将返回 “default” 集。

返回:

instance具有默认参数的类的实例

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

创建所有测试实例的列表以及它们的名称列表。

参数:

parameter_setstr, 默认=”default”: 要返回的测试参数集的名称，用于测试。如果没有为值定义特殊参数，将返回 “default” 集。

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
namesstr 列表，长度与 objs 相同: 第 i 个元素是测试中 objs 中第 i 个实例的名称。命名约定是，如果实例多于一个，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

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

在给定的输入上评估期望的度量。

参数:

y_true采用 sktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象的 scitype。

Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

关于数据格式的更多细节，请参阅 mtype 的术语表。用法请参阅预测教程 examples/01_forecasting.ipynb

y_pred采用 sktime 兼容数据容器格式的时间序列

用于评估预测值与真实值之间差异的值。必须与 y_true 格式相同，如果索引化，则索引和列也必须相同。

y_pred_benchmark可选，采用 sktime 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测，用于相对度量。仅当度量需要基准预测时才需要，如标签 requires-y-pred-benchmark 所示。否则，可以传递以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果索引化，则索引和列也必须相同。

y_train可选，采用 sktime 兼容数据容器格式的时间序列

用于归一化误差度量的训练数据。仅当度量需要训练数据时才需要，如标签 requires-y-train 所示。否则，可以传递以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果索引化，则列也必须相同，但不一定具有相同的索引。

sample_weight可选，1D 类数组或可调用对象，默认=None

每个时间点的样本权重或可调用对象。

如果是 None，则时间索引被视为具有相同的权重。
如果是数组，则必须是 1D。如果 y_true 和 y_pred 是单个时间序列，sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则传递的所有时间序列实例的每个个体时间序列的长度必须相同，并等于 sample_weight 的长度。
如果是可调用对象，则必须遵循 SampleWeightGenerator 接口，或者具有以下签名之一：y_true: pd.DataFrame -> 1D array-like 或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回:

lossfloat, np.ndarray, 或 pd.DataFrame

计算的度量，平均值或按变量计算。如果提供 sample_weight，则按其加权。

如果 multioutput="uniform_average" 或类数组，且 ``multilevel="uniform_average" 或 “uniform_average_time”`` 为 float。该值是跨变量和跨层级的平均度量（参见类文档字符串）
如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time"，则为 shape (y_true.columns,) 的 np.ndarray。第 i 个条目是为第 i 个变量计算的度量
如果 multilevel="raw_values"，则为 pd.DataFrame。如果 multioutput="uniform_average"，则 shape 为 (n_levels,)；如果 multioutput="raw_values"，则 shape 为 (n_levels, y_true.columns)。度量按层级应用，行平均（是/否）与 multioutput 中的方式相同。

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

返回在每个时间点评估的度量。

参数:

y_true采用 sktime 兼容数据容器格式的时间序列。

真实（正确）目标值。

sktime 中的个体数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象的 scitype。

Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或 Series 类型的 pd.DataFrame 的 list
Hierarchical scitype = 分层集合，用于分层预测。具有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 pd.DataFrame

关于数据格式的更多细节，请参阅 mtype 的术语表。用法请参阅预测教程 examples/01_forecasting.ipynb

y_pred采用 sktime 兼容数据容器格式的时间序列

用于评估预测值与真实值之间差异的值。必须与 y_true 格式相同，如果索引化，则索引和列也必须相同。

y_pred_benchmark可选，采用 sktime 兼容数据容器格式的时间序列

用于比较 y_pred 的基准预测，用于相对度量。仅当度量需要基准预测时才需要，如标签 requires-y-pred-benchmark 所示。否则，可以传递以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果索引化，则索引和列也必须相同。

y_train可选，采用 sktime 兼容数据容器格式的时间序列

用于归一化误差度量的训练数据。仅当度量需要训练数据时才需要，如标签 requires-y-train 所示。否则，可以传递以确保接口一致性，但会被忽略。必须与 y_true 格式相同，如果索引化，则列也必须相同，但不一定具有相同的索引。

sample_weight可选，1D 类数组或可调用对象，默认=None

每个时间点的样本权重或可调用对象。

如果是 None，则时间索引被视为具有相同的权重。
如果是数组，则必须是 1D。如果 y_true 和 y_pred 是单个时间序列，sample_weight 的长度必须与 y_true 相同。如果时间序列是面板或分层的，则传递的所有时间序列实例的每个个体时间序列的长度必须相同，并等于 sample_weight 的长度。
如果是可调用对象，则必须遵循 SampleWeightGenerator 接口，或者具有以下签名之一：y_true: pd.DataFrame -> 1D array-like 或 y_true: pd.DataFrame x y_pred: pd.DataFrame -> 1D array-like。

返回:

losspd.Series 或 pd.DataFrame

计算的度量，按时间点计算（默认=jackknife 伪值）。如果提供 sample_weight，则按其加权。

如果 multioutput="uniform_average" 或类数组，则为 pd.Series。索引与 y_true 的索引相同；索引 i 处的条目是时间 i 的度量，跨变量平均。
如果 multioutput="raw_values"，则为 pd.DataFrame。索引和列与 y_true 相同；i,j 处的条目是时间 i、变量 j 的度量。

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

从类中获取类标签值，并继承父类的标签级别。

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

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

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

它返回对象中名称为 tag_name 的标签值，并考虑标签覆盖，优先级按以下降序排列：

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

按继承顺序。

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

要检索可能包含实例覆盖的标签值，请使用 get_tag 方法。

参数:

tag_namestr: 标签值的名称。
tag_value_default任何类型: 如果未找到标签，则使用默认/回退值。

返回:

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

classmethod get_class_tags()[source]#

从类中获取类标签，并继承父类的标签级别。

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

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

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

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

值是相应的标签值，覆盖按以下降序排列：

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

按继承顺序。

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

要检索可能包含实例覆盖的标签，请使用 get_tags 方法。

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

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

返回:

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

get_config()[source]#

获取自身的配置标志。

Config 是 self 的键值对，通常用作控制行为的临时标志。

get_config 返回动态配置，它们会覆盖默认配置。

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

Config 在 clone 或 reset 调用时保留。

返回:

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

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]: 键是 cls 的所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:

sortbool, 默认=True: 是否按字母顺序（True）或按它们在类 __init__ 中出现的顺序（False）返回参数名称。

返回:

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

get_params(deep=True)[source]#

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

参数:

deepbool, 默认=True

是否返回组件的参数。

如果为 True，将返回此对象的参数名称：值字典，包括组件的参数（= BaseObject 值参数）。
如果为 False，将返回此对象的参数名称：值字典，但不包括组件的参数。

返回:

params键为 str 的 dict

参数字典，参数名：参数值键值对包括

始终：此对象的所有参数，通过 get_param_names 获取，值是该键的参数值，此对象的值始终与构造时传递的值相同
如果 deep=True，还包含组件参数的键/值对，组件参数的索引形式为 [componentname]__[paramname]，componentname 的所有参数以 paramname 形式及其值出现
如果 deep=True，还包含任意层级的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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

从实例中获取标签值，并考虑标签级别的继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，并考虑标签覆盖，优先级按以下降序排列：

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

在实例构建时。

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

按继承顺序。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任何类型，可选；默认=None: 如果未找到标签，则使用默认/回退值
raise_errorbool: 未找到标签时是否抛出 ValueError

返回:

tag_valueAny: self 中 tag_name 标签的值。如果未找到，则在 raise_error 为 True 时抛出错误，否则返回 tag_value_default。

抛出:

ValueError，如果 raise_error 为 True。: 如果 tag_name 不在 self.get_tags().keys() 中，则会抛出 ValueError。

get_tags()[source]#

从实例中获取标签，并考虑标签级别的继承和覆盖。

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

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

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

值是相应的标签值，覆盖按以下降序排列：

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

在实例构建时。

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

按继承顺序。

返回:

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

is_composite()[source]#

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

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

返回:

composite: bool: 对象的任何参数的值是否为 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.reset() 后，self 的值和状态与构造函数调用 type(self)(**self.get_params(deep=False)) 后获得的对象相同。

返回:

self: 类实例重置到一个干净的初始化后状态，但保留当前的超参数值。

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

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

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

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

参数:

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

如果为 None，则将 self 保存到内存对象；如果是文件位置，则将 self 保存到该文件位置。如果

path=”estimator”，则会在当前工作目录 (cwd) 创建一个名为 estimator.zip 的 zip 文件。
path=”/home/stored/estimator”，则会创建一个名为 estimator.zip 的 zip 文件，

存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

用于序列化的模块。可用选项包括“pickle”和“cloudpickle”。请注意，非默认格式可能需要安装其他软依赖项。

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

displaystr，“diagram”（默认），或“text”

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool，默认=True

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

warningsstr，“on”（默认），或“off”

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

“on” = 将发出来自 sktime 的警告
“off” = 将不会发出来自 sktime 的警告

backend:parallelstr，可选，默认=”None”

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

“None”：按顺序执行循环，简单的列表推导
“loky”、“multiprocessing” 和 “threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要在环境中安装 dask 包
“ray”：使用 ray，需要在环境中安装 ray 包

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

作为配置传递给并行化后端的附加参数。有效键取决于 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”：bool，默认=True；False 可阻止 ray 在并行化后
  关闭。
- “logger_name”：str，默认=”ray”；要使用的日志记录器名称。
- “mute_warnings”：bool，默认=False；如果为 True，则抑制警告

返回:

self对 self 的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:

\*\*paramsdict: 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 中的 random_state 参数（取决于 self_policy），并且仅当 deep=True 时适用于其余组件对象。

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

参数:

random_stateint, RandomState 实例或 None，默认=None

伪随机数生成器，用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。

deepbool, 默认=True

是否在具有 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_dictdict: 标签名称 : 标签值对的字典。

返回:

Self: 对 self 的引用。