RandomShapeletTransform#

class RandomShapeletTransform(n_shapelet_samples=10000, max_shapelets=None, min_shapelet_length=3, max_shapelet_length=None, remove_self_similar=True, time_limit_in_minutes=0.0, contract_max_n_shapelet_samples=inf, n_jobs=1, parallel_backend=None, batch_size=100, random_state=None)[source]#

随机形状变换。

按照 [Rddd99dcb5614-1]_[Rddd99dcb5614-2]_ 中的思路实现的二元形状变换，使用随机提取的形状。

概述：输入“n”个序列，每个序列有“d”维，长度为“m”。连续提取候选形状并分批过滤。

对于每个候选形状

  • 从一个实例中提取具有随机长度、位置和维度的形状

  • 使用它到训练案例的距离，计算形状的信息增益

  • 如果无法获得比当前最差信息增益更高的增益，则放弃评估该形状

对于每个形状批次

  • 将每个候选形状添加到其类别的形状堆中，如果达到最大形状数量，则移除信息增益最低的形状

  • 从堆中移除自相似的形状

使用最终过滤后的形状集，将数据转换为从序列到每个形状的距离向量。

参数：
n_shapelet_samplesint, 默认值=10000

用于最终变换的候选形状数量。过滤后将保留信息增益最多的形状，数量 <= max_shapelets。

max_shapeletsint 或 None, 默认值=None

最终变换保留的最大形状数量。每个类别值将有自己的最大值，设置为 n_classes / max_shapelets。如果为 None，则使用 10 * n_instances 和 1000 之间的最小值。

min_shapelet_lengthint, 默认值=3

候选形状长度的下限。

max_shapelet_lengthint 或 None, 默认值= None

候选形状长度的上限。如果为 None，则不使用最大长度。

remove_self_similarboolean, 默认值=True

合并候选形状时，移除重叠的“自相似”形状。

time_limit_in_minutesint, 默认值=0

限制构建时间的以分钟为单位的时间契约，会覆盖 n_shapelet_samples。默认值 0 表示使用 n_shapelet_samples。

contract_max_n_shapelet_samplesint, 默认值=np.inf

设置 time_limit_in_minutes 时提取的最大形状数量。

n_jobsint, 默认值=1

在 fit 和 transform 期间并行运行的作业数量。-1 表示使用所有处理器。

parallel_backendstr, ParallelBackendBase 实例或 None, 默认值=None

指定 joblib 中并行处理后端实现，如果为 None，则默认使用“threads”的“prefer”值。有效选项为“loky”、“multiprocessing”、“threading”或自定义后端。更多详细信息请参阅 joblib Parallel 文档。

batch_sizeint 或 None, 默认值=100

在合并到最佳形状集之前处理的候选形状数量。

random_stateint 或 None, 默认值=None

随机数生成种子。

属性：
n_classesint

类别数量。

n_instancesint

训练案例数量。

n_dimsint

每个案例的维度数量。

series_lengthint

每个序列的长度。

classes_list

类别标签。

shapeletslist

数据集处理后存储的形状及相关信息。列表中的每个项是一个元组，包含以下 7 个项：（形状信息增益、形状长度、提取形状的起始位置、形状维度、提取形状的实例在拟合中的索引、形状的类别值、z-标准化的形状数组）

另请参阅

ShapeletTransformClassifier

注意

有关 Java 版本，请参阅 TSML。

参考文献

[1]

Jon Hills et al., “Classification of time series by shapelet transformation”, Data Mining and Knowledge Discovery, 28(4), 851–881, 2014.

[2]

A. Bostrom and A. Bagnall, “Binary Shapelet Transform for Multiclass Time Series Classification”, Transactions on Large-Scale Data and Knowledge Centered Systems, 32, 2017.

示例

>>> from sktime.transformations.panel.shapelet_transform import (
...     RandomShapeletTransform
... )
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> t = RandomShapeletTransform(
...     n_shapelet_samples=500,
...     max_shapelets=10,
...     batch_size=100,
... ) 
>>> t.fit(X_train, y_train) 
RandomShapeletTransform(...)
>>> X_t = t.transform(X_train)

方法

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

检查对象是否由其他 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。
classmethod get_test_params(parameter_set='default')[source]#

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

参数：
parameter_setstr, 默认值=”default”

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

返回：
paramsdict 或 dict 列表, 默认值 = {}

用于创建类的测试实例的参数。每个 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]#

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

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

等同于使用对象的参数构造一个新的 type(self) 实例，即 type(self)(**self.get_params(deep=False))。

如果在对象上设置了配置，克隆也会具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

其值也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改对象本身。

引发：
如果由于错误的 __init__ 导致克隆不符合规范，则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

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

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

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

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

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

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

tag_names 的默认值 (None) 会将 estimator 中的所有标签写入对象本身。

当前的标签值可以通过 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。

状态改变

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

写入对象自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

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

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

状态改变

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

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

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

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

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

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

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

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

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

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

有关数据格式的更多详细信息，请参阅 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，则返回的是 Panel，其实例数量与 X 相同（变换器应用于每个输入的 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)[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, 默认值=True

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

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

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

返回：
fitted_params键为 str 的 dict

拟合参数的字典，包含 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, 默认值=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 的 dict

参数字典，包含 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_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 (1D 或 2D)

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

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

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

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

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

返回：
X 的逆变换后版本

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

is_composite()[source]#

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

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

返回：
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) 的结果
返回：
反序列化的 self，其输出与 cls.save(path) 在 path 处的输出相同。
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化的 self，其输出与 cls.save(None) 的输出 serial 相同。
reset()[source]#

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

将 self 重置为构造函数调用后直接处于的状态，并保留相同的超参数。set_config 设置的配置值也保留。

reset 调用会删除所有对象属性，除了：

  • 超参数 = __init__ 的参数写入 self，例如 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”，则会在当前工作目录下生成一个 zip 文件 estimator.zip。

  • 如果 path=”/home/stored/estimator”，则会在 /home/stored/ 中存储一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, default = “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, default=True

打印 self 时是仅列出与默认值不同的参数（False），还是列出所有参数名称和值（False）。不嵌套，即仅影响 self，不影响组件估计器。

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”；要使用的 logger 名称。

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

返回：
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]#

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为由 random_state 通过链式哈希（chain hashing）和 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, default=None

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

deepbool, 默认值=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 派生而来，通常与它不同

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

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

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

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

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

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

当前的标签值可以通过 get_tags 或 get_tag 进行检查。

参数：
**tag_dictdict

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

返回：
Self

self 的引用。

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

变换 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

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

有关数据格式的更多详细信息，请参阅 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，则返回的是 Panel，其实例数量与 X 相同（变换器应用于每个输入的 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.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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list

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

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

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

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

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