条件性季节分解器#

class ConditionalDeseasonalizer(seasonality_test=None, sp=1, model='additive')[source]#

根据季节性测试条件，移除时间序列的季节性成分。

拟合函数测试时间序列的季节性。如果传入的时间序列具有季节性成分，它将应用 statsmodels <https://statsmodels.pythonlang.cn> 提供的季节性分解来计算季节性成分。如果测试结果为非季节性，则 _seasonal 将设置为全一（如果 model 为“multiplicative”）或全零（如果 model 为“additive”）。

转换函数将存储在 seasonal_ 中的季节性成分与传入时间序列的时间索引对齐，然后从传入序列中减去这些成分（“additive”模型）或用它们除以传入序列（“multiplicative”模型）。

参数:
seasonality_test可调用对象或 None，默认值为 None

测试季节性并返回 True（如果数据是季节性的）或 False（否则）的可调用对象。如果为 None，则使用 90% 自相关季节性测试。

spint 类型，默认值为 1

季节周期。

model{"additive", "multiplicative"} 之一，默认值为 "additive"

用于估计季节性成分的模型。

属性:
seasonal_长度为 sp 的数组

季节性成分。

is_seasonal_布尔值

seasonality_test 的返回值。数据是季节性的时为 True，否则为 False。

另请参阅

季节分解器

注意

关于季节性成分以及加法模型和乘法模型的更多解释，请参见预测：原理与实践 (Forecasting: Principles and Practice)。季节性分解使用 `statsmodels 进行计算

<https://statsmodels.pythonlang.cn/stable/generated/statsmodels.tsa.seasonal.seasonal_decompose.html>`_。

示例

>>> from sktime.transformations.series.detrend import ConditionalDeseasonalizer
>>> from sktime.datasets import load_airline
>>> y = load_airline()  
>>> transformer = ConditionalDeseasonalizer(sp=12)  
>>> 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_fitted_params([deep])

获取已拟合的参数。

获取参数默认值()

获取对象的参数默认值。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

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

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

获取标签()

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

get_test_params([parameter_set])

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

inverse_transform(X[, y])

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

是复合对象()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

重置()

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

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。
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

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

参数:
method_name字符串，可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

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

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

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

状态变化

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

写入 self

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

  • 将 self.is_fitted 标志设置为 True。

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

参数:
X符合 sktime 数据容器格式的时间序列

用于拟合变换的数据。

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

  • Series scitype = 独立时间序列。 pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • 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 兼容数据格式的数据，默认为 None

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

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

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

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

状态变化

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

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

可能在可能的情况下通过引用强制转换为内部类型或与 update_data 兼容的类型

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

参数:
X符合 sktime 数据容器格式的时间序列

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

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

  • Series scitype = 独立时间序列。 pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • 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 兼容数据格式的数据，默认为 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 (transformer 应用于每个输入 Series 实例)。示例：面板中的所有序列都单独进行去趋势

  • 如果 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, raise_error=True)[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_tags字典

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

get_config()[source]#

获取自身的配置标志。

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

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

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

Configs 在 clone 或 reset 调用中保留。

返回:
config_dict字典

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool，默认为 True

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

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

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

返回:
fitted_params键为 str 类型的字典

拟合参数的字典，包含 参数名 : 参数值 键值对

  • 始终包含：此对象的所有拟合参数，如同通过 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，默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool，默认为 True

是否返回组件的参数。

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

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

返回:
params键为 str 类型的字典

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

  • 始终包含：此对象的所有参数，如同通过 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任意类型，可选；默认为 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_tags字典

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

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

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

参数:
parameter_setstr，默认为”default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则将返回 "default" 集。目前没有为转换器保留的值。

返回:
params字典或字典列表，默认为 {}

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

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

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

目前假定只有带有以下标签的转换器

“scitype:transform-input”=”Series”， “scitype:transform-output”=”Series”，

具有 inverse_transform 方法。

所需状态

要求状态为“已拟合”。

在 self 中访问

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

  • self.is_fitted，必须为 True

参数:
X符合 sktime 数据容器格式的时间序列

用于拟合变换的数据。

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

  • Series scitype = 独立时间序列。 pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • 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 兼容数据格式的数据，默认为 None

附加数据，例如用于转换的标签。有些转换器需要此项，详见类文档字符串。

返回:
X 的逆变换版本

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

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

fit 是否已被调用。

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

返回:
bool

estimator 是否已被 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

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

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

参数:
serial cls.save(None) 输出的第 1 个元素
返回:
反序列化 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

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

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”，则将在当前工作目录 (cwd) 生成一个 estimator.zip 的 zip 文件。

  • path=”/home/stored/estimator”，则将在

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dict字典

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

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

jupyter 内核如何显示 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: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”：bool，默认为 True；False 会阻止 ray 在

      并行化后关闭。

    • “logger_name”：str，默认为”ray”；要使用的 logger 名称。

    • “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对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
params字典

BaseObject 参数，键必须是 <组件名>__<参数名> 字符串。如果 __ 后缀在 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 从链式哈希中采样，并保证 seeded random generators 的伪随机独立性。

根据 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对 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 的引用。

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

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

所需状态

要求状态为“已拟合”。

在 self 中访问

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

  • self.is_fitted，必须为 True

参数:
X符合 sktime 数据容器格式的时间序列

要转换的数据。

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

  • Series scitype = 独立时间序列。 pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • 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 兼容数据格式的数据，默认为 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 (transformer 应用于每个输入 Series 实例)。示例：面板中的所有序列都单独进行去趋势

  • 如果 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 中访问

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

  • self.is_fitted，必须为 True

写入 self

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

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

参数:
X符合 sktime 数据容器格式的时间序列

用于更新变换的数据

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

  • Series scitype = 独立时间序列。 pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)

  • 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 兼容数据格式的数据，默认为 None

附加数据，例如用于转换的标签。有些转换器需要此项，详见类文档字符串。

返回:
self已拟合的 estimator 实例