Rocket#

class Rocket(num_kernels=10000, normalise=True, n_jobs=1, random_state=None)[source]#

随机卷积核变换 (ROCKET)。

ROCKET [1] 生成随机卷积核，包括随机长度和膨胀。它对时间序列进行转换，每个核提取两个特征。第一个特征是全局最大池化，第二个是正值的比例。

该转换器为每个单独的时间序列拟合一组参数，并在转换时将拟合的参数 i 应用于第 i 个时间序列。常规用法要求 fit 和 transform 中的时间序列数量相同。

为了同时拟合和转换时间序列，且无需标识 fit/transform 实例，请将此转换器包装在 FitInTransform 中，该类来自 sktime.transformations.compose。

参数:
num_kernelsint, default=10,000

随机卷积核的数量。

normaliseboolean, default True

是否对每个实例的输入时间序列进行标准化。

n_jobsint, default=1

transform 并行运行的作业数。-1 表示使用所有处理器。

random_stateNone 或 int, 可选, default = None
属性:
is_fitted

fit 是否已被调用。

另请参阅

MultiRocketMultivariate, MiniRocket, MiniRocketMultivariate, Rocket

参考资料

[1]
Tan, Chang Wei and Dempster, Angus and Bergmeir, Christoph

and Webb, Geoffrey I, “ROCKET: 使用随机卷积核进行超快速且准确的时间序列分类”,2020, https://link.springer.com/article/10.1007/s10618-020-00701-z, https://arxiv.org/abs/1910.13051

classification using random convolutional kernels”，2020, https://link.springer.com/article/10.1007/s10618-020-00701-z, https://arxiv.org/abs/1910.13051

示例

>>> from sktime.transformations.panel.rocket import Rocket
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train") 
>>> X_test, y_test = load_unit_test(split="test") 
>>> trf = Rocket(num_kernels=512) 
>>> trf.fit(X_train) 
Rocket(...)
>>> X_train = trf.transform(X_train) 
>>> X_test = trf.transform(X_test)

方法

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）更新转换器。
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

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

返回:
paramsdict 或 dict 列表, default = {}

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

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数相当于返回 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_namesstr 或 str 列表, default = None

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

返回:
self

对 self 的引用。

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

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

参数:
parameter_setstr, default=”default”

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

返回:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”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。

状态改变

将状态更改为“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 兼容数据格式的数据, default=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 兼容数据格式的数据, default=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 个窗口

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]#

获取拟合参数。

所需状态

要求状态为“fitted”（已拟合）。

参数:
deepbool, default=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, 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，但不包括组件的参数。

返回:
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任何类型, 可选; 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。

所需状态

要求状态为“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 兼容数据格式的数据, default=None

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

返回:
X 的逆变换版本

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

is_composite()[source]#

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

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

返回:
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) 的结果
返回:
在 path 位置反序列化 self，结果为 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 或 文件位置 (str 或 Path)

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

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

  • path=”/home/stored/estimator”，则 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” (default), or “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = HTML 框图表示

  • “text” = 字符串输出

print_changed_onlybool, default=True

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

warningsstr, “on” (default), or “off”

是否触发警告，仅影响 sktime 的警告

  • “on” = 将触发 sktime 的警告

  • “off” = 将不触发 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行的后端，选项之一：

  • “None”: 按顺序执行循环，简单的列表推导式

  • “loky”, “multiprocessing”, “threading”: 使用 joblib.Parallel

  • “joblib”: 自定义和第三方 joblib 后端，例如 spark

  • “dask”: 使用 dask，需要在环境中安装 dask 包

  • “ray”: 使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, optional, 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”; 要使用的日志记录器名称。

    • “mute_warnings”: bool, default=False; 如果为 True，则抑制警告

input_conversionstr, 选项之一: “on” (default), “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对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
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_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, default=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 导出，通常与之不同

返回:
self对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
对象自身

对自身的引用。

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 兼容数据格式的数据, default=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，则返回是 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）更新转换器。

所需状态

要求状态为“fitted”（已拟合）。

访问 self 中的属性

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

  • self.is_fitted，必须为 True

写入 self

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

  • 如果 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 = 时间序列集合。带有 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 兼容数据格式的数据, default=None

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

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