MovingBlockBootstrapTransformer#

class MovingBlockBootstrapTransformer(n_series: int = 10, block_length: int = 10, sampling_replacement: bool = False, return_actual: bool = True, random_state: int | RandomState = None)[source]#

用于生成合成时间序列的移动块自举 (MBB) 方法。

[1] 中介绍的移动块自举 (MBB) 方法可用于创建模仿观察到的平稳时间序列的自相关模式的合成时间序列。此方法常与其他变换(例如 BoxCox 和 STL)结合使用,以生成与观察到的时间序列相似的合成时间序列 [2]、[3]。

返回的面板将是一个多索引 DataFrame (pd.DataFrame),其中 series_id 和 time_index 作为索引,时间序列值作为单列。series_id 的值为原始序列的“actual”和生成序列的“synthetic_n”(其中 n 是一个整数)。有关示例输出,请参见示例部分。

参数:
n_seriesint, 可选

将生成的自举时间序列的数量,默认为 10

block_lengthint, 可选

MBB 方法中块的长度,默认为 None。如果未提供,将使用以下启发式方法:块长度将是 2*sp 和 len(X) - sp 之间的最小值。

sampling_replacementbool, 可选

MBB 样本是否进行有放回或无放回抽样,默认为 False。

return_actualbool, 可选

如果为 True,则输出将包含实际时间序列,默认为 True。实际时间序列将标记为“actual”。

random_stateint, np.random.RandomState 或 None, 默认为 None

控制估计器的随机性

属性:
is_fitted

fit 是否已被调用。

另请参见

sktime.transformations.bootstrap.STLBootstrapTransformer

利用 BoxCox、STL 和移动块自举创建相似时间序列面板的变换器。

参考文献

[1]

Kunsch HR (1989) The jackknife and the bootstrap for general stationary observations. Annals of Statistics 17(3), 1217-1241

[2]

Bergmeir, C., Hyndman, R. J., & Benítez, J. M. (2016). Bagging exponential smoothing methods using STL decomposition and Box-Cox transformation. International Journal of Forecasting, 32(2), 303-312

[3]

Hyndman, R.J., & Athanasopoulos, G. (2021) Forecasting: principles and practice, 3rd edition, OTexts: Melbourne, Australia. OTexts.com/fpp3, Chapter 12.5. Accessed on February 13th 2022. Accessed on February 13th 2022.

示例

>>> from sktime.transformations.bootstrap import MovingBlockBootstrapTransformer
>>> from sktime.datasets import load_airline
>>> from sktime.utils.plotting import plot_series  
>>> y = load_airline()
>>> transformer = MovingBlockBootstrapTransformer(10)
>>> y_hat = transformer.fit_transform(y)
>>> series_list = []
>>> names = []
>>> for group, series in y_hat.groupby(level=[0], as_index=False):
...     series.index = series.index.droplevel(0)
...     series_list.append(series)
...     names.append(group)
>>> plot_series(*series_list, labels=names)  
(...)
>>> print(y_hat.head()) 
                      Number of airline passengers
series_id time_index
actual    1949-01                            112.0
          1949-02                            118.0
          1949-03                            132.0
          1949-04                            129.0
          1949-05                            121.0

方法

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

获取 self 的配置标志。

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

将序列化的 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 或 list of dict, 默认为 {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 Trueis_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 兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。

clone_tags 设置来自另一个对象,estimator 的动态标签覆盖。

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

动态标签设置为 estimator 中标签的值,使用 tag_names 中指定的名称。

tag_names 的默认设置是将 estimator 中的所有标签写入 self

当前标签值可通过 get_tagsget_tag 进行检查。

estimatorBaseObject 或其派生类的实例

参数:
tag_namesstr 或 list of str, 默认为 None
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

返回:
self 的引用。

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

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

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

参数:
parameter_setstr, 默认为“default”

instance具有默认参数的类实例

返回:
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例列表

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

参数:
parameter_setstr, 默认为“default”

instance具有默认参数的类实例

返回:
第 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。

将状态更改为“fitted”。

写入 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.DataFramepd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame,3D np.ndarray (instance, variable, time),Series 类型的 pd.DataFrame 列表

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

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

y可选,符合 sktime 兼容数据格式的数据,默认为 None

额外数据,例如用于变换的标签 如果 self.get_tag("requires_y")True,则必须在 fit 中传入,不是可选的。有关所需格式,请参见类文档字符串了解详细信息。

self估计器的已拟合实例

返回:
fit_transform(X, y=None)[source]#
将变换器拟合到 X 和 y 并返回 X 的变换版本。

拟合数据,然后进行变换。

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

将状态更改为“fitted”。

写入 self

如果可能,通过引用强制转换为内部类型或 update_data 兼容类型

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

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

参数:
用于拟合变换的数据。

X 的变换版本

Series scitype = 个体时间序列。pd.DataFramepd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame,3D np.ndarray (instance, variable, time),Series 类型的 pd.DataFrame 列表

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

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

y可选,符合 sktime 兼容数据格式的数据,默认为 None

额外数据,例如用于变换的标签 如果 self.get_tag("requires_y")True,则必须在 fit 中传入,不是可选的。有关所需格式,请参见类文档字符串了解详细信息。

self估计器的已拟合实例

返回:
类型取决于 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 实例)。示例:面板中的所有序列都单独进行去趋势处理

如果 XSeriesPanel 并且 transform-output

  • Primitives,则返回一个 pd.DataFrame,其行数与 X 中的实例数相同。示例:返回的第 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 的标签值,考虑标签覆盖,优先级按降序排列:

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

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

  2. 按继承顺序排列。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

要检索具有潜在实例覆盖的标签值,请改用 get_tag 方法。

tag_namestr

参数:
标签值的名称。

tag_value_defaultany type

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

tag_value

返回:
self 中 tag_name 标签的值。如果未找到,返回 tag_value_default

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签值。

从类中获取类标签,具有从父类继承的标签级别。

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

clone_tags 设置来自另一个对象,estimator 的动态标签覆盖。

它返回一个字典,其键是类或其任何父类中设置的 _tags 的任何属性的键。

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

实例可以根据超参数覆盖这些标签。

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

  2. 按继承顺序排列。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

要检索具有潜在实例覆盖的标签,请改用 get_tags 方法。

要包含动态标签的覆盖,请使用 get_tags

要检索具有潜在实例覆盖的标签值,请改用 get_tag 方法。

collected_tagsdict

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

get_config()[source]#

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

获取 self 的配置标志。

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

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

配置在 clonereset 调用中保留。

config_dictdict

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

get_fitted_params(deep=True)[source]#

所需状态

获取已拟合参数。

需要状态为“fitted”。

deepbool, 默认为 True

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

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

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

  • 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]#

获取对象的参数默认值。

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

是否返回组件的参数。

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

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

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

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

  • 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]#

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

从实例中获取标签值,具有标签级别继承和覆盖。

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

clone_tags 设置来自另一个对象,estimator 的动态标签覆盖。

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

  1. 在实例构造时设置。

要检索的标签名称

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

  2. 按继承顺序排列。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

参数:
标签值的名称。

tag_value_defaultany type, 可选;默认为 None

如果未找到标签,则使用默认/备用值

raise_errorbool

未找到标签时是否引发 ValueError

tag_valueAny

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

ValueError,如果 raise_errorTrue

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

get_tags()[source]#

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

从实例中获取标签,具有标签级别继承和覆盖。

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

clone_tags 设置来自另一个对象,estimator 的动态标签覆盖。

collected_tagsdict

实例可以根据超参数覆盖这些标签。

  1. 在实例构造时设置。

要检索的标签名称

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

  2. 按继承顺序排列。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

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

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

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

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

“scitype:transform-input”=”Series”,”scitype:transform-output”=”Series”,

具有 inverse_transform 方法。

访问 self 中的属性

需要状态为“fitted”。

deepbool, 默认为 True

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

  • self.is_fitted,必须为 True

  • 额外数据,例如用于变换的标签。某些变换器需要此项,请参见类文档字符串了解详细信息。

参数:
用于拟合变换的数据。

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

Series scitype = 个体时间序列。pd.DataFramepd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame,3D np.ndarray (instance, variable, time),Series 类型的 pd.DataFrame 列表

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

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

y可选,符合 sktime 兼容数据格式的数据,默认为 None

额外数据,例如用于变换的标签 如果 self.get_tag("requires_y")True,则必须在 fit 中传入,不是可选的。有关所需格式,请参见类文档字符串了解详细信息。

X 的逆变换版本

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

is_composite()[source]#

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

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

composite: bool

返回:
对象是否有任何参数的值是 BaseObject 的派生实例。

property is_fitted[source]#

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

fit 是否已被调用。

bool

返回:
估计器是否已 fit

classmethod load_from_path(serial)[source]#

serialZipFile(path).open(“object”) 的结果

从文件位置加载对象。

参数:
反序列化 self 产生 path 处的输出,即 cls.save(path) 的输出
返回:
classmethod load_from_serial(serial)[source]#
serialcls.save(None) 输出的第一个元素

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

参数:
反序列化 self 产生 serial 输出,即 cls.save(None) 的输出
返回:
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]#

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

将序列化的 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。

  • stored in /home/stored/.

serialization_format: str, 默认为“pickle”

serialization_format: str, 默认值 = “pickle”

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

返回:
如果 path 为 None - 将 self 序列化到内存中
如果 path 是文件位置 - ZipFile,并引用该文件
set_config(**config_dict)[源]#

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

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

配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

控制打印 self 时是仅列出与默认值不同的参数(True)还是列出所有参数名称和值(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 在并行化后关闭。

      并行化后停止。

    • “logger_name”: str, 默认值=”ray”; 要使用的 logger 名称。

    • “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)[源]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回:
self对 self 的引用(参数设置后)
set_random_state(random_state=None, deep=True, self_policy='copy')[源]#

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

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

是否在 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对 self 的引用
set_tags(**tag_dict)[源]#

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

get_class_tag 方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签值。

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

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

应仅在对象的 __init__ 方法中调用 set_tags 方法,即在构造期间或通过 __init__ 构造后直接调用。

estimatorBaseObject 或其派生类的实例

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。

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

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

需要状态为“fitted”。

deepbool, 默认为 True

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

  • self.is_fitted,必须为 True

  • 额外数据,例如用于变换的标签。某些变换器需要此项,请参见类文档字符串了解详细信息。

参数:
用于拟合变换的数据。

要转换的数据。

Series scitype = 个体时间序列。pd.DataFramepd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame,3D np.ndarray (instance, variable, time),Series 类型的 pd.DataFrame 列表

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

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

y可选,符合 sktime 兼容数据格式的数据,默认为 None

额外数据,例如用于变换的标签 如果 self.get_tag("requires_y")True,则必须在 fit 中传入,不是可选的。有关所需格式,请参见类文档字符串了解详细信息。

X 的逆变换版本

返回:
类型取决于 X 的类型和 scitype:transform-output 标签
X | tf-output | 返回类型 |

transform

X

- 输出

返回类型

Series

Primitives

pd.DataFrame (1 行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel

表中未列出的组合目前不支持
具体说明,并附示例
如果 XSeries(例如,pd.DataFrame
  • 并且 transform-outputSeries,则返回相同 mtype 的单个 Series。示例:对单个序列进行去趋势处理

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

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

如果 XSeriesPanel 并且 transform-output

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

如果 XSeries 并且 transform-outputPanel

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

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

需要状态为“fitted”。

deepbool, 默认为 True

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

  • self.is_fitted,必须为 True

  • 额外数据,例如用于变换的标签。某些变换器需要此项,请参见类文档字符串了解详细信息。

设置以“_”结尾的拟合模型属性,拟合属性可通过 get_fitted_params 检查。

  • self.is_fitted,必须为 True

  • 如果 remember_data 标签为 True,则通过 update_data 将更新后的 X 中的值写入 self._X

参数:
用于拟合变换的数据。

用于更新转换的数据

Series scitype = 个体时间序列。pd.DataFramepd.Seriesnp.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame,3D np.ndarray (instance, variable, time),Series 类型的 pd.DataFrame 列表

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

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

y可选,符合 sktime 兼容数据格式的数据,默认为 None

额外数据,例如用于变换的标签 如果 self.get_tag("requires_y")True,则必须在 fit 中传入,不是可选的。有关所需格式,请参见类文档字符串了解详细信息。

X 的逆变换版本

返回:
fit_transform(X, y=None)[source]#