BoxCoxTransformer#

类 BoxCoxTransformer(bounds=None, method='mle', sp=None, lambda_fixed=0.0, enforce_positive=True)[source]#

Box-Cox 幂变换。

Box-Cox 变换是一种幂变换，用于使数据更趋近于正态分布，并根据超参数 lambda 来稳定其方差。[1]

此变换器逐元素应用 Box-Cox 变换，其中 lambda 参数通过 method 指定的方法进行拟合。

Box-Cox 变换定义为：对于正数 \(y\)，当 \(\lambda \ne 0\) 时，变换为 \(\frac{y^{\lambda}-1}{\lambda}\)；当 \(\lambda = 0\) 时，变换为 \(ln(y)\)。

\(\lambda\) 参数是针对每个时间序列、实例和变量进行拟合的，具体方法取决于 method 参数

  • "pearsonr" - 最大化变换后数据与标准化未变换数据之间的 Pearson 相关性。直接调用 scipy.stats.boxcox_normmax，使用 method="pearsonr"，bracket=bounds，其余为默认值。

  • "mle" - 最大化 Box-Cox 对数似然。直接调用 scipy.stats.boxcox_normmax，使用 method="mle"，bracket=bounds，其余为默认值。

  • "guerrero" - Guerrero 方法，考虑季节周期性，见 [2]。这需要将季节性参数作为 sp 传入。

  • "fixed" - 固定预设的 \(\lambda\)，通过 lambda_fixed 传入。

如果存在非正数 :math:y，在 fit 中默认将其替换为其绝对值。在 transform 中，应用带符号的 Box-Cox 变换，即保留符号，同时对数值应用变换。

参数:
bounds包含两个有限浮点数的元组

拟合 lambda 值时的优化范围初始区间（下界，上界）。默认值 = 无界。如果 method == "fixed" 则忽略。对于半开区间，请传递一个较大的边界值，例如 (0, 1e12) 表示正 lambda。不支持使用无穷大和 NaN 作为边界值。

method{“pearsonr”, “mle”, “guerrero”, “fixed”}，默认为 “mle”

用于确定 Box-Cox 变换中使用的 lambda 值的优化方法。

spint，可选，仅当 method=”guerrero” 时必须提供

数据的季节周期性，以整数形式表示。仅在使用 method=”guerrero” 时使用。必须是大于等于 2 的整数。

lambda_fixedfloat，可选，默认为 0.0

仅当 method=”fixed” 时必须提供，默认值表示 BoxCoxTransformer 的行为类似于对数变换

enforce_positivebool，可选，默认为 True

如果为 True，在 fit 中，X 中的负值条目会被其绝对值替换。在 transform 中，应用带符号的 Box-Cox 变换，即保留符号，同时对数值应用变换。如果为 False，任何负值将直接传递给底层函数（可能导致错误）。

属性:
lambda_float

根据提供的 method 和在 fit 中提供的数据拟合得到的 Box-Cox lambda 参数。

另请参阅

LogTransformer

使用自然对数变换输入数据。有助于规范化数据并压缩序列的方差。

sktime.transformations.series.exponent.ExponentTransformer

通过将输入数据提升到指数进行变换。如果提供分数指数，有助于压缩序列的方差。

sktime.transformations.series.exponent.SqrtTransformer

通过取输入数据的平方根进行变换。有助于压缩输入序列的方差。

参考文献

[1]

Box, G. E. P. & Cox, D. R. (1964) An analysis of transformations, Journal of the Royal Statistical Society, Series B, 26, 211-252.

[2]

V.M. Guerrero, “Time-series analysis supported by Power Transformations “, Journal of Forecasting, vol. 12, pp. 37-48, 1993.

示例

>>> from sktime.transformations.series.boxcox import BoxCoxTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = BoxCoxTransformer()
>>> 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_setstr，默认为“default”

返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 "default" 集。当前没有为变换器保留的值。

返回值:
paramsdict 或 list of 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 设置动态标签覆盖。

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

动态标签被设置为 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 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {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.Series, 或 np.ndarray (1D 或 2D)

  • Panel scitype = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或由 Series 类型的 pd.DataFrame 组成的 list

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

状态更改

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

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

可能在可能的情况下通过引用强制转换为内部类型或 update_data 兼容类型

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

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

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

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或由 Series 类型的 pd.DataFrame 组成的 list

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅 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，则返回一个 pd.DataFrame，其行数与 X 中的实例数量相同。例如：返回值的第 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 方法是一个类方法，仅考虑类级别的标签值和覆盖来检索标签的值。

它从对象中返回名称为 tag_name 的标签值，按以下降序优先级考虑标签覆盖

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

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

按继承顺序。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果找不到标签的默认/备用值。

返回值:
tag_value

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

classmethod get_class_tags()[source]#

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

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

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

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

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

值是相应的标签值，按以下降序优先级考虑覆盖

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

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

按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()[source]#

获取自身的配置标志。

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

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

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

在 clone 或 reset 调用下，配置会保留。

返回值:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

需要状态为“已拟合”。

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

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

参数:
deepbool，默认为 True

是否返回组件的参数。

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

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

返回值:
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_tags 或 clone_tags 设置的标签，

在实例构建时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

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。

get_tags()[source]#

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

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

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

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

值是相应的标签值，按以下降序优先级考虑覆盖

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

在实例构建时。

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

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

按继承顺序。

返回值:
collected_tagsdict

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

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

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

目前假定只有带有标签

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

的变换器具有 inverse_transform 方法。

所需状态

需要状态为“已拟合”。

在 self 中访问

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

  • self.is_fitted，必须为 True

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

用于拟合变换器的数据。

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或由 Series 类型的 pd.DataFrame 组成的 list

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

附加数据，例如用于变换的标签。某些变换器需要此数据，详见类文档字符串。

返回值:
X 的逆变换版本

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

is_composite()[source]#

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

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

返回值:
composite: bool

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

property is_fitted[source]#

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

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 会删除所有对象属性，除了

超参数 = __init__ 的参数，这些参数写入到 self，例如 self.paramname，其中 paramname 是 __init__ 的参数

  • 包含双下划线（即字符串“__”）的对象属性。例如，名为“__myattr”的属性会保留。

  • 包含双下划线（即字符串“__”）的对象属性。例如，名为“__myattr”的属性会被保留。

  • 配置属性，配置会保留不变。也就是说，调用 get_config 在 reset 前后的结果是相等的。

类和对象方法，以及类属性也不受影响。

等同于 clone，不同之处在于 reset 会修改 self 本身，而不是返回一个新的对象。

调用 self.reset() 后，self 的值和状态等于调用构造函数 ``type(self)(**self.get_params(deep=False))`` 后获得的对象。

返回值:
self

类实例会重置到干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[源代码]#

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

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

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

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

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

  • 如果 path=”estimator”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • 如果 path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回值:
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - 包含文件引用的 ZipFile
set_config(**config_dict)[源代码]#

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

参数:
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”：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)[源代码]#

设置此对象的参数。

此方法既适用于简单的 skbase 对象，也适用于复合对象。对于包含其他对象的复合对象，可以使用参数键字符串 <component>__<parameter> 来访问组件 <component> 中的 <parameter>。如果引用明确，例如没有两个组件参数同名 <parameter>，也可以使用不带 <component>__ 的字符串 <parameter>。可以使用 __ 后缀作为完整字符串的别名，前提是它们在 get_params 键中是唯一的。

参数:
**paramsdict

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

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

设置自身的 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过链式哈希（chain hashing）从 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 以便在多次函数调用中获得可复现的输出。

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对自身的引用
set_tags(**tag_dict)[源代码]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中，即在创建期间或通过 __init__ 创建后直接调用。

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

参数:
**tag_dictdict

标签名：标签值 对组成的字典。

返回值:
Self

对自身的引用。

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

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

所需状态

需要状态为“已拟合”。

在 self 中访问

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

  • self.is_fitted，必须为 True

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

要转换的数据。

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

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

  • Panel scitype = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或由 Series 类型的 pd.DataFrame 组成的 list

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

附加数据，例如用于变换的标签。某些变换器需要此数据，详见类文档字符串。

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

转换

X

-输出

返回类型

时间序列

基本类型

pd.DataFrame (1 行)

面板数据

基本类型

pd.DataFrame

时间序列

时间序列

时间序列

面板数据

时间序列

面板数据

时间序列

面板数据

面板数据
返回值中的实例对应于 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，

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

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

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

所需状态

需要状态为“已拟合”。

在 self 中访问

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

  • self.is_fitted，必须为 True

写入自身

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

  • 如果 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 = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或由 Series 类型的 pd.DataFrame 组成的 list

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

附加数据，例如用于变换的标签。某些变换器需要此数据，详见类文档字符串。

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