ElbowClassSum#

class ElbowClassSum(distance=None)[source]#

Elbow Class Sum (ECS) 转换器，用于选择通道/变量子集。

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

注意：在文献中，通道 (Channels)、变量 (variables)、维度 (dimensions)、特征 (features) 可互换使用。例如，通道选择 = 变量选择。

参数：
distance: sktime pairwise panel transform, str, or callable, 可选, default=None

如果是 panel 转换器，将直接用作算法中的距离。默认 None = 在展平时间序列上的欧几里得距离，即 FlatDist(ScipyDist())。如果是字符串，将表现为 FlatDist(ScipyDist(distance)) = 在展平时间序列上的 scipy 距离。如果可调用，必须是单变量 nested_univ x nested_univ -> 2D float np.array

属性：
channels_selected_整数列表

估计器选择的变量/通道列表，整数 (iloc 引用)，按顺序指代变量/通道

channels_selected_idx_pandas 兼容索引元素列表

估计器选择的变量/通道列表，如果数据无索引（无通道/变量名称），与 channels_selected 相同

distance_frame_DataFrame
类别中心对和通道的距离矩阵。

shape = [n_channels, n_class_centroids_pairs]

表 1 提供了 [1] 中的示例。

train_time_int

训练 ECS 所花费的时间。

注意

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

参考文献

..[1]: Bhaskar Dhariyal et al. “Fast Channel Selection for Scalable Multivariate Time Series Classification.” AALTD, ECML-PKDD, Springer, 2021

示例

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

可以使用任何 sktime 兼容的距离，例如，DTW 距离

>>> from sktime.dists_kernels import DtwDist
>>>
>>> cs = ElbowClassSum(distance=DtwDist())
>>> cs.fit(X, y)
ElbowClassSum(...)
>>> Xt = cs.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()

获取 self 的配置标志。

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为 self 设置 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_setstr, default=”default”

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

返回值：
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。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 True。

如果不是，则引发 NotFittedError。

参数：
method_namestr, 可选

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

引发：
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。

引发：
如果克隆不符合规范，则引发 RuntimeError，原因在于有缺陷的 __init__。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

clone_tags 设置来自另一个对象 estimator 的动态标签覆盖。

应仅在对象的 __init__ 方法中、在构建期间或紧接着通过 __init__ 构建后调用 clone_tags 方法。

动态标签被设置为 estimator 中标签的值，使用 tag_names 中指定的名称。

tag_names 的默认值是将 estimator 中的所有标签写入 self。

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

参数：
estimatorAn instance of :class:BaseObject or derived class
tag_namesstr or list of str, default = None

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

返回值：
self

对 self 的引用。

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

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

参数：
parameter_setstr, default=”default”

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

返回值：
instanceinstance of the class with default parameters
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数：
parameter_setstr, default=”default”

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

返回值：
objslist of instances of cls

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

nameslist of str, same length as 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 = 时间序列集合。pd.DataFrame 具有 2 级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 类型的 Series typed pd.DataFrame

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

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

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

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

返回值：
self估计器的已拟合实例
fit_transform(X, y=None)[source]#

拟合数据，然后转换它。

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

状态改变

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

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

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

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

参数：
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)，list 类型的 Series typed pd.DataFrame

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

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

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

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

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

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1-row) | | 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_defaultany type

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

返回值：
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 的配置标志。

配置是 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_paramsdict with str-valued keys

已拟合参数的字典，键值对为 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]#

获取对象的参数名称。

参数：
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，但不包括组件的参数。

返回值：
paramsdict with str-valued keys

参数的字典，键值对为 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 的单个标签的值，考虑标签覆盖，优先级按以下降序排列

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

在实例构建时。

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

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

按继承顺序。

参数：
tag_namestr

要检索的标签名称

tag_value_defaultany type, optional; 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 中的

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

  • self.is_fitted，必须为 True

参数：
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)，list 类型的 Series typed pd.DataFrame

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

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

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

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

返回值：
X 的逆向转换版本

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

is_composite()[source]#

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

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

返回值：
复合: bool

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

property is_fitted[source]#

fit 方法是否已被调用。

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

返回值：
bool

估计器是否已进行 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]#

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

serialization_format: str, 默认值 = “pickle”

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

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

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

参数：
config_dictdict

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

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

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

打印 self 时是仅列出与默认值不同的 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

返回值：
selfself 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数：
**paramsdict

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

返回值：
selfself 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 通过链式哈希（chain hashing）派生的整数，使用 sample_dependent_seed。这些整数保证了种子随机生成器的伪随机独立性。

根据 self_policy 的不同，仅当 deep=True 时，才应用于 self 中的 random_state 参数以及剩余的组件对象。

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

参数：
random_stateint, RandomState 实例或 None, 默认值=None

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

deepbool, 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 派生，并且通常与它不同

返回值：
selfself 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

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

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

有关数据格式的更多详细信息，请参阅 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 中的

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

  • self.is_fitted，必须为 True

写入 self

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

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

参数：
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)，list 类型的 Series typed pd.DataFrame

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

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

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

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

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