MiniRocket#

class MiniRocket(num_kernels=10000, max_dilations_per_kernel=32, n_jobs=1, random_state=None)[源代码]#

MINImally RandOm Convolutional KErnel Transform (MiniRocket)。

MiniRocket [1] 是 Rocket 的几乎确定性版本。它创建长度为 9 的卷积,权重限制在两个值,并使用 84 个固定卷积(其中六个使用一种权重,三个使用第二种权重)来种子膨胀。MiniRocket 仅适用于单变量时间序列。对于多变量时间序列,请使用 MiniRocketMultivariate 类。

此变换器为每个单独的时间序列拟合一组参数,并将它们应用于测试集中具有相同编号的时间序列。

要同时进行拟合和变换,而无需识别拟合/变换实例,请将此变换器包装在 FitInTransform 中,来自 sktime.transformations.compose

参数:
num_kernelsint, default=10,000

随机卷积核的数量。这应该是一个 84 的倍数。如果小于 84,将设置为 84。如果大于 84 且不是 84 的倍数,则用于变换数据的核数量将向下舍入到下一个正数倍数。

max_dilations_per_kernelint, default=32

每个核的最大膨胀数量。

n_jobsint, default=1

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

random_stateNone or int, default = None
属性:
num_kernels_int

在 rocket 变换中使用的实际核数量。这是 num_kernels 向下舍入到最接近 84 的倍数。如果 num_kernels 小于 84,则为 84。

另请参见

MultiRocketMultivariate, MiniRocket, MiniRocketMultivariate, Rocket

参考文献

[1]

Dempster, Angus and Schmidt, Daniel F and Webb, Geoffrey I, “MINIROCKET: A Very Fast (Almost) Deterministic Transform for Time Series Classification”,2020, https://dl.acm.org/doi/abs/10.1145/3447548.3467231, https://arxiv.org/abs/2012.08791

示例

>>> from sktime.transformations.panel.rocket import MiniRocket
>>> 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 = MiniRocket(num_kernels=512) 
>>> trf.fit(X_train) 
MiniRocket(...)
>>> 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()

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

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

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')[源代码]#

返回估计器的测试参数集。

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果未拟合,则引发 NotFittedError

参数:
method_namestr, optional

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

克隆是具有相同超参数和配置的不同对象,没有共享引用,处于初始化后状态。此函数等效于返回 sklearn.cloneself

等效于构造一个新的 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_tagsget_tag 检查当前的标签值。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr or list of str, default = None

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

返回:
self

self 的引用。

classmethod create_test_instance(parameter_set='default')[源代码]#

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

参数:
parameter_setstr, default=”default”

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

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

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

参数:
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)[源代码]#

将变换器拟合到 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 or 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame with 2-level row MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed pd.DataFrame

  • Hierarchical scitype = 时间序列的分层集合。pd.DataFrame with 3 or more level row MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

额外数据,例如用于变换的标签。如果 self.get_tag("requires_y")True,则必须在 fit 中传入,而不是可选。有关所需格式,请参阅类文档字符串了解详情。

返回:
self已拟合的估计器实例
fit_transform(X, y=None)[源代码]#

拟合数据,然后变换数据。

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

状态改变

将状态更改为“fitted”。

写入 self: _is_fitted : flag is set to True. _X : X, coerced copy of X, if remember_data tag is True

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

模型属性(以“_”结尾):取决于估计器

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

用于拟合和变换的数据。

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame with 2-level row MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed pd.DataFrame

  • Hierarchical scitype = 时间序列的分层集合。pd.DataFrame with 3 or more level row MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息,请参阅 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-row) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回中的实例对应于 X 中的实例
表中未列出的组合目前不支持
具体来说,举例说明
  • 如果 XSeries (例如,pd.DataFrame)

并且 transform-outputSeries,则返回单个相同 mtype 的 Series。示例:对单个序列去趋势

  • 如果 XPanel (例如,pd-multiindex) 并且 transform-output

Series,则返回具有与 X 相同数量实例的 Panel (变换器应用于每个输入的 Series 实例)。示例:面板中的所有序列都被单独去趋势

  • 如果 XSeriesPanel 并且 transform-output

Primitives,则返回一个 pd.DataFrame,行数与 X 中的实例数相同。示例:返回值的第 i 行包含第 i 个序列的均值和方差

  • 如果 XSeries 并且 transform-outputPanel

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

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

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

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

get_class_tag 方法是类方法,仅考虑类级别的标签值和覆盖来检索标签的值。

它从对象返回名称为 tag_name 的标签的值,考虑标签覆盖,优先级从高到低如下所示

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

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

按照继承顺序。

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

要检索可能具有实例覆盖的标签值,请使用 get_tag 方法。

参数:
tag_namestr

标签名称。

tag_value_defaultany type

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

返回:
tag_value

selftag_name 标签的值。如果找不到,则返回 tag_value_default

classmethod get_class_tags()[源代码]#

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

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

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

get_class_tags 方法是类方法,它考虑类级别标签值和覆盖来检索标签的值。

它返回一个字典,其键是类或其任何父类中设置的任何 _tags 属性的键。

值是相应的标签值,覆盖优先级从高到低如下所示

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

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

按照继承顺序。

实例可以根据超参数覆盖这些标签。

要检索可能具有实例覆盖的标签,请使用 get_tags 方法。

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

要包含动态标签的覆盖,请使用 get_tags

collected_tagsdict

标签名称:标签值对的字典。通过嵌套继承从 _tags 类属性收集。未被通过 set_tagsclone_tags 设置的动态标签覆盖。

get_config()[源代码]#

获取 self 的配置标志。

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

get_config 返回动态配置,这些配置会覆盖默认配置。

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

配置在 clonereset 调用下得以保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[源代码]#

获取拟合的参数。

所需状态

需要状态为“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()[源代码]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数:
sortbool, default=True

是否按字母顺序返回参数名称 (True),或按它们在类的 __init__ 中出现的顺序返回 (False)。

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数:
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)[源代码]#

从实例获取标签值,具有标签级别继承和覆盖。

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

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

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

  1. 通过在实例构建时在实例上通过 set_tagsclone_tags 设置的标签。

在实例构建时。

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

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

按照继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型,可选;default=None

如果找不到标签,则使用的默认/回退值

raise_errorbool

找不到标签时是否引发 ValueError

返回:
tag_valueAny

selftag_name 标签的值。如果找不到,则在 raise_error 为 True 时引发错误,否则返回 tag_value_default

引发:
ValueError, 如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则引发 ValueError

get_tags()[源代码]#

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

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

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

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

值是相应的标签值,覆盖优先级从高到低如下所示

  1. 通过在实例构建时在实例上通过 set_tagsclone_tags 设置的标签。

在实例构建时。

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

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

按照继承顺序。

返回:
collected_tagsdict

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

inverse_transform(X, y=None)[源代码]#

逆变换 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 or 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame with 2-level row MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed pd.DataFrame

  • Hierarchical scitype = 时间序列的分层集合。pd.DataFrame with 3 or more level row MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

返回:
X 的逆变换版本

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

property is_fitted[源代码]#

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

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

返回:
composite: 布尔类型

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

是否已调用 fit

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

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

返回:
bool

估计器是否已 fit

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
path 处得到的反序列化 self,是 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))``后获得的对象相等。

返回:
self

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

save(path=None, serialization_format='pickle')[源代码]#

将序列化的 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”,则 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 包含对文件的引用的 ZipFile
set_config(**config_dict)[源代码]#

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

参数:
config_dictdict

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

displaystr, “diagram” (default), 或 “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

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

warningsstr, “on” (default), 或 “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”:布尔类型,默认为 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 对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。对于复合对象,即包含其他对象的对象,可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果不会产生歧义,例如没有两个组件参数同名为 <parameter>,也可以使用不带 <component>__ 前缀的字符串 <parameter>

参数:
**params字典

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

返回:
self 对自身(设置参数后)的引用
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 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_state整数、RandomState 实例或 None,默认为 None

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

deepbool, default=True

是否在值类型为 skbase 对象的参数(即组件估计器)中设置随机状态。

  • 如果为 False,则只设置 selfrandom_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 对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

可以使用 get_tagsget_tag 检查当前的标签值。

参数:
**tag_dict字典

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

返回:
自身

对自身的引用。

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 or 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame with 2-level row MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed pd.DataFrame

  • Hierarchical scitype = 时间序列的分层集合。pd.DataFrame with 3 or more level row MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

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

转换

X

- 输出

返回类型

序列

基本类型

pd.DataFrame (1行)

面板

基本类型

pd.DataFrame

序列

序列

序列

面板

序列

面板

序列

面板

面板

返回中的实例对应于 X 中的实例
表中未列出的组合目前不支持
具体来说,举例说明
  • 如果 XSeries (例如,pd.DataFrame)

并且 transform-outputSeries,则返回单个相同 mtype 的 Series。示例:对单个序列去趋势

  • 如果 XPanel (例如,pd-multiindex) 并且 transform-output

Series,则返回具有与 X 相同数量实例的 Panel (变换器应用于每个输入的 Series 实例)。示例:面板中的所有序列都被单独去趋势

  • 如果 XSeriesPanel 并且 transform-output

Primitives,则返回一个 pd.DataFrame,行数与 X 中的实例数相同。示例:返回值的第 i 行包含第 i 个序列的均值和方差

  • 如果 XSeries 并且 transform-outputPanel

则返回一个类型为 pd-multiindexPanel 对象。示例:输出的第 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._Xself._X 通过 X 中的值进行更新。

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

用于更新转换的数据

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame with 2-level row MultiIndex (instance, time), 3D np.ndarray (instance, variable, time), list of Series typed pd.DataFrame

  • Hierarchical scitype = 时间序列的分层集合。pd.DataFrame with 3 or more level row MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

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