TabularToSeriesAdaptor

类 TabularToSeriesAdaptor(transformer, fit_in_transform=False, pass_y='auto', input_type='numpy', pooling='local')

调整 scikit-learn 变换接口以适应时间序列设置。

这对于将 scikit-learn 表格 变换应用于 序列 非常有用，但仅适用于无需多个 实例 进行拟合的变换。

该适配器的行为如下。

如果 fit_in_transform = False 且 X 是一个序列（pd.DataFrame、pd.Series、np.ndarray）

• fit(X) 将 transformer 的克隆拟合到 X（被视为一个表格）

• transform(X) 将 transformer.transform 应用于 X 并返回结果

• inverse_transform(X) 将 transformer.inverse_transform 应用于 X

如果 fit_in_transform = True 且 X 是一个序列（pd.DataFrame、pd.Series、np.ndarray）

• fit 为空

• transform(X) 将 transformer.fit(X).transform(X) 应用于 X（被视为一个表格）并返回结果

• inverse_transform(X) 将 transformer.fit(X).inverse_transform(X) 应用于 X

如果 fit_in_transform = False 且 X 是 panel/hierarchical 类型

• fit(X) 为 X 中的每个独立序列 x 拟合一个 transformer 的克隆

• transform(X) 为 X 中的每个独立序列 x 应用属于 x 的克隆的 transform(x)（其中变换中的 x 的索引等于拟合中的 x 的索引），并返回结果

• inverse_transform(X) 为 X 中的每个独立序列 x 应用属于 x 的克隆的 transform(x)（其中变换中的 x 的索引等于拟合中的 x 的索引），并返回结果

• 注意：transform/inverse_transform 中的实例索引必须与 fit 中看到的索引相等

如果 fit_in_transform = True 且 X 是 panel/hierarchical 类型

• fit 为空

• transform(X) 将 transformer.fit(x).transform(x) 应用于 X 中的所有独立序列 x 并返回结果

• inverse_transform(X) 将 transformer.fit(x).inverse_transform(x) 应用于 X 中的所有独立序列 x 并返回结果

警告：如果 fit_in_transform 设置为 False，

当应用于 Panel 或 Hierarchical 数据时，生成的变换器将根据训练集中的序列索引识别测试集中的单个序列，特别是如果变换中的实例数量和索引与拟合中的不同，transform 将无法工作。

警告：如果 fit_in_transform 设置为 True，

则测试集中的每个序列将通过 fit-predict 作为批次进行变换，这可能在预测设置中导致信息泄露（但在时间序列分类/回归/聚类设置中不会，因为在这些设置中，独立样本是单个序列）。

是否将 y 传递给变换器方法由 pass_y 控制。如果内部变换器具有非默认值的 y 参数，则默认行为是将 y 传递给 fit、fit_transform 或 transform。如果没有 y 参数存在，或者如果它具有默认值，则不传递 y。

如果传递的变换器在 fit 和 transform 中只接受 y，则忽略 pass_y，并将 X 插入到 y 参数中。

参数:

transformersklearn 变换器，BaseEstimator 后代实例

用于拟合并应用于序列的类似 scikit-learn 的变换器。这被用作“蓝图”，不会被拟合或以其他方式修改。

fit_in_transform: 布尔值，可选，默认值=False

是否应该在 transform 中拟合 transformer_ (True)，还是在 fit 中拟合 (False)。

• 在预测中（单序列或分层数据）的推荐设置：False

• 在时间序列分类、回归、聚类中的推荐设置：True

pass_y字符串，可选，以下之一：“auto”（默认）、“fit”、“always”、“never”

是否将 y 传递给 transformer 克隆的变换器方法。

• “auto”：将 y 传递给 fit、transform、fit_transform、inverse_transform 方法，当且仅当 y 是其中任何一个方法没有默认值的命名参数。注意：即使 y 是 None，也会传递 y

• “fit”：将 y 传递给 fit 方法，但不传递给 transform。注意：即使 y 是 None，或者不是命名参数，也会传递 y

• “always”：将 y 传递给所有方法，fit、transform、inverse_transform。注意：即使 y 是 None，或者不是命名参数，也会传递 y

• “never”：从不将 y 传递给任何方法。

input_type字符串，以下之一：“numpy”（默认）、“pandas”

sklearn 变换器接收的数据类型

• “numpy”：2D np.ndarray

• “pandas”：pd.DataFrame，列名传递给变换器。列名如果不是字符串，将被强制转换为字符串，行索引被重置为 RangeIndex。

pooling字符串，以下之一：“local”（默认）、“global”

是分别应用于每个序列（local），还是同时应用于所有序列（global）

• “local”：分别应用于每个序列

• “global”：同时应用于所有序列，汇集到一个单独的 2D np.ndarray 或 pd.DataFrame

属性:

transformer_估计器

拟合到数据的变换器，是 transformer 的克隆。

示例

>>> from sktime.transformations.series.adapt import TabularToSeriesAdaptor
>>> from sklearn.preprocessing import MinMaxScaler
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = TabularToSeriesAdaptor(MinMaxScaler())
>>> 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。

get_tags()

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

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

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

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

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

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

在实例构造时。

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

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

按继承顺序排列。

返回:

collected_tags字典

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

类方法 get_test_params(parameter_set='default')

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

参数:

parameter_set字符串，默认值=”default”

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

返回:

params字典或字典列表，默认值 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数:

method_name字符串，可选

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

抛出:

NotFittedError

如果估计器尚未拟合。

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 查看。

参数:

estimator:class:BaseObject 或派生类的一个实例

tag_names字符串或字符串列表，默认值 = None

要克隆的标签名称。None（默认）克隆 estimator 中的所有标签。

返回:

自身

self 的引用。

类方法 create_test_instance(parameter_set='default')

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

参数:

parameter_set字符串，默认值=”default”

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

返回:

instance具有默认参数的类实例

类方法 create_test_instances_and_names(parameter_set='default')

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

参数:

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)

将变换器拟合到 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)、list 类型的 Series pd.DataFrame

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

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

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

状态变化

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

写入自身：_is_fitted：标志设为 True。_X：X，X 的强制转换副本，如果 remember_data 标签为 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)、list 类型的 Series pd.DataFrame

• 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 实例）。示例：面板中的所有序列分别进行去趋势化

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

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

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

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

类方法 get_class_tag(tag_name, tag_value_default=None)

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

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

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

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

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

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

按继承顺序排列。

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

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

参数:

tag_name字符串

标签值的名称。

tag_value_default任何类型

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

返回:

tag_value

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

类方法 get_class_tags()

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

每个兼容 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()

获取自身的配置标志。

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

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

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

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

返回:

config_dict字典

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

需要状态为“已拟合”。

参数:

deep布尔值，默认值=True

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

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

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

返回:

fitted_params键为字符串值的字典

已拟合参数字典，参数名称：参数值 键值对包括

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

• 如果 deep=True，还包含组件参数的键/值对，组件参数的索引格式为 [componentname]__[paramname] componentname 的所有参数都以 paramname 形式出现，并带有其值

• 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

类方法 get_param_defaults()

获取对象的参数默认值。

返回:

default_dict: 字典[字符串, 任何]

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

类方法 get_param_names(sort=True)

获取对象的参数名称。

参数:

sort布尔值，默认值=True

是否按字母顺序排序返回参数名称（True），还是按其在类 __init__ 中出现的顺序返回（False）。

返回:

param_names: 列表[字符串]

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

get_params(deep=True)

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

参数:

deep布尔值，默认值=True

是否返回组件的参数。

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

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

返回:

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 在实例上设置的标签。

在实例构造时。

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

3. 在父类的 _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。

inverse_transform(X, y=None)

对 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)、list 类型的 Series pd.DataFrame

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

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

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

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

返回:

X 的逆变换版本

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

is_composite()

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

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

返回:

composite: 布尔型

对象是否包含其值为 BaseObject 后代实例的参数。

property is_fitted

是否已调用 fit 方法。

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

返回:

布尔型

估计器是否已通过 fit 进行拟合。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object”) 的结果

返回:

反序列化的 self，其输出位于 path，是 cls.save(path) 的结果

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

反序列化的 self，其输出为 serial，是 cls.save(None) 的结果

reset()

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

结果是将 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')

将序列化的自身保存到字节类对象或 (.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)

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

参数:

config_dict字典

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

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

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool，默认=True

打印 self 时是只列出与默认值不同的参数 (False)，还是列出所有参数名和值 (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对 self 的引用。

注意

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

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

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

返回:

self对 self 的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

为自身设置 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

是否设置 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)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

Self

对 self 的引用。

transform(X, y=None)

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

所需状态

需要状态为“已拟合”。

访问自身

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

• 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)、list 类型的 Series pd.DataFrame

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

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

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

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

返回:

X 的变换版本

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

	transform
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 实例）。示例：面板中的所有序列分别进行去趋势化

• 如果 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)

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

所需状态

需要状态为“已拟合”。

访问自身

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

• self.is_fitted，必须为 True

写入自身

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

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

参数:

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)、list 类型的 Series pd.DataFrame

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

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

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

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

返回:

self估计器的已拟合实例