BKFilter#

class BKFilter(low=6, high=32, K=12)[source]#

使用 Baxter-King 滤波器过滤时间序列。

这是 `statsmodels` 库中 `bkfilter 函数的封装器。(参见 `statsmodels.tsa.filters.bk_filter.bkfilter`)。

Baxter-King 滤波器专用于经济和计量经济学时间序列数据，用于处理商业周期的周期性。将带通滤波器应用于序列将生成一个新序列，该序列不包含高于或低于商业周期频率的波动。Baxter-King 沿袭了 Burns 和 Mitchell 关于商业周期的研究，该研究表明美国商业周期通常持续 1.5 到 8 年。

参数:
lowfloat

振荡的最小周期。Baxter 和 King 建议季度数据使用 6，年度数据使用 1.5。

highfloat

振荡的最大周期。BK 建议美国商业周期季度数据使用 32，年度数据使用 8。

Kint

滤波器的超前-滞后长度。Baxter 和 King 建议季度数据使用截断长度 12，年度数据使用 3。

属性:
is_fitted

是否已调用 `fit`。

注意

返回原始序列的中心加权移动平均值。

参考文献

Baxter, M. 和 R. G. King。“测量商业周期：经济时间序列的近似带通滤波器。”

Review of Economics and Statistics, 1999, 81(4), 575-593。

示例

>>> from sktime.transformations.series.bkfilter import BKFilter 
>>> import pandas as pd 
>>> import statsmodels.api as sm 
>>> dta = sm.datasets.macrodata.load_pandas().data 
>>> index = pd.date_range(start='1959Q1', end='2009Q4', freq='Q') 
>>> dta.set_index(index, inplace=True) 
>>> bk = BKFilter(6, 24, 12) 
>>> cycles = bk.fit_transform(X=dta[['realinv']])

方法

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

检查对象是否由其他 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, ...])

为自身设置随机状态伪随机种子参数。

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”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 `"default"` 集。目前转换器没有保留值。

返回:
paramsdict or list of dict, default = {}

用于创建类的测试实例的参数。每个 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, optional

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

引发:
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 或 list of str, default = None

要克隆的标签名称。默认值（`None`）克隆 `estimator` 中的所有标签。

返回:
self

指向 `self` 的引用。

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

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

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 `“default” 集。

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

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

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，则返回 `“default” 集。

返回:
objscls 实例列表

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

nameslist of str, 与 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")`。

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

用于拟合转换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • `Series scitype = 单个时间序列。`pd.DataFrame`、`pd.Series` 或 `np.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`。

yoptional, sktime 兼容数据格式的数据, default=None

附加数据，例如转换的标签。如果 `self.get_tag("requires_y")` 为 `True`，则必须在 `fit` 中传入，不可选。有关所需格式，请参见类文档字符串的详细信息。

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

拟合数据，然后转换。

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

状态改变

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

写入 self: _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` (`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`。

yoptional, sktime 兼容数据格式的数据, default=None

附加数据，例如转换的标签。如果 `self.get_tag("requires_y")` 为 `True`，则必须在 `fit` 中传入，不可选。有关所需格式，请参见类文档字符串的详细信息。

返回:
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`，则返回类型是与 `X` 具有相同实例数的 Panel（转换器应用于面板中的每个输入 Series 实例）。示例：面板中的所有序列都单独进行去趋势。

从类中获取类标签值，带有父类的标签级别继承。

如果 `X` 是 `Series` 或 `Panel` 并且 `transform-output` 是

`Primitives`，则返回类型是 `pd.DataFrame`，其行数与 `X` 中的实例数相同。示例：返回的第 i 行是第 i 个序列的均值和方差。

如果 `X` 是 `Series` 并且 `transform-output` 是 `Panel`，

  1. 则返回类型是 `pd-multiindex` 类型的 `Panel` 对象。示例：输出的第 i 个实例是在 `X` 上运行的第 i 个窗口。

  2. 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

标签值的名称。

从类中获取类标签，带有父类的标签级别继承。

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

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

tag_value_defaultany type

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

tag_value

  1. 则返回类型是 `pd-multiindex` 类型的 `Panel` 对象。示例：输出的第 i 个实例是在 `X` 上运行的第 i 个窗口。

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

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

在 `self` 中的 `tag_name` 标签的值。如果未找到，则返回 `tag_value_default`。

classmethod get_class_tags()[source]#

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

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

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

值是相应的标签值，覆盖按优先级降序排列如下：

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

获取自身的配置标志。

要检索包含潜在实例覆盖的标签，请改用 `get_tags` 方法。

要包含动态标签的覆盖，请使用 `get_tags`。

collected_tagsdict

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

返回:
get_config()[source]#

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

`get_config` 返回动态配置，它覆盖默认配置。

获取拟合参数。

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

配置在 `clone` 或 `reset` 调用时保留。

参数:
config_dictdict

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

  • get_fitted_params(deep=True)[source]#

  • 所需状态

返回:
需要状态为“已拟合”。

deepbool, default=True

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

  • 如果为 True，则将返回此对象的参数名 : 值字典，包括可拟合组件（= BaseEstimator 值的参数）的拟合参数。

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

fitted_paramsdict with str-valued keys

拟合参数的字典，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]#

获取对象的参数名称。

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

参数:
config_dictdict

sortbool, default=True

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

  • param_names: list[str]

返回:
cls` 的参数名称列表。如果 `sort=False`，则按它们在类的 `__init__` 中出现的顺序排列。如果 `sort=True`，则按字母顺序排列。

get_params(deep=True)[source]#

  • 是否返回组件的参数。

  • 如果为 `True`，则将返回此对象的参数名 : 值字典，包括组件（= `BaseObject` 值的参数）的参数。

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

paramsdict with str-valued keys

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

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

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

参数字典，paramname : paramvalue 键值对包含：

  1. 始终：此对象的所有参数，如通过 `get_param_names` 获得的，值为该键的参数值，始终与构造时传入的值相同。

如果 `deep=True`，还包含组件参数的键/值对。组件参数的索引为 `[componentname]__[paramname]`，`componentname` 的所有参数都以 `paramname` 形式出现，并带有其值。

  1. 则返回类型是 `pd-multiindex` 类型的 `Panel` 对象。示例：输出的第 i 个实例是在 `X` 上运行的第 i 个窗口。

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

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

参数:
在类的 `_tags 属性中设置的标签。

如果 `deep=True`，还包含任意级别的组件递归，例如 `[componentname]__[componentcomponentname]__[paramname]` 等。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

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

通过 `set_tags` 或 `clone_tags` 在实例上设置的标签，

在实例构造时设置的标签。

返回:
要检索的标签名称

tag_value_defaultany type, optional; default=None

引发:
如果未找到标签，则使用的默认/回退值。

raise_errorbool

未找到标签时是否引发 `ValueError`。

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

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

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

tag_valueAny

tag_value

  1. 始终：此对象的所有参数，如通过 `get_param_names` 获得的，值为该键的参数值，始终与构造时传入的值相同。

如果 `deep=True`，还包含组件参数的键/值对。组件参数的索引为 `[componentname]__[paramname]`，`componentname` 的所有参数都以 `paramname` 形式出现，并带有其值。

  1. 则返回类型是 `pd-multiindex` 类型的 `Panel` 对象。示例：输出的第 i 个实例是在 `X` 上运行的第 i 个窗口。

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

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

返回:
在 `self` 中的 `tag_name` 标签的值。如果未找到，则在 `raise_error` 为 True 时引发错误，否则返回 `tag_value_default`。

ValueError，如果 `raise_error` 为 `True`。

如果 `tag_name` 不在 `self.get_tags().keys()` 中，则引发 `ValueError`。

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

get_tags()[source]#

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

collected_tagsdict

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

配置在 `clone` 或 `reset` 调用时保留。

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

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

  • 目前假定只有具有标签

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

用于拟合转换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • `Series scitype = 单个时间序列。`pd.DataFrame`、`pd.Series` 或 `np.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`。

yoptional, sktime 兼容数据格式的数据, default=None

“scitype:transform-input”=”Series”、“scitype:transform-output”=”Series”，

返回:
的转换器具有 inverse_transform。

访问 self 中的属性

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

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

`self.is_fitted`，必须为 True。

返回:
附加数据，例如转换的标签。某些转换器需要此数据，请参见类文档字符串的详细信息。

X 的逆转换版本。

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

是否已调用 `fit`。

is_composite()[source]#

返回:
复合对象是包含对象的对象，作为参数。在实例上调用，因为这可能因实例而异。

composite: bool

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
反序列化自身，其结果输出到 path，对应于 cls.save(path) 的输出。
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化自身，其结果输出为 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]#

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

行为：如果 path 为 None，则返回一个内存中的序列化对象；如果 path 是一个文件位置，则将对象存储为该位置的一个 zip 文件。

保存的文件是 zip 文件，内容如下：_metadata - 包含对象的类，即 type(self) _obj - 序列化后的对象。此类使用默认的序列化方式 (pickle)。

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

如果为 None，对象将被保存到内存中的对象。如果为文件位置，对象将被保存到该文件位置。如果

  • path=”estimator” 则会在当前工作目录 (cwd) 创建一个名为 estimator.zip 的 zip 文件。

  • path=”/home/stored/estimator” 则会在

/home/stored/ 中存储一个名为 estimator.zip 的 zip 文件。

serialization_formatstr，默认为 “pickle”

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

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

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

参数:
get_config()[source]#

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

displaystr，“diagram”（默认）或 “text”

jupyter kernel 如何显示对象实例

  • “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 在

      并行化后关闭。

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

config_dictdict

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对自身的引用

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

如果 `X` 是 `Series` 或 `Panel` 并且 `transform-output` 是

set_tags(**tag_dict)[source]#

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

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

可以通过 `get_tags` 或 `get_tag` 检查当前标签值。

参数:
set_tags 方法只应在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后立即调用。

**tag_dictdict

返回:
自身

对自身的引用。

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

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

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

配置在 `clone` 或 `reset` 调用时保留。

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

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

  • 目前假定只有具有标签

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

要转换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • `Series scitype = 单个时间序列。`pd.DataFrame`、`pd.Series` 或 `np.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`。

yoptional, sktime 兼容数据格式的数据, default=None

“scitype:transform-input”=”Series”、“scitype:transform-output”=”Series”，

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

transform

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel
| 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`

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

使用 X 更新转换器，可选地使用 y。

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

配置在 `clone` 或 `reset` 调用时保留。

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

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

  • 目前假定只有具有标签

写入 self

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

  • 如果 remember_data 标签为 True，则通过 update_data 将 X 中的值更新到 self._X。

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

用于更新转换的数据

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

  • `Series scitype = 单个时间序列。`pd.DataFrame`、`pd.Series` 或 `np.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`。

yoptional, sktime 兼容数据格式的数据, default=None

“scitype:transform-input”=”Series”、“scitype:transform-output”=”Series”，

返回:
self估计器的拟合实例