PAA#
- class PAA(frames=8, frame_size=0)[source]#
分段聚合近似变换器 (PAA)。
PAA [1] 是一种降维技术,它将时间序列分成帧并计算它们的平均值。此实现提供了两种变体:
1) 原始变体,它接收所需的帧数,并且可以将帧大小设置为一个分数,以支持时间序列无法被等量分帧的情况。2) 另一种变体,它接收所需的帧大小,并且可以减小最后一帧的帧大小,以支持时间序列不能被均匀分帧的情况。
- 参数:
- framesint,可选 (默认=8,如果 frame_size=0 则大于等于 1)
变换后的时间序列长度。如果设置了
frame_size则忽略此项。- frame_sizeint,可选 (默认=0,大于等于 0)
计算平均值的帧的长度。如果大于 0,则覆盖
frames。
- 属性:
is_fitted是否已调用
fit。
参考文献
[1]Keogh, E., Chakrabarti, K., Pazzani, M., and Mehrotra, S. Dimensionality Reduction for Fast Similarity Search in Large Time Series Databases. Knowledge and Information Systems 3, 263-286 (2001). https://doi.org/10.1007/PL00011669
示例
>>> from numpy import arange >>> from sktime.transformations.series.paa import PAA
>>> X = arange(10) >>> paa = PAA(frames=3) >>> paa.fit_transform(X) array([1.2, 4.5, 7.8]) >>> paa = PAA(frame_size=3) array([1, 4, 7, 9])
方法
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])返回评估器的测试参数设置。
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。
- 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)的新实例,使用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 列表,默认 = 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 个元素是测试中 objs 第 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。Seriesscitype = 单个时间序列。pd.DataFrame,pd.Series, 或np.ndarray(1D 或 2D)Panelscitype = 时间序列集合。pd.DataFrame带有 2 级行MultiIndex(实例, 时间),3D np.ndarray(实例, 变量, 时间),list类型的Seriespd.DataFrameHierarchicalscitype = 分层时间序列集合。pd.DataFrame带有 3 级或更多级行MultiIndex(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参阅 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,X 的强制副本,如果 remember_data 标签为 True
如果可能,通过引用强制转换为内部类型或 update_data 兼容类型
模型属性(以“_”结尾):取决于评估器
- 参数:
- X符合
sktime数据容器格式的时间序列 用于拟合变换的数据,以及要变换的数据。
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 都实现了一个抽象的 scitype。Seriesscitype = 单个时间序列。pd.DataFrame,pd.Series, 或np.ndarray(1D 或 2D)Panelscitype = 时间序列集合。pd.DataFrame带有 2 级行MultiIndex(实例, 时间),3D np.ndarray(实例, 变量, 时间),list类型的Seriespd.DataFrameHierarchicalscitype = 分层时间序列集合。pd.DataFrame带有 3 级或更多级行MultiIndex(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参阅 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 行) | | 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的标签值,考虑标签覆盖,优先级降序如下:在类的
_tags属性中设置的标签。在父类的
_tags属性中设置的标签,
按继承顺序。
不考虑通过
set_tags或clone_tags在实例上设置的动态标签覆盖。要检索可能包含实例覆盖的标签值,请改用
get_tag方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_default任意类型
如果未找到标签,则为默认/备用值。
- 返回:
- tag_value
tag_name标签在self中的值。如果未找到,则返回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 的 dict
已拟合参数字典,paramname : paramvalue 键值对包括
总是:此对象的所有已拟合参数,如通过 get_param_names 获取的,值是此对象该键的已拟合参数值
如果 deep=True,还包含组件参数的键/值对,组件参数的索引格式为 [组件名称]__[参数名称],componentname 的所有参数都以 paramname 及其值的形式出现
如果 deep=True,还包含任意级别的组件递归,例如 [组件名称]__[子组件名称]__[参数名称] 等
- 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及其值的形式出现如果
deep=True,还包含任意级别的组件递归,例如[组件名称]__[子组件名称]__[参数名称]等
- 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
tag_name标签在self中的值。如果未找到,则在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对象属性收集任何覆盖和新标签。
- 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。Seriesscitype = 单个时间序列。pd.DataFrame,pd.Series, 或np.ndarray(1D 或 2D)Panelscitype = 时间序列集合。pd.DataFrame带有 2 级行MultiIndex(实例, 时间),3D np.ndarray(实例, 变量, 时间),list类型的Seriespd.DataFrameHierarchicalscitype = 分层时间序列集合。pd.DataFrame带有 3 级或更多级行MultiIndex(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参阅 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调用会删除所有对象属性,除了超参数 = 写入
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]#
将序列化的 self 保存到类字节对象或 (.zip) 文件。
行为:如果
path为 None,则返回一个内存中的序列化自身;如果path是文件位置,则将自身作为 zip 文件存储在该位置。保存的文件是 zip 文件,包含以下内容: _metadata - 包含自身的类,即 type(self);_obj - 序列化的自身。此类使用默认的序列化方式 (pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则自身保存为内存对象;如果为文件位置,则自身保存到该文件位置。如果
path=”estimator” 则会在当前工作目录 (cwd) 中创建一个 zip 文件
estimator.zip。path=”/home/stored/estimator” 则会创建一个 zip 文件
estimator.zip并
存储在
/home/stored/中。- serialization_format: str, 默认 = “pickle”
用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path为 None - 内存中的序列化自身 - 如果
path是文件位置 - 引用该文件的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示自身实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
打印自身时是否仅列出自参数与默认值不同的参数 (False),或列出所有参数名称和值 (False)。不嵌套,即仅影响自身,不影响组件估计器。
- 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在 并行处理后关闭。
- “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对自身的引用。
备注
改变对象状态,将 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]#
为 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对自身的引用
- 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 并返回变换后的版本。
- 所需状态
要求状态为“已拟合”。
访问 self 中的属性
以“_”结尾的已拟合模型属性。
self.is_fitted,必须为 True
- 参数:
- X符合
sktime数据容器格式的时间序列 要转换的数据。
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 都实现了一个抽象的 scitype。Seriesscitype = 单个时间序列。pd.DataFrame,pd.Series, 或np.ndarray(1D 或 2D)Panelscitype = 时间序列集合。pd.DataFrame带有 2 级行MultiIndex(实例, 时间),3D np.ndarray(实例, 变量, 时间),list类型的Seriespd.DataFrameHierarchicalscitype = 分层时间序列集合。pd.DataFrame带有 3 级或更多级行MultiIndex(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb- y可选,sktime 兼容数据格式的数据,默认=None
附加数据,例如用于变换的标签。一些变换器需要此参数,详细信息请参阅类文档字符串。
- X符合
- 返回:
- 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,则返回的 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 中的属性
以“_”结尾的已拟合模型属性。
self.is_fitted,必须为 True
写入 self
以“_”结尾的已拟合模型属性。
如果
remember_data标签为 True,则通过update_data将值写入self._X,由X中的值更新。
- 参数:
- X符合
sktime数据容器格式的时间序列 用于更新转换的数据
sktime中的单个数据格式是所谓的 mtype 规范,每个 mtype 都实现了一个抽象的 scitype。Seriesscitype = 单个时间序列。pd.DataFrame,pd.Series, 或np.ndarray(1D 或 2D)Panelscitype = 时间序列集合。pd.DataFrame带有 2 级行MultiIndex(实例, 时间),3D np.ndarray(实例, 变量, 时间),list类型的Seriespd.DataFrameHierarchicalscitype = 分层时间序列集合。pd.DataFrame带有 3 级或更多级行MultiIndex(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb- y可选,sktime 兼容数据格式的数据,默认=None
附加数据,例如用于变换的标签。一些变换器需要此参数,详细信息请参阅类文档字符串。
- X符合
- 返回:
- self评估器的已拟合实例