ReverseAugmenter#

class ReverseAugmenter[source]#

反转时间序列的增强器。

如果 transform 给定时间序列 \(X={x_1, x_2, ... , x_n}\),则返回 \(X_t={x_n, x_{n-1}, ..., x_2, x_1}\)。例如,[1]讨论了通过反转进行时间序列增强。

属性:
is_fitted

是否已调用 fit

示例

>>> import pandas as pd
>>> from sktime.transformations.series.augmenter import ReverseAugmenter
>>> X = pd.Series([1,2,3,4,5])
>>> augmenter = ReverseAugmenter()
>>> Xt = augmenter.fit_transform(X)
>>> Xt
0    5
1    4
2    3
3    2
4    1
dtype: int64

参考文献和脚注#

[1]: IWANA, Brian Kenji; UCHIDA, Seiichi. An empirical survey of data augmentation for time series classification with neural networks. Plos one, 2021, 16. Jg., Nr. 7, S. e0254841.

方法

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

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

逆变换 X 并返回逆变换后的版本。

is_composite()

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

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)[source]#

检查估计器是否已拟合。

检查评估器是否包含 _is_fitted 属性且其值为 Trueis_fitted 属性应在调用对象的 fit 方法时设置为 True

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

Raises:
NotFittedError

如果评估器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用的不同对象,处于初始化后状态。此函数等同于返回 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

Raises:
如果克隆不符合要求(由于 __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_tagsget_tag 查看。

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

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

Returns:
self

self 的引用。

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

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

参数:
parameter_setstr, 默认值="default"

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

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

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

参数:
parameter_setstr, 默认值="default"

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

Returns:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表,与 objs 长度相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为 {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), list 包含 Series 类型的 pd.DataFrame

  • 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 中传递,不是可选的。有关所需格式,请参见类文档字符串了解详情。

Returns:
self已拟合的评估器实例
fit_transform(X, y=None)[source]#

拟合数据,然后转换它。

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

状态改变

将状态更改为“已拟合”。

写入 self: _is_fitted : 标志设置为 True。 _X : X 的强制副本,如果 remember_data 标签为 True

如果可能,通过引用强制转换为内部类型或 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), list 包含 Series 类型的 pd.DataFrame

  • 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 中传递,不是可选的。有关所需格式,请参见类文档字符串了解详情。

Returns:
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 中的实例
表中未包含的组合目前不支持
明确说明,举例
  • 如果 XSeries(例如,pd.DataFrame

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

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

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

  • 如果 XSeriesPaneltransform-output

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

  • 如果 XSeriestransform-outputPanel

则返回是 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_tagsclone_tags 设置的实例动态标签覆盖。

要检索可能包含实例覆盖的标签值,请改用 get_tag 方法。

参数:
tag_namestr

标签值名称。

tag_value_default任何类型

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

Returns:
tag_value

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

classmethod get_class_tags()[source]#

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

每个 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()[source]#

获取对象的配置标志。

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

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

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

配置在 clonereset 调用下保留。

Returns:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, 默认值=True

是否返回组件的拟合参数。

  • 如果为 True,将返回此对象的参数名称:值的字典,包括可拟合组件(= BaseEstimator 类型的参数)的拟合参数。

  • 如果为 False,将返回此对象的参数名称:值的字典,但不包括组件的拟合参数。

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

获取对象的默认参数。

Returns:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool, 默认值=True

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

Returns:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, 默认值=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称:值的 dict,包括组件(= BaseObject 类型的参数)的参数。

  • 如果为 False,将返回此对象的参数名称:值的 dict,但不包括组件的参数。

Returns:
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_tagsclone_tags 设置的标签,

在实例构造时。

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

tag_value_default任何类型, 可选; 默认值=None

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

raise_errorbool

未找到标签时是否引发 ValueError

Returns:
tag_valueAny

selftag_name 标签的值。如果未找到,并且 raise_error 为 True,则引发错误;否则返回 tag_value_default

Raises:
ValueError,如果 raise_errorTrue

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

get_tags()[source]#

从实例获取标签,并进行标签级别的继承和覆盖。

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

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

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

值是相应的标签值,按优先级降序排列如下:

  1. 在实例上通过 set_tagsclone_tags 设置的标签,

在实例构造时。

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

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

按继承顺序排列。

Returns:
collected_tagsdict

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

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

返回 skbase 对象的测试参数设置。

get_test_params 是用于存储测试参数设置的统一接口。此函数也用于 create_test_instancecreate_test_instances_and_names 来构造测试实例。

get_test_params 应该返回一个单个 dict,或一个 dict 列表。

每个 dict 都是用于测试的参数配置,可用于构造一个“有趣的”测试实例。cls(**params) 调用对于 get_test_params 返回中的所有字典 params 都应该是有效的。

get_test_params 不必返回固定列表的字典,它也可以返回动态或随机的参数设置。

参数:
parameter_setstr, 默认值="default"

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

Returns:
paramsdict 或 list of dict, 默认值 = {}

用于创建类测试实例的参数。每个 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), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

y可选,sktime 兼容数据格式的数据,默认值=None

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

Returns:
X 的逆变换版本

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

is_composite()[source]#

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

复合对象是指参数中包含其他对象的对象。此方法在实例上调用,因为不同实例可能有所不同。

Returns:
composite: bool

对象的任何参数值是否是 BaseObject 的派生类实例。

property is_fitted[source]#

是否已调用 fit

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

Returns:
bool

评估器是否已 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open("object) 的结果
Returns:
path 处由 cls.save(path) 输出的、反序列化后的 self
classmethod load_from_serial(serial)[source]#

从序列化内存容器加载对象。

参数:
serialcls.save(None) 输出的第一个元素
Returns:
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))`` 获得的对象相同。

Returns:
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",则会在当前工作目录创建 zip 文件 estimator.zip

  • path="/home/stored/estimator",则会在 /home/stored/ 存储 zip 文件 estimator.zip

存储在 /home/stored/

serialization_format: str, 默认值 = “pickle”

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

Returns:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr, “diagram”(默认)或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

打印 self 时是否只列出与默认值不同的 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”:布尔值,默认值为 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

Returns:
self对自身的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。对于复合对象(即包含其他对象的对象),可以使用参数键字符串 `__` 来访问组件 `` 中的 ``。如果这种引用是明确的(例如,没有两个组件参数同名 ``),也可以使用不带 `__` 的字符串 ``。

参数:
**paramsdict

BaseObject 参数,键必须是 `__` 字符串。如果 `__` 后缀在 get_params 键中唯一,则可以作为完整字符串的别名。

Returns:
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_state整数、RandomState 实例或 None,默认值为 None

伪随机数生成器,用于控制随机整数的生成。传递整数以实现跨多个函数调用的可重现输出。

deepbool, 默认值=True

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

  • 如果为 False,则仅设置 `self` 的 `random_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` 派生,通常与它不同

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

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

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

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

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

`set_tags` 方法应仅在对象的 `__init__` 方法中、构建期间或通过 `__init__` 直接在构建后调用。

当前的标签值可以通过 get_tagsget_tag 查看。

参数:
**tag_dictdict

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

Returns:
自身

对自身的引用。

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), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

y可选,sktime 兼容数据格式的数据,默认值=None

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

Returns:
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 实例)。示例:面板中的所有序列都单独进行去趋势

  • 如果 XSeriesPaneltransform-output

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

  • 如果 XSeriestransform-outputPanel

则返回是 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), list 包含 Series 类型的 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

y可选,sktime 兼容数据格式的数据,默认值=None

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

Returns:
self已拟合的评估器实例