均方尺度误差#

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

均方尺度误差 (MSSE) 或均方根尺度误差 (RMSSE)。

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

这是 MASE 损失度量的一种平方变体。与 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 和 Koehler, A. B. (2006)。“预测准确度度量的另一视角”，国际预测期刊，第 22 卷，第 4 期。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import MeanSquaredScaledError
>>> 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])
>>> rmsse = MeanSquaredScaledError(square_root=True)
>>> rmsse(y_true, y_pred, y_train=y_train)
np.float64(0.20568833780186058)
>>> 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]])
>>> rmsse(y_true, y_pred, y_train=y_train)
np.float64(0.15679361328058636)
>>> rmsse = MeanSquaredScaledError(multioutput='raw_values', square_root=True)
>>> rmsse(y_true, y_pred, y_train=y_train)
array([0.11215443, 0.20203051])
>>> rmsse = MeanSquaredScaledError(multioutput=[0.3, 0.7], square_root=True)
>>> rmsse(y_true, y_pred, y_train=y_train)
np.float64(0.17451891814894502)

方法

__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, ...])

均方尺度误差 (MSSE) 或均方根尺度误差 (RMSSE)。

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()

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

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)[源]#

均方尺度误差 (MSSE) 或均方根尺度误差 (RMSSE)。

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

这是 MASE 损失度量的一种平方变体。与 MASE 和其他尺度性能指标一样，这个无尺度指标可用于比较单条时间序列或多条时间序列上的预测方法。

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

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

参数:
y_truesktime 兼容数据容器格式的时间序列。形状为 (fh,) 或 (fh, n_outputs)，其中 fh 是预测范围。

真实值（正确）目标值。

y_predsktime 兼容数据容器格式的时间序列。形状为 (fh,) 或 (fh, n_outputs)，其中 fh 是预测范围。

预测值。

y_train可选，sktime 兼容数据容器格式的时间序列。形状为 (n_timepoints,) 或 (n_timepoints, n_outputs)，默认值 = None。

观测到的训练值。

spint

训练数据的季节周期性。

horizon_weight形状为 (fh,) 的类似数组，默认值=None

预测范围权重。

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

定义如何聚合多元（多输出）数据的指标。如果为类似数组，则其值用作平均误差的权重。如果为 ‘raw_values’，则在多输出输入的情况下返回完整的误差集。如果为 ‘uniform_average’，则所有输出的误差以均匀权重进行平均。

square_rootbool, 默认值=False

是否对均方尺度误差取平方根。如果为 True，返回均方根尺度误差 (RMSSE)；如果为 False，返回均方尺度误差 (MSSE)。

返回值:
lossfloat

RMSSE 损失。如果 multioutput 为 ‘raw_values’，则为每个输出分别返回 MSSE 或 RMSSE。如果 multioutput 为 ‘uniform_average’ 或 ndarray 权重，则返回所有输出误差的加权平均 MSSE 或 RMSSE。

另请参阅

mean_absolute_scaled_error
median_absolute_scaled_error
median_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 和 Koehler, A. B. (2006)。“预测准确度度量的另一视角”，国际预测期刊，第 22 卷，第 4 期。

示例

>>> import numpy as np
>>> from sktime.performance_metrics.forecasting import mean_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])
>>> mean_squared_scaled_error(y_true, y_pred, y_train=y_train, square_root=True)
0.20568833780186058
>>> 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]])
>>> mean_squared_scaled_error(y_true, y_pred, y_train=y_train,  square_root=True)
0.15679361328058636
>>> mean_squared_scaled_error(y_true, y_pred, y_train=y_train,     multioutput='raw_values', square_root=True)
array([0.11215443, 0.20203051])
>>> mean_squared_scaled_error(y_true, y_pred, y_train=y_train,     multioutput=[0.3, 0.7], square_root=True)
0.17451891814894502
classmethod get_test_params(parameter_set='default')[源]#

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

参数:
parameter_setstr, 默认值=”default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则返回 "default" 集。

返回值:
paramsdict 或 list of dict, 默认值 = {}

用于创建类的测试实例的参数字典或字典列表。每个字典都是构造一个“有趣的”测试实例的参数，例如 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一一个）字典。

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

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

参数:
y_truesktime 兼容数据容器格式的时间序列。

真实值（正确）目标值。

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

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行有 2 级 MultiIndex（实例，时间）、3D np.ndarray（实例，变量，时间）、Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行有 3 级或更多级别 MultiIndex（层次结构_1，...，层次结构_n，时间）

有关数据格式的更多详细信息，请参见 glossary 中的 mtype。有关用法，请参见 forecasting tutorial examples/01_forecasting.ipynb

y_predsktime 兼容数据容器格式的时间序列

要评估与真实值比较的预测值。必须与 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, or pd.DataFrame

计算出的指标，已平均或按变量。如果提供 sample_weight，则按其加权。

  • float 如果 multioutput="uniform_average" 或 类似数组，且 ``multilevel="uniform_average" 或 “uniform_average_time”``. 值是变量和级别上平均的指标（参见类文档字符串）

  • np.ndarray 形状为 (y_true.columns,) 如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time". 第 i 个条目是第 i 个变量计算出的指标

  • pd.DataFrame 如果 multilevel="raw_values". 形状为 (n_levels, )，如果 multioutput="uniform_average"；形状为 (n_levels, y_true.columns) 如果 multioutput="raw_values". 指标按级别应用，行平均（是/否）如 multioutput 中所示。

clone()[源]#

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

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

等效于构造一个 type(self) 的新实例，使用 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)[源]#

将另一个对象的标签克隆为动态覆盖。

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

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

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

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

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

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

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

参数:
estimatorBaseObject 或派生类的实例。
tag_namesstr 或 str 列表, 默认值 = None

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

返回值:
self

对 self 的引用。

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

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

参数:
parameter_setstr, 默认值=”default”

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

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

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

参数:
parameter_setstr, 默认值=”default”

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

返回值:
objscls 实例列表

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

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

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

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

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

参数:
y_truesktime 兼容数据容器格式的时间序列。

真实值（正确）目标值。

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

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行有 2 级 MultiIndex（实例，时间）、3D np.ndarray（实例，变量，时间）、Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行有 3 级或更多级别 MultiIndex（层次结构_1，...，层次结构_n，时间）

有关数据格式的更多详细信息，请参见 glossary 中的 mtype。有关用法，请参见 forecasting tutorial examples/01_forecasting.ipynb

y_predsktime 兼容数据容器格式的时间序列

要评估与真实值比较的预测值。必须与 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, or pd.DataFrame

计算出的指标，已平均或按变量。如果提供 sample_weight，则按其加权。

  • float 如果 multioutput="uniform_average" 或 类似数组，且 ``multilevel="uniform_average" 或 “uniform_average_time”``. 值是变量和级别上平均的指标（参见类文档字符串）

  • np.ndarray 形状为 (y_true.columns,) 如果 multioutput=”raw_values”` 且 multilevel="uniform_average" 或 "uniform_average_time". 第 i 个条目是第 i 个变量计算出的指标

  • pd.DataFrame 如果 multilevel="raw_values". 形状为 (n_levels, )，如果 multioutput="uniform_average"；形状为 (n_levels, y_true.columns) 如果 multioutput="raw_values". 指标按级别应用，行平均（是/否）如 multioutput 中所示。

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

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

参数:
y_truesktime 兼容数据容器格式的时间序列。

真实值（正确）目标值。

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

  • Series scitype = 单个时间序列，普通预测。pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame，行有 2 级 MultiIndex（实例，时间）、3D np.ndarray（实例，变量，时间）、Series 类型 pd.DataFrame 的 list

  • Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame，行有 3 级或更多级别 MultiIndex（层次结构_1，...，层次结构_n，时间）

有关数据格式的更多详细信息，请参见 glossary 中的 mtype。有关用法，请参见 forecasting tutorial examples/01_forecasting.ipynb

y_predsktime 兼容数据容器格式的时间序列

要评估与真实值比较的预测值。必须与 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，则按其加权。

  • pd.Series 如果 multioutput="uniform_average" 或类似数组。索引等于 y_true 的索引；索引 i 处的条目是时间 i 的指标，按变量平均

  • pd.DataFrame 如果 multioutput="raw_values". 索引和列等于 y_true 的索引和列；i,j 个条目是时间 i、变量 j 的指标

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

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

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

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

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

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

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

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

按继承顺序。

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

要检索包含潜在实例覆盖的标签值，请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签，则使用的默认/回退值。

返回值:
tag_value

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

classmethod get_class_tags()[源]#

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

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

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

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

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

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

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

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

按继承顺序。

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

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

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

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

返回值:
collected_tagsdict

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

get_config()[源]#

获取自身的配置标志。

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

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

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

配置在 clone 或 reset 调用下保持不变。

返回值:
config_dictdict

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

classmethod get_param_defaults()[源]#

获取对象的参数默认值。

返回值:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源]#

获取对象的参数名称。

参数:
sortbool, 默认值=True

是否按字母顺序排序返回参数名称 (True)，或按它们在类 __init__ 中出现的顺序返回 (False)。

返回值:
param_names: list[str]

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

get_params(deep=True)[源]#

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

参数:
deepbool, 默认值=True

是否返回组件的参数。

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

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

返回值:
params键为字符串的字典

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

  • 始终包含：此对象的所有参数，如通过 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)[源]#

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

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

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

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

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

在实例构造时。

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

  2. 在父类的 _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()[源]#

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序。

返回值:
collected_tagsdict

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

is_composite()[源]#

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

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

返回值:
composite: bool

对象是否具有任何参数，其值是 BaseObject 的派生实例。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回值:
反序列化 self，结果输出到 path，是 cls.save(path) 的输出。
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回值:
反序列化 self，结果是输出 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

类实例被重置为干净的 post-init 状态，但保留当前的超参数值。

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

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

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

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

参数:
pathNone 或文件位置 (str 或 Path)

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

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

  • 如果 path=”/home/stored/estimator”，则 zip 文件 estimator.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 kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool, 默认=True

打印 self 时是只列出与默认值不同的 self 参数 (False)，还是列出所有参数名称和值 (False)。不嵌套，即只影响 self，不影响组件 estimator。

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”；要使用的 logger 名称。

    • “mute_warnings”: bool, 默认=False；如果为 True，则抑制警告

返回值:
self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回值:
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 可在多次函数调用中获得可重现的输出。

deepbool, 默认值=True

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

  • 如果为 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对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中（构造期间）或通过 __init__ 构造后直接调用。

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

参数:
**tag_dictdict

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

返回值:
Self

对自身的引用。