KinematicFeatures#
- class KinematicFeatures(features=None)[源代码]#
运动学特征变换器 - 速度、加速度、曲率。
接受一个离散 N 维空间曲线,N>=1,并计算一系列运动学特征。
对于有噪声的时间序列,强烈建议将其与
KalmanFilterTransformerPK
或KalmanFilterTransformerFP
(先验),或其它平滑或轨迹拟合变换器一起通过流水线处理,因为此变换器不执行自身的平滑操作。对于速度等的最小值/最大值/分位数,与
SummaryTransformer
(后置)一起通过流水线处理。对于在离散时间观测到的时间序列输入 \(x(t)\),此变换器(选择时)计算以下量的离散化版本:
"v"
- 速度向量:\(\vec{v}(t) := \Delta x(t)\)"v_abs"
- 绝对速度:\(v(t) := \left| \Delta x(t) \right|\)"a"
- 加速度向量:\(\vec{a}(t) := \Delta \Delta x(t)\)"a_abs"
- 绝对加速度:\(a(t) := \left| \Delta \Delta x(t) \right|\)"curv"
- 曲率:\(c(t) := \frac{\sqrt{v(t)^2 a(t)^2 - \left\langle \vec{v}(t), \vec{a}(t)\right\rangle^2}}{v(t)^3}\)
其中 \(\Delta\) 表示一阶有限差分,即对于任何离散时间序列 \(z(t)\),有 \(\Delta z(t) = z(t) - z(t-1)\)。
注意:此估计器目前忽略非等距位置索引,并且仅考虑整数位置索引。
- 参数:
- features字符串或字符串列表,可选,默认为 [“v_abs”, “a_abs”, “c_abs”]
要计算的特征列表,可能的特征包括:
“v” - 速度向量
“v_abs” - 绝对速度
“a” - 加速度向量
“a_abs” - 绝对加速度
“curv” - 曲率
- 属性:
is_fitted
fit
方法是否已被调用。
示例
>>> import numpy as np >>> import pandas as pd >>> from sktime.transformations.series.kinematic import KinematicFeatures
>>> traj3d = pd.DataFrame(columns=["x", "y", "z"]) >>> traj3d["x"] = pd.Series(np.sin(np.arange(200)/100)) >>> traj3d["y"] = pd.Series(np.cos(np.arange(200)/100)) >>> traj3d["z"] = pd.Series(np.arange(200)/100)
>>> t = KinematicFeatures() >>> Xt = t.fit_transform(traj3d)
方法
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_fitted_params
([deep])获取拟合参数。
获取对象的参数默认值。
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 进行逆变换并返回逆变换后的版本。
检查对象是否由其他 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。
- check_is_fitted(method_name=None)[源代码]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_name字符串,可选
调用此函数的方法名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[源代码]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等同于返回自身的
sklearn.clone
。等同于使用自身的参数构造
type(self)
的新实例,即type(self)(**self.get_params(deep=False))
。如果自身设置了配置,克隆也将具有与原始对象相同的配置,等同于调用
cloned_self.set_config(**self.get_config())
。在值上也等同于调用
self.reset
,区别在于clone
返回新对象,而不是像reset
那样改变自身。- 引发:
- 如果克隆不符合要求,则引发 RuntimeError,原因是
__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_tags
或get_tag
查看。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_names字符串或字符串列表,默认为 None
要克隆的标签名称。默认值(
None
)克隆estimator
的所有标签。
- 返回:
- self
对
self
的引用。
- classmethod create_test_instance(parameter_set='default')[源代码]#
使用第一个测试参数集构建类的实例。
- 参数:
- parameter_set字符串,默认为“default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回“default”集合。
- 返回:
- instance使用默认参数的类的实例
- classmethod create_test_instances_and_names(parameter_set='default')[源代码]#
创建所有测试实例的列表以及它们的名称列表。
- 参数:
- parameter_set字符串,默认为“default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回“default”集合。
- 返回:
- objscls 的实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- names字符串列表,长度与 objs 相同
第 i 个元素是 obj 在测试中第 i 个实例的名称。如果实例多于一个,命名约定是
{cls.__name__}-{i}
,否则是{cls.__name__}
- fit(X, y=None)[源代码]#
使用 X 拟合变换器,可选使用 y。
- 状态更改
将状态更改为“fitted”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
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
(实例,时间)的pd.DataFrame
,3Dnp.ndarray
(实例,变量,时间),或 Series 类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。可以是具有 3 级或更多级行MultiIndex
(hierarchy_1, …, hierarchy_n, 时间)的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于变换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
方法中传入,不可选。有关所需格式,请参阅类文档字符串了解详情。
- 返回:
- self估计器的已拟合实例
- fit_transform(X, y=None)[源代码]#
拟合数据,然后对其进行变换。
将变换器拟合到 X 和 y,并返回 X 的变换后版本。
- 状态更改
将状态更改为“fitted”。
写入自身:_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
(实例,时间)的pd.DataFrame
,3Dnp.ndarray
(实例,变量,时间),或 Series 类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。可以是具有 3 级或更多级行MultiIndex
(hierarchy_1, …, hierarchy_n, 时间)的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于变换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
方法中传入,不可选。有关所需格式,请参阅类文档字符串了解详情。
- 返回:
- X 的变换后版本
- 类型取决于 X 的类型和 scitype:transform-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 实例)。示例: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)[源代码]#
从类获取类标签值,具有来自父类的标签级别继承。
每个
scikit-base
兼容对象都有一个标签字典,用于存储关于对象的元数据。get_class_tag
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。它返回对象中名为
tag_name
的标签值,考虑标签覆盖,优先级降序排列如下:在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
不考虑在实例上通过
set_tags
或clone_tags
设置的、定义在实例上的动态标签覆盖。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_name字符串
标签值名称。
- tag_value_default任意类型
如果未找到标签的默认/回退值。
- 返回:
- tag_value
self
中tag_name
标签的值。如果未找到,返回tag_value_default
。
- classmethod get_class_tags()[源代码]#
从类获取类标签,具有来自父类的标签级别继承。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构建后不会改变。get_class_tags
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中
_tags
的任何属性的键。值是相应的标签值,覆盖按优先级降序排列如下:
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能包含实例覆盖的标签,请改用
get_tags
方法。不考虑在实例上通过
set_tags
或clone_tags
设置的、定义在实例上的动态标签覆盖。要包含动态标签的覆盖,请使用
get_tags
。- collected_tags字典
标签名称 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集。不被通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[源代码]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的临时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用时保留。- 返回:
- config_dict字典
配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后收集来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[源代码]#
获取拟合参数。
- 所需状态
需要状态为“fitted”。
- 参数:
- deep布尔值,默认为 True
是否返回组件的拟合参数。
如果为 True,将返回一个字典,其中包含此对象的参数名称 : 值,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。
如果为 False,将返回一个字典,其中包含此对象的参数名称 : 值,但不包含组件的拟合参数。
- 返回:
- fitted_params键为字符串的字典
已拟合参数的字典, 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)[源代码]#
获取对象的参数名称。
- 参数:
- sort布尔值,默认为 True
是否按字母顺序排序返回参数名称 (True),或按它们在类
__init__
中出现的顺序返回 (False)。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的相同顺序排列。如果sort=True
,则按字母顺序排序。
- get_params(deep=True)[源代码]#
获取此对象的参数值字典。
- 参数:
- deep布尔值,默认为 True
是否返回组件的参数。
如果
True
,将返回一个字典,其中包含此对象的参数名称 : 值,包括组件(=BaseObject
类型参数)的参数。如果
False
,将返回一个字典,其中包含此对象的参数名称 : 值,但不包含组件的参数。
- 返回:
- params键为字符串的字典
参数字典, 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
的单个标签值,考虑标签覆盖,优先级降序排列如下:通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构建时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_name字符串
要检索的标签名称
- tag_value_default任意类型,可选;默认为 None
如果未找到标签的默认/回退值
- raise_error布尔值
未找到标签时是否引发
ValueError
- 返回:
- tag_value任意类型
self
中tag_name
标签的值。如果未找到,并且raise_error
为 True,则引发错误,否则返回tag_value_default
。
- 引发:
- ValueError,如果
raise_error
为True
。 如果
tag_name
不在self.get_tags().keys()
中,则引发ValueError
。
- ValueError,如果
- get_tags()[源代码]#
从实例获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构建后不会改变。get_tags
方法返回一个标签字典,其键是类或其任何父类中_tags
的任何属性的键,或通过set_tags
或clone_tags
设置的标签。值是相应的标签值,覆盖按优先级降序排列如下:
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构建时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tags字典
标签名称 : 标签值 对的字典。通过嵌套继承从
_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 或 2D)Panel
scitype = 时间序列集合。可以是具有 2 级行MultiIndex
(实例,时间)的pd.DataFrame
,3Dnp.ndarray
(实例,变量,时间),或 Series 类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。可以是具有 3 级或更多级行MultiIndex
(hierarchy_1, …, hierarchy_n, 时间)的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于变换的标签。某些变换器需要此数据,详情请参阅类文档字符串。
- 返回:
- X 的逆变换后版本
与 X 类型相同,并符合 mtype 格式规范
- is_composite()[源代码]#
检查对象是否由其他 BaseObjects 组成。
复合对象是指将对象作为参数包含在内的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: 布尔值
对象是否有任何参数的值是
BaseObject
的派生实例。
- property is_fitted[源代码]#
fit
方法是否已被调用。检查对象的
_is_fitted
属性,该属性在对象构建期间应初始化为False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- 布尔值
估计器是否已 fit。
- classmethod load_from_path(serial)[源代码]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 在
path
处生成输出的已反序列化自身,对应于cls.save(path)
- 在
- classmethod load_from_serial(serial)[源代码]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 生成输出
serial
的已反序列化自身,对应于cls.save(None)
- 生成输出
- reset()[源代码]#
将对象重置为干净的初始化后状态。
结果是将
self
设置为构造函数调用后直接所处的状态,具有相同的超参数。通过set_config
设置的配置值也保留。reset
调用删除任何对象属性,除了超参数 = 写入
self
的__init__
的参数,例如self.paramname
,其中paramname
是__init__
的参数包含双下划线的对象属性,即字符串“__”。例如,名为“__myattr”的属性将被保留。
配置属性,配置保持不变。即,
reset
前后get_config
的结果相等。
类方法和对象方法,以及类属性也不受影响。
等同于
clone
,区别在于reset
改变自身而不是返回新对象。在
self.reset()
调用后,self
在值和状态上等同于构造函数调用``type(self)(**self.get_params(deep=False))``后获得的对象。- 返回:
- self
类实例重置为干净的初始化后状态,但保留当前超参数值。
- save(path=None, serialization_format='pickle')[源代码]#
将序列化的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化自身;如果path
是文件位置,则将自身在该位置存储为 zip 文件保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即 type(self);_obj - 序列化的自身。此类使用默认序列化方式 (pickle)。
- 参数:
- pathNone 或文件位置(字符串或 Path)
如果为 None,则将自身保存到内存对象;如果 path 是文件位置,则将自身保存到该文件位置。如果
path=”estimator”,则将在当前工作目录 (cwd) 下创建 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则 zip 文件
estimator.zip
将
存储在
/home/stored/
中。- serialization_format: 字符串,默认为“pickle”
用于序列化的模块。可用选项是“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- set_config(**config_dict)[源代码]#
将配置标志设置为给定值。
- 参数:
- config_dict字典
配置名称 : 配置值 对的字典。有效配置、值及其含义如下所示
- display字符串,“diagram”(默认)或“text”
jupyter 内核如何显示自身的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_only布尔值,默认为 True
打印自身时是否只列出与默认值不同的自身参数 (True),还是列出所有参数名称和值 (False)。不嵌套,即仅影响自身,不影响组件估计器。
- warnings字符串,“on”(默认)或“off”
是否引发警告,仅影响来自 sktime 的警告
“on” = 将引发来自 sktime 的警告
“off” = 不会引发来自 sktime 的警告
- backend:parallel字符串,可选,默认为“None”
对广播/向量化进行并行处理时使用的后端,可选项包括:
“None”: 按顺序执行循环,简单的列表推导式
“loky”、“multiprocessing”和“threading”: 使用
joblib.Parallel
“joblib”: 自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要在环境中安装dask
包“ray”: 使用
ray
,需要在环境中安装ray
包
- backend:parallel:params字典,可选,默认为 {}(不传入参数)
作为配置传递给并行后端的附加参数。有效键取决于
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”;要使用的日志记录器名称。
- “shutdown_ray”: 布尔值,默认为 True;False 防止
“mute_warnings”: 布尔值,默认为 False;如果为 True,则抑制警告
“mute_warnings”: bool, 默认为 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)[源码]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及复合对象。对于复合对象,即包含其他对象的对象,可以使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果这使得引用无歧义,例如,组件中没有两个参数具有相同的名称<parameter>
,则也可以使用字符串<parameter>
,不带<component>__
。- 参数:
- **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
将它们设置为通过sample_dependent_seed
从random_state
派生的整数。这些整数是通过链式哈希采样的,保证了种子随机生成器的伪随机独立性。应用于
self
中的random_state
参数,取决于self_policy
,以及剩余组件对象,当且仅当deep=True
时。注意:即使
self
没有random_state
参数,或者没有任何组件具有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint(整数), RandomState 实例或 None, 默认值为 None
伪随机数生成器,用于控制随机整数的生成。传入整数可实现在多次函数调用中获得可重现的输出。
- deep布尔值,默认为 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对自身的引用
- 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
(实例,时间)的pd.DataFrame
,3Dnp.ndarray
(实例,变量,时间),或 Series 类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。可以是具有 3 级或更多级行MultiIndex
(hierarchy_1, …, hierarchy_n, 时间)的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于变换的标签。某些变换器需要此数据,详情请参阅类文档字符串。
- 返回:
- X 的变换后版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
转换
X
-输出
返回类型
时间序列
原语
pd.DataFrame
(1 行)面板数据
原语
pd.DataFrame
时间序列
时间序列
时间序列
面板数据
时间序列
面板数据
时间序列
面板数据
面板数据
- 返回值的实例对应于 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。
- 所需状态
需要状态为“fitted”。
在 self 中访问
以“_”结尾的已拟合模型属性。
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 = 时间序列集合。可以是具有 2 级行MultiIndex
(实例,时间)的pd.DataFrame
,3Dnp.ndarray
(实例,变量,时间),或 Series 类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。可以是具有 3 级或更多级行MultiIndex
(hierarchy_1, …, hierarchy_n, 时间)的pd.DataFrame
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
额外数据,例如用于变换的标签。某些变换器需要此数据,详情请参阅类文档字符串。
- 返回:
- self估计器的已拟合实例
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_set字符串,默认为“default”
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,则将返回
"default"
集。当前对于转换器没有保留值。
- 返回:
- paramsdict(字典) 或 dict 列表, 默认值为 {}
用于创建类的测试实例的参数。每个字典都是构造一个“有趣的”测试实例的参数,例如,
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一的)字典。