ScaledAsinhTransformer#

class ScaledAsinhTransformer(mad_normalization_factor=1.4826)[source]#

双曲正弦变换及其逆变换 [1]。

已知是一种方差稳定变换，与 sktime.forecasting.compose.TransformedTargetForecaster 结合使用时，对于存在尖峰的时间序列很有用 [1], [2]

参数:

mad_normalization_factor浮点数, 默认值 = 1.4826: 用于调整中位数绝对偏差 (MAD) 的归一化因子，使其与标准偏差具有渐近正态一致性。基于 [1], [2] 的默认值为 1.4826。

属性:

shift_parameter_asinh_浮点数: 偏移参数，在 [1] 中表示为“a”，是样本数据的中位数。它根据在“fit”中提供的数据进行拟合。
scale_parameter_asinh_浮点数: 尺度参数，在 [1] 中表示为“b”，是样本中位数附近的中位数绝对偏差 (MAD)，通过一个因子调整以使其与标准偏差具有渐近正态一致性（基于 [1], [2]，b = median_abs_deviation(样本数据) \(\times\) mad_normalization_factor）。它根据在“fit”中提供的数据进行拟合。

另见

sktime.transformations.series.boxcox.LogTransformer: 使用自然对数变换输入数据。有助于数据归一化并压缩序列方差。
sktime.transformations.series.boxcox.BoxCoxTransformer: 应用 Box-Cox 幂变换。有助于数据归一化并压缩序列方差。
sktime.transformations.series.exponent.ExponentTransformer: 通过将输入数据提升到指定指数进行变换。如果提供小数指数，有助于压缩序列方差。
sktime.transformations.series.exponent.SqrtTransformer: 通过对输入数据取平方根进行变换。有助于压缩输入序列方差。

注意

双曲正弦变换应用如下

\(asinh(\frac{x- a}{b})\)

双曲正弦逆变换应用如下

\(b . sinh(x) + a\)

其中“a”是偏移参数，“b”是尺度参数 [1]。

a = 中位数(样本数据)

b = 中位数绝对偏差(样本数据) \(\times\) mad_normalization_factor

参考文献

[1] (1,2,3,4,5,6,7)

Ziel F, Weron R. Day-ahead electricity price forecasting with high-dimensional structures: Univariate vs. multivariate modeling frameworks. Energy Economics. 2018 Feb 1;70:396-420.

[2] (1,2,3)

Uniejewski, B., Weron, R., Ziel, F., 2017. Variance stabilizing transformations for electricity spot price forecasting. IEEE Transactions on Power Systems, DOI: 10.1109/TPWRS.2017.2734563

示例

>>> from sktime.transformations.series.scaledasinh import ScaledAsinhTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = ScaledAsinhTransformer()
>>> y_hat = transformer.fit_transform(y)

方法

`check_is_fitted`([method_name])	检查估计器是否已拟合。
`clone`()	获取具有相同超参数和配置的对象的克隆。
`clone_tags`(estimator[, tag_names])	从另一个对象克隆标签作为动态覆盖。
`create_test_instance`([parameter_set])	使用第一个测试参数集构造类的实例。
`create_test_instances_and_names`([parameter_set])	创建所有测试实例的列表及其名称列表。
`fit`(X[, y])	将转换器拟合到 X，可选地拟合到 y。
`fit_transform`(X[, y])	拟合数据，然后进行转换。
`get_class_tag`(tag_name[, tag_value_default])	从类中获取类标签值，包含来自父类的标签级别继承。
`get_class_tags`()	从类中获取类标签，包含来自父类的标签级别继承。
`get_config`()	获取自身的配置标志。
`get_fitted_params`([deep])	获取已拟合参数。
`get_param_defaults`()	获取对象的参数默认值。
`get_param_names`([sort])	获取对象的参数名称。
`get_params`([deep])	获取此对象的参数值字典。
`get_tag`(tag_name[, tag_value_default, ...])	从实例中获取标签值，包含标签级别继承和覆盖。
`get_tags`()	从实例中获取标签，包含标签级别继承和覆盖。
`get_test_params`([parameter_set])	返回估计器的测试参数设置。
`inverse_transform`(X[, y])	逆变换 X 并返回逆变换后的版本。
`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)	将实例级别的标签覆盖设置为给定值。
`transform`(X[, y])	转换 X 并返回转换后的版本。
`update`(X[, y, update_params])	用 X 更新转换器，可选地用 y 更新。

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

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

参数:

parameter_set字符串, 默认值=”default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则将返回 "default" 集。

返回:

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则抛出 NotFittedError 异常。

参数:

method_name字符串, 可选: 调用此方法的名称。如果提供，错误消息将包含此信息。

抛出:

NotFittedError: 如果估计器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等效于返回 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)[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 的引用。

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 个元素是测试中第 i 个 obj 实例的名称。命名约定是如果实例多于一个则为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y=None)[source]#

将转换器拟合到 X，可选地拟合到 y。

状态改变: 将状态更改为“已拟合”。

写入自身

设置以“_”结尾的拟合模型属性，拟合属性可通过 get_fitted_params 查看。

将 self.is_fitted 标志设置为 True。

如果 self.get_tag("remember_data") 为 True，则将 X 记忆为 self._X，并强制转换为 self.get_tag("X_inner_mtype")。

参数:

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

用于拟合转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据, 默认值=None

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不是可选的。有关所需格式，请参阅类文档字符串了解详细信息。

返回:

self估计器的已拟合实例

fit_transform(X, y=None)[source]#

拟合数据，然后进行转换。

将转换器拟合到 X 和 y，并返回 X 的转换后版本。

状态改变: 将状态更改为“已拟合”。

写入自身: _is_fitted : 标志设为 True。_X : X，X 的强制副本，如果 remember_data 标签为 True

如果可能，可能会通过引用强制转换为内部类型或 update_data 兼容类型

模型属性（以“_”结尾）：取决于估计器

参数:

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

用于拟合转换的数据，以及要转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据, 默认值=None

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不是可选的。有关所需格式，请参阅类文档字符串了解详细信息。

返回:

X 的转换后版本

类型取决于 X 的类型和 scitype:transform-output 标签

X | tf-output | 返回类型 |

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1 行) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回中的实例对应于 X 中的实例

表中未列出的组合目前不支持

具体示例

如果 X 是 Series（例如，pd.DataFrame）

且 transform-output 是 Series，则返回的是具有相同 mtype 的单个 Series。示例：对单个序列进行去趋势

如果 X 是 Panel（例如，pd-multiindex）且 transform-output

是 Series，则返回的是与 X 具有相同实例数量的 Panel（转换器应用于每个输入的 Series 实例）。示例：Panel 中的所有序列都单独去趋势

如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回的是行数与 X 中实例数相同的 pd.DataFrame。示例：返回的第 i 行包含第 i 个序列的均值和方差

如果 X 是 Series 且 transform-output 是 Panel，

则返回的是类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是运行在 X 上的第 i 个窗口

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

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

每个与 scikit-base 兼容的对象都有一个标签字典，用于存储对象的元数据。

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

它从对象中返回名称为 tag_name 的标签值，考虑标签覆盖，优先级从高到低如下

在类的 _tags 属性中设置的标签。
在父类的 _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 的任何属性的键。

值是相应的标签值，覆盖的优先级从高到低如下

在类的 _tags 属性中设置的标签。
在父类的 _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 类属性收集，然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数:

deep布尔值, 默认值=True

是否返回组件的拟合参数。

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

返回:

fitted_params键为字符串的字典

拟合参数字典，paramname : paramvalue 键值对包含

始终：此对象的所有拟合参数，如同通过 get_param_names。值是该键对应的拟合参数值，属于此对象
如果 deep=True，还包含组件参数的键/值对，组件参数以 [componentname]__[paramname] 索引。所有 componentname 的参数都显示为 paramname 及其值
如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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] 等

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_name字符串: 要检索的标签名称
tag_value_default任意类型, 可选; 默认值=None: 如果未找到标签，则为默认/备用值
raise_error布尔值: 未找到标签时是否抛出 ValueError 异常

返回:

tag_value任意类型: 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_tags字典: 标签名称：标签值对的字典。通过嵌套继承从 _tags 类属性收集，然后从 _tags_dynamic 对象属性收集任何覆盖和新标签。

inverse_transform(X, y=None)[source]#

逆变换 X 并返回逆变换后的版本。

目前假设只有带有标签的转换器: “scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”，

具有 inverse_transform 方法。

所需状态: 要求状态为“已拟合”。

访问自身

以“_”结尾的拟合模型属性。

self.is_fitted，必须为 True

参数:

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

用于拟合转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据, 默认值=None

附加数据，例如用于转换的标签。一些转换器需要此数据，有关详细信息请参阅类文档字符串。

返回:

X 的逆变换版本: 与 X 类型相同，且符合 mtype 格式规范

is_composite()[source]#

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

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

返回:

composite: bool: 对象的任何参数值是否为 BaseObject 的后代实例。

property is_fitted[source]#

是否已调用 fit 方法。

检查对象的 _is_fitted` 属性，该属性应在对象构造期间初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

返回:

布尔值: 估计器是否已 fit。

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)) 后获得的对象相等。

返回:

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

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” 则将在 /home/stored/ 中存储一个 zip 文件 estimator.zip。

存储在 /home/stored/。

serialization_format: str, 默认值 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 对该文件引用的 ZipFile

set_config(**config_dict)[source]#

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

参数:

config_dict字典

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

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

jupyter kernel 如何显示 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，则禁止显示警告。

input_conversionstr，以下之一：“on”（默认）、“off”或有效的 mtype 字符串

控制输入检查和转换，用于 _fit、_transform、_inverse_transform、_update

"on" - 执行输入检查和转换
"off" - 在将数据传递给内部方法之前不执行输入检查和转换
有效的 mtype 字符串 - 输入被假定为指定的 mtype，执行转换但不进行检查

output_conversionstr，以下之一：“on”、“off”、有效的 mtype 字符串

控制 _transform、_inverse_transform 的输出转换

"on" - 如果 input_conversion 为“on”，则执行输出转换
"off" - 直接返回 _transform、_inverse_transform 的输出
有效的 mtype 字符串 - 输出被转换为指定的 mtype

返回:

self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:

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

deep布尔值, 默认值=True

deep: bool, default=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对自身的引用

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

每个与 scikit-base 兼容的对象都有一个标签字典，用于存储对象的元数据。

set_tags(**tag_dict)[source]#

标签是特定于实例 self 的键值对，它们是静态标志，在对象构造后不会更改。它们可用于元数据检查或控制对象行为。

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

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

参数:

set_tags 方法只能在对象的 __init__ 方法中（构造期间）或通过 __init__ 构造后立即调用。: **tag_dictdict

返回:

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

对自身的引用。

转换 X 并返回转换后的版本。

所需状态: 要求状态为“已拟合”。

访问自身

以“_”结尾的拟合模型属性。

self.is_fitted，必须为 True

参数:

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

transform(X, y=None)[source]#

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据, 默认值=None

附加数据，例如用于转换的标签。一些转换器需要此数据，有关详细信息请参阅类文档字符串。

返回:

X 的转换后版本
类型取决于 X 的类型和 scitype:transform-output 标签

	X: sktime 兼容格式的数据
要转换的数据。	transform 的输出	- 输出
返回类型	Series	Primitives
`pd.DataFrame` (1行)	Series	Panel
返回类型	返回类型	返回类型
`pd.DataFrame` (1行)	返回类型	`pd.DataFrame` (1行)
返回类型	`pd.DataFrame` (1行)	`pd.DataFrame` (1行)

返回中的实例对应于 X 中的实例

表中未列出的组合目前不支持

具体示例

如果 X 是 Series（例如，pd.DataFrame）

且 transform-output 是 Series，则返回的是具有相同 mtype 的单个 Series。示例：对单个序列进行去趋势

如果 X 是 Panel（例如，pd-multiindex）且 transform-output

是 Series，则返回的是与 X 具有相同实例数量的 Panel（转换器应用于每个输入的 Series 实例）。示例：Panel 中的所有序列都单独去趋势

如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回的是行数与 X 中实例数相同的 pd.DataFrame。示例：返回的第 i 行包含第 i 个序列的均值和方差

如果 X 是 Series 且 transform-output 是 Panel，

则返回的是类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是运行在 X 上的第 i 个窗口

pd.DataFrame

用 X 更新转换器，可选地用 y 更新。

所需状态: 要求状态为“已拟合”。

访问自身

以“_”结尾的拟合模型属性。

self.is_fitted，必须为 True

写入自身

以“_”结尾的拟合模型属性。

update(X, y=None, update_params=True)[source]#

参数:

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

X: sktime 兼容格式的数据

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), Series 类型 pd.DataFrame 的 list
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 mtype 词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据, 默认值=None

附加数据，例如用于转换的标签。一些转换器需要此数据，有关详细信息请参阅类文档字符串。

返回:

self估计器的已拟合实例