SplitterBootstrapTransformer#

class SplitterBootstrapTransformer(splitter=None, fold='train', shuffle=False, subsample=None, replace=True, random_state=None)[source]#

基于拆分器的 Bootstrapping 方法,用于生成合成时间序列。

一种基于 sktime 拆分器的通用 Bootstrapping 形式。

任何 sktime 拆分器都可以作为组件传递给此变换器,该变换器将为 transform 输入中的每个时间序列生成一个包含训练和/或测试子序列的时间序列面板。

transform 的输出将包含额外的层级

  • transform 输入的所有层级

  • 一个额外的整数索引顶层,指示样本编号 注意:这通常是样本的编号,仅在确定性、穷举性情况下才对应于折叠的编号

  • 如果 split="train"split="test",则没有更多层级

  • 如果 split="both",第二个顶层包含字符串 "train"

"test"

以指示拆分中的训练或测试折叠

例如,如果 split="train",并且存在单个原始序列 X,则 transform 的输出将具有一个顶层(级别 0),其整数索引范围从 0 到 splitter.get_n_splits(X)-1

拆分器可以是穷举性、确定性的,也可以是随机的。默认情况下,返回穷举性的有序样本(确定性)。随机性由以下参数控制

  • shuffle(默认关闭)对实例应用随机均匀洗牌

  • subsample(默认关闭)应用有放回或无放回的子抽样

  • replace(默认为 False)选择有放回或无放回的子抽样

放回

注意:仅当 shuffle=Falsesubsample=None 时(除非巧合),transform 输出的实例索引才对应于拆分索引

参数:
splitter可选,sktime 拆分器,BaseSplitter 的后代

默认值 = SlidingWindowSplitter(window_length=3, step_length=1) 用于 bootstrap 拆分的拆分器。

fold字符串,可选值为“train”(默认)、“test”和“both”

确定面板中作为新实例返回哪个折叠。“train” - 训练折叠;“test” - 测试折叠;“both” - 训练和测试折叠都包含,并且存在一个额外的字符串层级,可能的值为 "train""test"

shuffle布尔值,默认=False

返回前是否对折叠顺序进行随机均匀洗牌;如果不是,则按拆分器定义的顺序返回折叠

subsample可选,整数或浮点数,默认值 = None

如果提供,则对返回的折叠进行随机均匀子抽样 int = 返回该大小的子样本(如果小于,则返回完整样本) float,必须在 0 和 1 之间 = 返回该比例的子样本 注意:整数 1 选择一个序列;浮点数 1 选择 splitter 中的多个序列

replace布尔值,默认=True;仅当 subsample=True 时使用

如果提供了 subsample,抽样是有放回还是无放回 True = 有放回,False = 无放回

random_state整数,np.random.RandomState 或 None(默认)

评估器的随机种子 如果 None,则使用 numpy 环境的随机种子 如果是 int,则作为种子传递给 numpy RandomState 如果是 RandomState,则用作随机生成器

属性:
is_fitted

是否已调用 fit 方法。

另请参阅

sktime.transformations.bootstrap.MovingBlockBootstrapTransformer

逻辑与滑动窗口拆分器相似,使用 bootstrap 随机窗口。

示例

>>> from sktime.transformations.bootstrap import SplitterBootstrapTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = SplitterBootstrapTransformer(fold="both")
>>> y_hat = transformer.fit_transform(y)

方法

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

返回评估器的测试参数设置。

inverse_transform(X[, y])

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

is_composite()

检查对象是否由其他 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 可选。

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

返回评估器的测试参数设置。

参数:
parameter_set字符串,默认值=”default”

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

返回:
params字典或字典列表,默认值 = {}

用于创建类测试实例的参数 每个字典都是构造“有趣”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

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

如果未拟合,则引发 NotFittedError

参数:
method_name字符串,可选

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

引发:
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

引发:
如果由于错误的 __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_names字符串或字符串列表,默认值 = None

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

返回:
self

self 的引用。

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

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

参数:
parameter_set字符串,默认值=”default”

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

返回:
instance使用默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

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

用 X 拟合变换器,y 可选。

状态变更

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

写入自身

  • 设置以“_”结尾的已拟合模型属性,已拟合属性可通过 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.Seriesnp.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 中传递,不是可选的。所需格式的详细信息请参见类 docstring。

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

拟合数据,然后变换它。

用 X 和 y 拟合变换器并返回 X 的变换版本。

状态变更

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

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

如果可能,可能被强制转换为内部类型或 update_data 兼容类型(按引用)

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

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

用于拟合变换的数据,以及要变换的数据。

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.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 中传递,不是可选的。所需格式的详细信息请参见类 docstring。

返回:
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,则返回一个行数与 X 中实例数相同的 pd.DataFrame 示例:返回的第 i 行包含第 i 个序列的均值和方差

  • 如果 XSeries 并且 transform-outputPanel

则返回类型为 pd-multiindexPanel 对象。示例:输出的第 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_name字符串

标签值的名称。

tag_value_default任意类型

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

返回:
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_tags字典

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

get_config()[source]#

获取自身的配置标志。

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

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

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

配置在 clonereset 调用下保留。

返回:
config_dict字典

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

需要状态为“已拟合”。

参数:
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()[source]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sort布尔值,默认=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deep布尔值,默认=True

是否返回组件的参数。

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

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

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

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

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,并考虑标签覆盖,优先级降序如下

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

在实例构造时设置。

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

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

按继承顺序。

参数:
tag_name字符串

要检索的标签名称

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

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

raise_error布尔值

未找到标签时是否引发 ValueError

返回:
tag_value任意类型

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

引发:
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 属性中设置的标签,

按继承顺序。

返回:
collected_tags字典

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

inverse_transform(X, y=None)[source]#

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

目前假定只有带有以下标签的变换器

"scitype:transform-input"="Series", "scitype:transform-output"="Series",

具有 inverse_transform 方法。

所需状态

需要状态为“已拟合”。

访问自身中的属性

  • 以“_”结尾的已拟合模型属性。

  • self.is_fitted,必须为 True

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

用于拟合变换的数据。

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.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

附加数据,例如用于变换的标签。某些变换器需要此数据,详细信息请参见类 docstring。

返回:
X 的逆向变换版本

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

is_composite()[source]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已调用 fit 方法。

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

返回:
布尔值

评估器是否已经过 fit

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化后的自身,产生 cls.save(path)path 处的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化后的自身,产生 cls.save(None) 的输出 serial
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]#

将序列化的自身保存到字节类对象或到 (.zip) 文件。

行为:如果 path 为 None,则返回内存中的序列化自身;如果 path 为文件位置,则将自身以 zip 文件形式存储在该位置

保存的文件是包含以下内容的 zip 文件: _metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认的序列化(pickle)。

参数:
pathNone 或文件位置(str 或 Path)

如果为 None,则将自身保存到内存对象;如果是文件位置,则将自身保存到该文件位置。如果

  • path=”estimator” 则会在当前工作目录创建一个 zip 文件 estimator.zip

  • path=”/home/stored/estimator” 则会在 /home/stored/ 中存储一个 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: 字符串,默认值 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化自身
如果 path 是文件位置 - ZipFile,包含对文件的引用
set_config(**config_dict)[source]#

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

参数:
config_dict字典

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

display字符串,“diagram”(默认)或“text”

jupyter kernel 如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值,默认=True

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

warnings字符串,“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 在并行化后

      关闭。

    • “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对自身的引用(设置参数后)
设置随机状态(随机状态=None, 深度=True, 自身策略='复制')[源代码]#

为自身设置 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 可在多次函数调用中获得可重现的输出。

deep布尔值,默认=True

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

  • 如果为 False,将仅设置 selfrandom_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_tagsget_tag 查看。

参数:
**tag_dictdict

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

返回:
自身

对自身的引用。

transform(X, y=None)[source]#

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

所需状态

需要状态为“已拟合”。

访问自身中的属性

  • 以“_”结尾的已拟合模型属性。

  • self.is_fitted,必须为 True

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

要转换的数据。

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.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

附加数据,例如用于变换的标签。某些变换器需要此数据,详细信息请参见类 docstring。

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

转换

X

-输出

返回类型

Series

原语

pd.DataFrame (1 行)

Panel

原语

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,则返回一个行数与 X 中实例数相同的 pd.DataFrame 示例:返回的第 i 行包含第 i 个序列的均值和方差

  • 如果 XSeries 并且 transform-outputPanel

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

update(X, y=None, update_params=True)[source]#

使用 X 更新变换器,y 可选。

所需状态

需要状态为“已拟合”。

访问自身中的属性

  • 以“_”结尾的已拟合模型属性。

  • self.is_fitted,必须为 True

写入自身

  • 以“_”结尾的已拟合模型属性。

  • 如果 remember_data 标签为 True,则通过 update_data 将数据写入 self._X,并用 X 中的值进行更新。

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

用于更新转换的数据

sktime 中的单个数据格式称为 mtype 规范,每个 mtype 实现一个抽象的 scitype

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Seriesnp.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

附加数据,例如用于变换的标签。某些变换器需要此数据,详细信息请参见类 docstring。

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