STLTransformer#

class STLTransformer(sp=2, seasonal=7, trend=None, low_pass=None, seasonal_deg=1, trend_deg=1, low_pass_deg=1, robust=False, seasonal_jump=1, trend_jump=1, low_pass_jump=1, return_components=False)[source]#

使用 STL 从时间序列中移除季节性成分。

作为 sktime 转换器接口 statsmodels.tsa.seasonal.STL。

STLTransformer 可用于执行季节性分解或成分分解。

如果 return_components=False，它将返回季节性调整后的序列，即来自 statsmodels STL 的趋势成分。

如果 return_components=True，它将把序列转换为成分分解，返回趋势、季节性以及残差成分。

STLTransformer 通过对各成分求和来执行 inverse_transform，并可在 TransformedTargetForecaster 中用于流水线处理。

重要提示：对于趋势和季节性的单独预测，以及考虑季节性的逆变换，请确保 return_components=True 已设置，否则逆变换将只返回趋势成分。

流水线式组合的另一种选择是 STLForecaster。

参数：:
spint, 默认值=1

季节周期性。

seasonalint, 默认值=7

季节性平滑器的长度。必须是奇数，通常应 >= 7（默认值）。

trend{int, 默认值=None}

趋势平滑器的长度。必须是奇数。如果未提供，则按照原始实现的建议，使用大于 1.5 * period / (1 - 1.5 / seasonal) 的最小奇数。

low_pass{int, 默认值=None}

低通滤波器的长度。必须是大于等于 3 的奇数。如果未提供，则使用大于 period 的最小奇数。

seasonal_degint, 默认值=1

季节性 LOESS 的度数。0（常数）或 1（常数和趋势）。

trend_degint, 默认值=1

趋势 LOESS 的度数。0（常数）或 1（常数和趋势）。

low_pass_degint, 默认值=1

低通 LOESS 的度数。0（常数）或 1（常数和趋势）。

robustbool, 默认值 False

指示是否使用对某些形式的异常值具有鲁棒性的加权版本的标志。

seasonal_jumpint, 默认值=1

确定线性插补步长的正整数。如果大于 1，则 LOESS 每隔 seasonal_jump 个点使用一次，并在拟合点之间进行线性插补。值越高，估算时间越短。

trend_jumpint, 默认值=1

确定线性插补步长的正整数。如果大于 1，则 LOESS 每隔 trend_jump 个点使用一次，并在两点之间进行线性插补。值越高，估算时间越短。

low_pass_jumpint, 默认值=1

确定线性插补步长的正整数。如果大于 1，则 LOESS 每隔 low_pass_jump 个点使用一次，并在两点之间进行线性插补。值越高，估算时间越短。

return_componentsbool, 默认值=False

如果为 False，将只返回趋势成分 如果为 True，将返回转换后的序列，以及三个成分

作为返回的多元序列中的变量（DataFrame 列） “transformed” - 转换后的序列 “seasonal” - 季节性成分 “trend” - 趋势成分 “resid” - 去趋势、去季节化后的残差

属性：:
trend_pd.Series

在 fit 中看到的序列的趋势成分。

seasonal_pd.Series

在 fit 中看到的序列的季节性成分。

resid_pd.Series

在 fit 中看到的序列的残差成分。

另请参阅

Detrender
季节性分解器
STLForecaster

参考资料

示例

>>> from sktime.datasets import load_airline
>>> from sktime.transformations.series.detrend import STLTransformer
>>> X = load_airline()  
>>> transformer = STLTransformer(sp=12)  
>>> Xt = transformer.fit_transform(X)

方法

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

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

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

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

返回:
paramsdict or list of dict, default = {}

用于创建类的测试实例的参数。每个 dict 都是构建“有趣”测试实例的参数，即 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_namestr, 可选

调用此函数的方法的名称。如果提供，错误消息将包含此信息。

引发:
NotFittedError

如果评估器尚未拟合。

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_namesstr 或 list of str, default = None

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

返回:
self

对 self 的引用。

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

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

参数：:
parameter_setstr, default=”default”

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

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

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

参数：:
parameter_setstr, default=”default”

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

返回:
objscls 实例列表

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

namesstr 列表，与 objs 长度相同

第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定为 {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 (1维或2维)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (实例, 时间) 的 pd.DataFrame，3D np.ndarray (实例, 变量, 时间)，类型为 Series 的 pd.DataFrame 的 list

  • Hierarchical scitype = 分层时间序列集合。具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间) 的 pd.DataFrame

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

y可选，sktime 兼容数据格式的数据，default=None

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

返回:
self评估器的拟合实例
fit_transform(X, y=None)[source]#

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

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

状态变化

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

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

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

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

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

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

sktime 中的各种数据格式被称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (实例, 时间) 的 pd.DataFrame，3D np.ndarray (实例, 变量, 时间)，类型为 Series 的 pd.DataFrame 的 list

  • Hierarchical scitype = 分层时间序列集合。具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间) 的 pd.DataFrame

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

y可选，sktime 兼容数据格式的数据，default=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，则返回是 pd.DataFrame，其行数与 X 中的实例数量相同。示例：返回的第 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 的标签值，考虑标签覆盖，按以下优先级降序排列

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

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

每个与 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()[source]#

获取自身的配置标志。

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

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

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

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

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合的参数。

所需状态

要求状态为“已拟合”。

参数：:
deepbool, default=True

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

  • 如果为 True，将返回此对象的参数名称:值字典，包括可拟合组件 (= BaseEstimator 值的参数) 的拟合参数。

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

返回:
fitted_params键为 str 的 dict

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

  • 始终：此对象的所有拟合参数，如通过 get_param_names 获取的那样，值是此对象该键的拟合参数值

  • 如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [组件名称]__[参数名称]，组件名称 的所有参数以其值作为 参数名称 显示

  • 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：:
sortbool, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数：:
deepbool, default=True

是否返回组件的参数。

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

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

返回:
params键为 str 的 dict

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

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

  • 如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [组件名称]__[参数名称]，组件名称 的所有参数以其值作为 参数名称 显示

  • 如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

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

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

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

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

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

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

在实例构建时。

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

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

按继承顺序。

参数：:
tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；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 设置的标签。

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

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

在实例构建时。

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

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

按继承顺序。

返回:
collected_tagsdict

标签名称:标签值对的字典。通过嵌套继承从 _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 (1维或2维)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (实例, 时间) 的 pd.DataFrame，3D np.ndarray (实例, 变量, 时间)，类型为 Series 的 pd.DataFrame 的 list

  • Hierarchical scitype = 分层时间序列集合。具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间) 的 pd.DataFrame

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

y可选，sktime 兼容数据格式的数据，default=None

额外数据，例如用于变换的标签。一些变换器需要此数据，详细信息请参阅类文档字符串。

返回:
X 的逆变换版本

与 X 类型相同，并符合 mtype 格式规范

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已调用 fit。

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

返回:
bool

评估器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：:
serialZipFile(path).open(“object) 的结果
返回:
通过 cls.save(path) 在 path 生成的已反序列化的自身
classmethod load_from_serial(serial)[source]#

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

参数：:
serialcls.save(None) 输出的第 1 个元素
返回:
通过 cls.save(None) 生成输出 serial 的已反序列化的自身
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，则返回内存中序列化的自身；如果 path 是文件位置，则将自身保存到该位置作为 zip 文件

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

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

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

  • path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则将在 /home/stored/ 中创建一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中序列化的自身
如果 path 是文件位置 - 指向文件的 ZipFile
set_config(**config_dict)[source]#

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

参数：:
config_dictdict

配置名称:配置值对的字典。有效的配置、值及其含义如下所示

displaystr, “diagram” (默认), 或 “text”

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

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (默认), 或 “off”

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

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

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

backend:parallelstr, 可选, default=”None”

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

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

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

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

  • “dask”：使用 dask，需要在环境中安装 dask 包

  • “ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, 可选, default={} (未传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 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, default=True；False 阻止 ray 在并行化后

      关闭。

    • “logger_name”：str, default=”ray”；要使用的日志记录器名称。

    • “mute_warnings”：bool, default=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 对象和复合对象。对于复合对象（即包含其他对象的对象），参数键字符串 <组件>__<参数> 可用于访问组件 <组件> 中的 <参数>。如果这样引用是明确的（例如，没有两个组件参数具有相同的名称 <参数>），也可以使用不带 <组件>__ 的字符串 <参数>。

参数：:
**paramsdict

BaseObject 参数，键必须是 <组件>__<参数> 字符串。如果 __ 后缀在 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 中的 random_state 参数，取决于 self_policy，以及仅当 deep=True 时剩余的组件对象。

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

参数：:
random_stateint, RandomState instance 或 None, default=None

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

deepbool, default=True

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

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

  • 如果为 True，也将设置组件对象中的 random_state 参数。

self_policystr, “copy”, “keep”, “new” 之一, default=”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 中指定的值，其中键是标签名称，dict 值是要将标签设置到的值。

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

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

参数：:
**tag_dictdict

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

返回:
Self

对自身的引用。

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

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

所需状态

要求状态为“已拟合”。

访问自身

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

  • self.is_fitted，必须为 True

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

要变换的数据。

sktime 中的各种数据格式被称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (实例, 时间) 的 pd.DataFrame，3D np.ndarray (实例, 变量, 时间)，类型为 Series 的 pd.DataFrame 的 list

  • Hierarchical scitype = 分层时间序列集合。具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间) 的 pd.DataFrame

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

y可选，sktime 兼容数据格式的数据，default=None

额外数据，例如用于变换的标签。一些变换器需要此数据，详细信息请参阅类文档字符串。

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

变换

X

-输出

返回类型

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，则返回是 pd.DataFrame，其行数与 X 中的实例数量相同。示例：返回的第 i 行包含第 i 个时间序列的均值和方差

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

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

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

使用 X (可选包含 y) 更新变换器。

所需状态

要求状态为“已拟合”。

访问自身

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

  • self.is_fitted，必须为 True

写入自身

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

  • 如果 remember_data 标签为 True，则通过 update_data 将 X 中的值写入更新后的 self._X。

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

用于更新变换的数据

sktime 中的各种数据格式被称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (实例, 时间) 的 pd.DataFrame，3D np.ndarray (实例, 变量, 时间)，类型为 Series 的 pd.DataFrame 的 list

  • Hierarchical scitype = 分层时间序列集合。具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间) 的 pd.DataFrame

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

y可选，sktime 兼容数据格式的数据，default=None

额外数据，例如用于变换的标签。一些变换器需要此数据，详细信息请参阅类文档字符串。

返回:
self评估器的拟合实例