PartialAutoCorrelationTransformer#

class PartialAutoCorrelationTransformer(n_lags=None, method='ywadjusted')[source]#

偏自相关转换器。

偏自相关函数衡量时间序列与其自身在不同滞后之间的条件相关性。具体来说，计算某个时间点与某个滞后之间的相关性时，会以该时间点与该滞后之间的所有数据点为条件。

PartialAutoCorrelationTransformer 为指定的 n_lags 内的每个滞后返回这些值作为一个序列。

参数:
n_lagsint，默认为 None

返回偏自相关值的滞后数量。如果为 None，statsmodels 的 acf 函数将使用 min(10 * np.log10(nobs), nobs // 2 - 1)。

methodstr，默认为“ywadjusted”

指定用于计算的方法。

  • “yw” 或 “ywadjusted” : Yule-Walker 方法，在 acovf 的分母中进行样本大小调整。默认值。

  • “ywm” 或 “ywmle” : Yule-Walker 方法，不进行调整。

  • “ols” : 对时间序列及其滞后项和常数进行回归。

  • “ols-inefficient” : 使用单一通用样本对时间序列的滞后项进行回归，以估计所有 pacf 系数。

  • “ols-adjusted” : 对时间序列的滞后项进行回归，并进行偏差调整。

  • “ld” 或 “ldadjusted” : Levinson-Durbin 递推法，带偏差校正。

  • “ldb” 或 “ldbiased” : Levinson-Durbin 递推法，不带偏差校正。

属性:
is_fitted

是否已调用 fit 方法。

另请参阅

AutoCorrelationTransformer

说明

提供 statsmodels pacf 函数的包装器。

示例

>>> from sktime.transformations.series.acf import PartialAutoCorrelationTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()  
>>> transformer = PartialAutoCorrelationTransformer(n_lags=12)  
>>> 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()

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

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

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 属性应在调用对象的 fit 方法时设置为 True。

如果未拟合，则抛出 NotFittedError。

参数:
method_namestr，可选

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等效于返回 sklearn.clone 的 self。

等效于使用 self 的参数构建一个 type(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 的动态标签覆盖。

在对象构造期间，即在 __init__ 方法中调用，或在通过 __init__ 构造后立即调用，clone_tags 方法应仅在此处调用。

动态标签被设置为 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 个元素是 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.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。pd.DataFrame 带有两层行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有三层或更多层行 MultiIndex (层级_1, ..., 层级_n, 时间)

有关数据格式的更多详细信息，请参阅 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 的转换版本。

状态改变

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

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

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

模型属性（以“_”结尾）：取决于估计器

参数:
X符合 sktime 数据容器格式的时间序列

用于拟合转换的数据，以及要转换的数据。

sktime 中的独立数据格式被称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。pd.DataFrame 带有两层行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有三层或更多层行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

y可选，sktime 兼容数据格式的数据，默认为 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，则返回一个行数与 X 中的实例数相同的 pd.DataFrame。示例：返回的第 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 方法是一个类方法，它仅考虑类级别标签值和覆盖来检索标签的值。

  1. 它从对象中返回名称为 tag_name 的标签的值，并按照以下降序优先顺序考虑标签覆盖：

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

在父类的 _tags 属性中设置的标签，

按照继承顺序。

不考虑实例上的动态标签覆盖（通过 set_tags 或 clone_tags 设置，这些覆盖定义在实例上）。

参数:
要检索可能带有实例覆盖的标签值，请改用 get_tag 方法。

tag_namestr

标签值的名称。

tag_value_default任意类型

返回:
如果未找到标签时的默认/回退值。

tag_value

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

从类中获取类标签，并继承父类的标签层级。

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

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

classmethod get_class_tags()[source]#

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

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

  1. 它从对象中返回名称为 tag_name 的标签的值，并按照以下降序优先顺序考虑标签覆盖：

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

在父类的 _tags 属性中设置的标签，

值是相应的标签值，覆盖按照以下降序优先顺序：

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

按照继承顺序。

要检索可能带有实例覆盖的标签，请改用 get_tags 方法。

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

collected_tagsdict

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

获取 self 的配置标志。

get_config()[source]#

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

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

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

返回:
配置在 clone 或 reset 调用下保留。

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，则按字母顺序排列。

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

参数:
需要状态为“fitted”（已拟合）。

get_params(deep=True)[source]#

  • 是否返回组件的参数。

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

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

params键为 str 类型的 dict

  • 参数字典，paramname : paramvalue 键值对包括

  • 总是：此对象的所有参数，通过 get_param_names 获取的值是该键对应的参数值，属于此对象。值总是与构造时传递的值相同

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

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

从实例中获取标签值，并考虑标签层级继承和覆盖。

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

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

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

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，并按照以下降序优先顺序考虑标签覆盖：

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

  1. 它从对象中返回名称为 tag_name 的标签的值，并按照以下降序优先顺序考虑标签覆盖：

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

在父类的 _tags 属性中设置的标签，

参数:
要检索可能带有实例覆盖的标签值，请改用 get_tag 方法。

在实例构造时。

要检索的标签名称

tag_value_default任意类型，可选；默认为 None

如果未找到标签时的默认/回退值

raise_errorbool

返回:
未找到标签时是否抛出 ValueError

tag_valueAny

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

ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则抛出 ValueError。

从实例中获取标签，并考虑标签层级继承和覆盖。

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

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

get_tags()[source]#

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

  1. get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，并按照以下降序优先顺序考虑标签覆盖：

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

  1. 它从对象中返回名称为 tag_name 的标签的值，并按照以下降序优先顺序考虑标签覆盖：

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

在父类的 _tags 属性中设置的标签，

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

collected_tagsdict

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

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

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

目前假定只有带有标签

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

get_fitted_params(deep=True)[source]#

所需状态

具有 inverse_transform 方法。

  • 访问 self 中的内容

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

参数:
X符合 sktime 数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的独立数据格式被称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。pd.DataFrame 带有两层行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有三层或更多层行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

y可选，sktime 兼容数据格式的数据，默认为 None

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

返回:
X 的逆转换版本

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

is_composite()[source]#

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

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

返回:
composite: 布尔值

对象是否具有任何参数，其值是 BaseObject 的后代实例。

属性 is_fitted[source]#

是否已调用 fit 方法。

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

返回:
布尔值

估计器是否已被 fit。

类方法 load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
在 path 处输出的自反序列化结果，对应于 cls.save(path)
类方法 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]#

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

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

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

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

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

  • path=”estimator”，则将在当前工作目录创建 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则将在 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str，默认 = “pickle”

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

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

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

参数:
配置在 clone 或 reset 调用下保留。

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

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

jupyter 内核如何显示对象实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_only布尔值，默认=True

打印对象时，是否只列出与默认值不同的参数（True），或所有参数名称和值（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”：布尔值，默认=True；False 可防止 ray 在并行化后

      关闭。

    • “logger_name”：str，默认=”ray”；要使用的 logger 名称。

    • “mute_warnings”：布尔值，默认=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 可在多次函数调用中获得可复现的输出。

需要状态为“fitted”（已拟合）。

是否在 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]#

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

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

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

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

set_tags 方法只能在对象的 __init__` 方法中，即在构造期间或通过 __init__ 直接在构造后调用。

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

参数:
**tag_dictdict

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

返回:
Self

指向对象本身的引用。

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

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

get_fitted_params(deep=True)[source]#

所需状态

具有 inverse_transform 方法。

  • 访问 self 中的内容

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

参数:
X符合 sktime 数据容器格式的时间序列

要转换的数据。

sktime 中的独立数据格式被称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。pd.DataFrame 带有两层行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有三层或更多层行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

y可选，sktime 兼容数据格式的数据，默认为 None

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

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

转换

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

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

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

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

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

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

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

get_fitted_params(deep=True)[source]#

所需状态

具有 inverse_transform 方法。

  • 访问 self 中的内容

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

写入 self

  • 访问 self 中的内容

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

参数:
X符合 sktime 数据容器格式的时间序列

用于更新转换的数据

sktime 中的独立数据格式被称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或2维)

  • Panel scitype = 时间序列集合。pd.DataFrame 带有两层行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 类型的 Series 类型 pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有三层或更多层行 MultiIndex (层级_1, ..., 层级_n, 时间)

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

y可选，sktime 兼容数据格式的数据，默认为 None

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

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