ElbowClassPairwise#

class ElbowClassPairwise[source]#

Elbow Class Pairwise (ECP) 变换器，用于选择通道子集。

概述：从多变量时间序列数据输入中，通过计算每个类别质心之间的距离来创建距离矩阵 [1]。ECP 使用肘部法则选择通道子集，该法则使所有通道上每对类别质心之间的距离最大化。

注意：通道 (channels)、变量 (variables)、维度 (dimensions) 和特征 (features) 在文献中可互换使用。

属性:
channels_selected_整数列表；整数表示通道的索引

由 ECP 选择的通道列表。

distance_frame_DataFrame
类别质心对与通道的距离矩阵。

shape = [通道数, 类别质心对数]

表 1 在 [1] 中提供了说明。

train_time_整型

训练 ECP 所花费的时间。

备注

原始仓库: mlgig/Channel-Selection-MTSC

参考文献

..[1]: Bhaskar Dhariyal et al. “用于可伸缩多变量时间序列分类的快速通道选择”。AALTD, ECML-PKDD, Springer, 2021

示例

>>> from sktime.transformations.panel.channel_selection import ElbowClassPairwise
>>> from sktime.utils._testing.panel import make_classification_problem
>>> X, y = make_classification_problem(n_columns=3, n_classes=3, random_state=42)
>>> cs = ElbowClassPairwise()
>>> cs.fit(X, y)
ElbowClassPairwise(...)
>>> Xt = cs.transform(X)

方法

check_is_fitted([方法名])

检查估计器是否已拟合。

clone()

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

clone_tags(估计器[, 标签名])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([参数集])

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

create_test_instances_and_names([参数集])

创建所有测试实例及其名称列表。

fit(X[, y])

将变换器拟合到 X，可选择拟合到 y。

fit_transform(X[, y])

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

get_class_tag(标签名[, 默认标签值])

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

get_class_tags()

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

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取已拟合参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

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

get_tag(标签名[, 默认标签值, ...])

从实例获取标签值，并考虑标签级别继承和覆盖。

get_tags()

从实例获取标签，并考虑标签级别继承和覆盖。

get_test_params([参数集])

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

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

is_composite()

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

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

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_name字符串，可选

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

引发：
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

相当于构造一个 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

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

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

将变换器拟合到 X，可选择拟合到 y。

状态变化

将状态更改为“已拟合”("fitted")。

写入 self

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

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

有关数据格式的更多详细信息，请参阅 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 的转换后版本。

状态变化

将状态更改为“已拟合”("fitted")。

写入 self：_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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型的 pd.DataFrame list

  • Hierarchical scitype = 分层时间序列集合。具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time) 的 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（转换器应用于每个输入的 Series 实例）。示例：面板中的所有序列都被单独去趋势化

  • 如果 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 的标签值，同时考虑标签覆盖，优先级从高到低如下所示：

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

  2. 在父类的 _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 的任何属性的键。

值是对应的标签值，覆盖优先级从高到低如下所示：

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

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

获取已拟合参数。

所需状态

要求状态为“已拟合”("fitted")。

参数：
deep布尔值，默认为 True

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

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

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

返回值：
fitted_params键为字符串的字典

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

  • 总是：此对象的所有拟合参数，如同通过 get_param_names 获取一样，值是此对象该键对应的拟合参数值

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

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

classmethod get_param_defaults()[source]#

获取对象的默认参数。

返回值：
default_dict: 字典[字符串, 任意类型]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数：
sort布尔值，默认为 True

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

返回值：
param_names: 字符串列表

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

get_params(deep=True)[source]#

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

参数：
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)[source]#

从实例获取标签值，并考虑标签级别继承和覆盖。

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，同时考虑标签覆盖，优先级从高到低如下所示：

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

在实例构造时。

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

  2. 在父类的 _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 设置的标签的键。

值是对应的标签值，覆盖优先级从高到低如下所示：

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

在实例构造时。

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

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

按继承顺序。

返回值：
collected_tags字典

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

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

返回 skbase 对象的测试参数设置。

get_test_params 是一个统一的接口点，用于存储测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应该返回一个单独的 dict，或者一个 list 的 dict。

每个 dict 都是一个用于测试的参数配置，可用于构建一个“有趣的”测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 都应该有效。

get_test_params 不必返回固定的字典列表，它也可以返回动态或随机的参数设置。

参数：
parameter_set字符串，默认为“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 方法。

所需状态

要求状态为“已拟合”("fitted")。

访问 self 中的属性

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

  • self.is_fitted，必须为 True

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

用于拟合转换的数据。

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

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

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

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

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

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

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

返回值：
X 的逆转换版本

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

is_composite()[source]#

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

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

返回值：
复合: 布尔值

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

property is_fitted[source]#

是否已调用 fit。

检查对象在构造期间应初始化为 ``False`` 的 _is_fitted` 属性，并在调用对象的 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))`` 获得的对象。

返回值：
self

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

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

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

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

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

参数：
pathNone 或文件位置（字符串或 Path）

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

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

  • path=”/home/stored/estimator”，则将生成一个 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format: 字符串，默认为“pickle”

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

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

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

参数：
config_dict字典

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

display字符串，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_only布尔值，默认为 True

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

warnings字符串，“on”（默认）或“off”

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

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

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

backend:parallel字符串，可选，默认为“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”：布尔值，默认为 True；False 可阻止 ray 在

      并行化后关闭。

    • “logger_name”：字符串，默认为“ray”；要使用的记录器名称。

    • “mute_warnings”：布尔值，默认为 False；如果为 True，则抑制警告

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

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

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前，不执行输入检查和转换

  • 有效的 mtype 字符串 - 输入被假定为指定的 mtype，执行转换但不进行检查

output_conversion字符串，“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 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用明确（例如，没有两个组件参数具有相同的名称 <parameter>），也可以使用不带 <component>__ 的字符串 <parameter>。

参数：
**params字典

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 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 从链式哈希中采样，保证了种子随机生成器的伪随机独立性。

应用于 self 中的 random_state 参数（取决于 self_policy）以及仅当 deep=True 时应用于剩余的组件对象。

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

参数：
random_state整数，RandomState 实例或 None，默认为 None

伪随机数生成器，用于控制随机整数的生成。传入整数可在多次函数调用中实现可重现的输出。

deep布尔值，默认为 True

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

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

  • 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policy字符串，“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 并返回转换后的版本。

所需状态

要求状态为“已拟合”("fitted")。

访问 self 中的属性

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

  • self.is_fitted，必须为 True

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

要转换的数据。

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

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

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

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

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

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

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

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

转换

X

-输出

返回类型

Series

基元

pd.DataFrame (1 行)

Panel

基元

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

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

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

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

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

所需状态

要求状态为“已拟合”("fitted")。

访问 self 中的属性

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

  • self.is_fitted，必须为 True

写入 self

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

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

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

用于更新转换的数据

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

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

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

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

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

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

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

返回值：
self估计器的已拟合实例