MiniRocketMultivariate#
- class MiniRocketMultivariate(num_kernels=10000, max_dilations_per_kernel=32, n_jobs=1, random_state=None)[source]#
最小随机卷积核转换 (MiniRocket) 多变量。
MiniRocketMultivariate [1] 是 Rocket 的一个几乎确定性的版本。它创建长度为 9 的卷积,其权重限制为两个值,并使用 84 个固定卷积,其中六个是一种权重,三个是第二种权重,用于播种膨胀。MiniRocketMultivariate 适用于单变量和多变量时间序列。
此转换器为每个单独的时间序列拟合一组参数,并使用拟合后的参数 i 将转换应用于转换中的第 i 个时间序列。基本用法要求拟合和转换中的时间序列数量相同。
要同时拟合和转换时间序列,而无需识别拟合/转换实例,请将此转换器包装在
FitInTransform
中,来自sktime.transformations.compose
。- 参数:
- num_kernelsint, 默认=10,000
随机卷积核的数量。这应该是 84 的倍数。如果低于 84,则会设置为 84。如果高于 84 且不是 84 的倍数,则用于转换数据的核数量将向下取整到最接近 84 的正倍数。
- max_dilations_per_kernelint, 默认=32
每个卷积核的最大膨胀数。
- n_jobsint, 默认=1
用于
transform
并行运行的作业数量。-1
表示使用所有处理器。- random_stateNone 或 int, 默认 = 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 MiniRocketMultivariate >>> from sktime.datasets import load_basic_motions >>> X_train, y_train = load_basic_motions(split="train") >>> X_test, y_test = load_basic_motions(split="test") >>> trf = MiniRocketMultivariate(num_kernels=512) >>> trf.fit(X_train) MiniRocketMultivariate(...) >>> 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])从类中获取类标签值,具有来自父类的标签级别继承。
从类中获取类标签,具有来自父类的标签级别继承。
获取 self 的配置标志。
get_fitted_params
([deep])获取拟合参数。
获取对象的参数默认值。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例获取标签值,具有标签级别继承和覆盖。
get_tags
()从实例获取标签,具有标签级别继承和覆盖。
get_test_params
([parameter_set])返回 skbase 对象的测试参数设置。
inverse_transform
(X[, y])对 X 进行逆转换并返回逆转换后的版本。
检查对象是否由其他 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。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查估计器是否已拟合。
is_fitted
属性应在调用对象的fit
方法时设置为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
。- 引发:
- 如果克隆不符合规范,例如由于
__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 或 list of 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])
- nameslist of str, 与 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)
,由Series
类型pd.DataFrame
组成的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认=None
附加数据,例如用于转换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传入,而不是可选。有关所需格式,请参阅类文档字符串了解详细信息。
- X符合
- 返回:
- self估计器的已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后对其进行转换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态变化
将状态更改为“已拟合”。
写入 self: _is_fitted: 标志设置为 True。 _X: X,如果 remember_data 标签为 True,则为 X 的强制转换副本
如果可能,可能强制转换为内部类型或通过引用转换为 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)
,由Series
类型pd.DataFrame
组成的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认=None
附加数据,例如用于转换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传入,而不是可选。有关所需格式,请参阅类文档字符串了解详细信息。
- X符合
- 返回:
- 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 实例)。示例:面板中的所有序列都被单独去趋势如果
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
的标签值,考虑标签覆盖,优先级降序如下在类的
_tags
属性中设置的标签。在父类的
_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
任何属性的键。值是对应的标签值,覆盖优先级降序如下
在类的
_tags
属性中设置的标签。在父类的
_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, 默认=True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名: 值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。
如果为 False,将返回此对象的参数名: 值字典,但不包括组件的拟合参数。
- 返回:
- fitted_params键为 str 的字典
拟合参数字典,参数名 : 参数值 键值对包括
始终:此对象的所有拟合参数,如同通过 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
参数字典,参数名 : 参数值 键值对包括
始终:此对象的所有参数,如同通过
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
的单个标签的值,考虑标签覆盖,优先级降序如下通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_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
。
- ValueError,如果
- get_tags()[source]#
从实例获取标签,具有标签级别继承和覆盖。
每个与
scikit-base
兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。该
get_tags
方法返回一个标签字典,其中的键是类或其任何父类中设置的_tags
属性的任何键,或是通过set_tags
或clone_tags
设置的标签。值是对应的标签值,覆盖优先级降序如下
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_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
,或一个dict
的list
。每个
dict
都是用于测试的参数配置,可用于构建一个“有趣的”测试实例。cls(**params)
的调用对于get_test_params
返回值中的所有字典params
都应该是有效的。get_test_params
不需要返回固定的字典列表,它也可以返回动态或随机的参数设置。- 参数:
- parameter_setstr, 默认=”default”
要返回的测试参数集的名称,用于测试。如果没有为值定义特殊参数,将返回 “default” 集。
- 返回:
- paramsdict 或 dict 列表,默认为 {}
用于创建类测试实例的参数。每个字典都是构建一个“有趣”测试实例的参数,即 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
方法。- 所需状态
要求状态为“已拟合”。
访问 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)
,由Series
类型pd.DataFrame
组成的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认=None
附加数据,例如用于转换的标签。某些转换器需要此项,详细信息请参阅类文档字符串。
- X符合
- 返回:
- 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”) 的结果
- 返回:
- 反序列化的 self,其输出位于
path
处,由cls.save(path)
生成
- 反序列化的 self,其输出位于
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的 self,其输出是
serial
,由cls.save(None)
生成
- 反序列化的 self,其输出是
- 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]#
将序列化的 self 保存到字节类对象或到 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化 self;如果path
是文件位置,则将 self 保存到该位置,格式为 zip 文件。保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化的 self。此类使用默认序列化 (pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,self 将保存到内存对象中;如果为文件位置,self 将保存到该文件位置。
如果 path=”estimator”,则会在当前工作目录 (cwd) 创建一个名为
estimator.zip
的 zip 文件。如果 path=”/home/stored/estimator”,则会
将一个名为
estimator.zip
的 zip 文件存储在/home/stored/
中。- 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 时是仅列出与默认值不同的参数 (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
在并行化后关闭。 shutting down after parallelization.
- “shutdown_ray”:bool, 默认为 True;False 会阻止
“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
- 返回:
- self对 self 的引用。
备注
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic 中。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。可以使用参数键字符串
<component>__<parameter>
来访问复合对象(即包含其他对象的对象)中组件<component>
中的<parameter>
。如果引用清晰无歧义(例如,没有两个组件参数同名<parameter>
),也可以使用字符串<parameter>
,而无需<component>__
前缀。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。
- 返回:
- self对 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_stateint、RandomState 实例或 None,默认为 None
伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。
- deepbool, 默认=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
,通常与它不同。
- 返回:
- self对 self 的引用
- 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)
,由Series
类型pd.DataFrame
组成的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认=None
附加数据,例如用于转换的标签。某些转换器需要此项,详细信息请参阅类文档字符串。
- X符合
- 返回:
- X 的转换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
transform
X
-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 个窗口
- 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)
,由Series
类型pd.DataFrame
组成的list
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,符合 sktime 数据格式的数据,默认=None
附加数据,例如用于转换的标签。某些转换器需要此项,详细信息请参阅类文档字符串。
- X符合
- 返回:
- self估计器的已拟合实例