滞后#

class Lag(lags=0, freq=None, index_out='extend', flatten_transform_index=True, keep_column_names=False, remember_data=True)[source]#

滞后转换器。将时间序列滞后一个或多个周期。

将时间序列转换为自身的滞后版本。可以以列表形式提供多个滞后。它是 pandas.shift 和整数索引滞后的估计器式包装器。

滞后可以作为简单的偏移量 lags 提供，或作为（滞后计数，频率）对提供，其中滞后计数是整数（lags 参数），频率是 pandas 频率描述符。

提供多个滞后时，将创建滞后时间序列的多个列连接副本。列的名称格式为 lagname__variablename，其中 lagname 描述滞后/频率。

如果在 _fit 或 _update 中提供了数据，Lag 转换器会记住这些索引并用于计算滞后值。要仅使用在 transform 中看到的数据，请使用 FitInTransform 组合器。

参数:
lags滞后偏移量，或滞后偏移量列表，可选，默认=0 (恒等转换)

“滞后偏移量”可以是以下之一：int - 移动/滞后的周期数 时间类：DateOffset, tseries.offsets, 或 timedelta

移动/滞后的时间差偏移量要求转换后的数据的时间索引是时间类 (非整数)

str - 来自 pandas.tseries 模块的时间规则，例如 “EOM”

freq频率描述符，或频率描述符列表，可选，默认=None

如果传入，必须是标量，或者是与 lags 参数等长的列表 freq 中的元素对应于 lags 中的元素 如果 freq 的第 i 个元素非 None，则 lags 的第 i 个元素必须是整数

这在下文称为“相应的滞后元素”

“频率描述符”可以是以下之一：时间类：DateOffset, tseries.offsets, 或 timedelta

移动时与相应的 lags 元素相乘

str - 来自 pd.tseries 模块的偏移量，例如 “D”, “M”，或时间规则，例如 “EOM”

index_outstr，可选，取值“shift”, “original”, “extend”之一，默认=”extend”

确定滞后时间序列的输出索引集 “shift” - 仅保留移动后的索引。

单个滞后不会创建 NA，但多个滞后可能会创建 NA。

“original” - 仅保留原始索引。通常会创建 NA。“extend” - 保留原始索引和移动后的索引。

如果移动后/原始索引不相交，通常会创建 NA，可能有很多。

flatten_transform_indexbool，可选 (默认=True)

如果为 True，返回的 DataFrame 的列是平坦的，格式为“lagname__variablename” 如果为 False，列是 MultiIndex (lagname, variablename) 如果返回的 mtype 没有列名，则此参数无效

keep_column_namesbool，可选 (默认=False)

仅当 lags 只包含一个元素时才有效 如果为 True，确保 transform 输出的列名与输入相同，即不是 lag_x__varname 而是 varname。覆盖 flatten_transform_index。

remember_databool，可选 (默认=True)

如果为 True，则记忆在 fit, update 中看到的数据，并在 transform 中使用 如果为 False，则仅使用在 transform 中看到的数据来生成滞后 设置为 False 可确保仅通过 fit_transform 使用时获得更快的运行时性能

属性:
is_fitted

是否已调用 fit。

示例

>>> from sktime.datasets import load_airline
>>> from sktime.transformations.series.lag import Lag
>>> X = load_airline()

单个滞后将生成具有相同变量的时间序列

>>> t = Lag(2)
>>> Xt = t.fit_transform(X)

可以提供多个滞后，这将导致多列输出

>>> t = Lag([2, 4, -1])
>>> Xt = t.fit_transform(X)

index_out 的默认设置将在两侧扩展索引。为确保转换后索引保持不变，请使用 index_out=”original”

>>> t = Lag([2, 4, -1], index_out="original")
>>> Xt = t.fit_transform(X)

滞后转换器可能会（并且通常会）创建 NA。（除非 index_out=”shift” 且只有一个滞后，或在无关紧要的情况下）。这可能需要处理，例如，如果后续的管道步骤不接受 NA。要处理 NA，请使用 Imputer 进行管道处理

>>> from sktime.datasets import load_airline
>>> from sktime.transformations.series.impute import Imputer
>>> from sktime.transformations.series.lag import Lag
>>> X = load_airline()
>>>
>>> t = Lag([2, 4, -1]) * Imputer("nearest")
>>> Xt = t.fit_transform(X)

方法

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 或 dict 列表，默认 = {}

用于创建类的测试实例的参数 每个 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，可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于构造一个新的 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 或 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 个元素是测试中 objs 中第 i 个实例的名称。如果实例多于一个，命名约定是 {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")。

参数:
X采用 sktime 兼容数据容器格式的时间序列

用于拟合转换器的数据。

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

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 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 的转换版本。

状态变化

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

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 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，则返回的是 Panel，其实例数与 X 相同（转换器应用于每个输入的 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 方法是一个类方法，仅考虑类级别标签值和覆盖来检索标签的值。

  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 设置的动态标签覆盖。

获取自身的配置标志。

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，也包含组件参数的键值对 组件参数的索引格式为 [组件名称]__[参数名称] 组件名称 的所有参数显示为 参数名称 及其值

如果 deep=True，也包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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，将返回此对象的参数名称：值 dict，包括组件（= BaseObject 类型参数）的参数。

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

params键为 str 类型的 dict

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

  • 始终：此对象的所有参数，如通过 get_param_names 获取的 对于该键，值是此对象的参数值 值始终与构造时传入的值相同

  • 如果 deep=True，也包含组件参数的键值对 组件参数的索引格式为 [组件名称]__[参数名称] 组件名称 的所有参数显示为 参数名称 及其值

如果 deep=True，也包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

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

每个与 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 (1D 或 2D)

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

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

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

y可选，采用 sktime 兼容数据格式的数据，默认=None

self.is_fitted，必须为 True

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

X 的逆转换版本

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

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

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

返回:
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 调用会删除所有对象属性，除了

  • 超参数 = __init__ 的参数，写入到 self，例如 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”，则会创建一个 zip 文件 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

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

warningsstr，"on"（默认）或 "off"

是否引发警告，仅影响 sktime 的警告

  • “on” = 将引发 sktime 的警告

  • “off” = 将不引发 sktime 的警告

backend:parallelstr，可选，默认为 "None"

广播/向量化时用于并行化的后端，以下之一

  • “None”：按顺序执行循环，简单的列表推导式

  • “loky”, “multiprocessing” and “threading”：使用 joblib.Parallel

  • “joblib”：自定义和第三方 joblib 后端，例如 spark

  • “dask”：使用 dask，需要在环境中安装 dask 包

  • “ray”：使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict，可选，默认为 {}（不传递参数）

作为配置传递给并行化后端的额外参数。有效键取决于 backend:parallel 的值

  • “None”：无额外参数，backend_params 被忽略

  • “loky”, “multiprocessing” and “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"；要使用的日志记录器名称。

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

为自身设置 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，则仅设置 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

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

返回:
自身

自身的引用。

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 (1D 或 2D)

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

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

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

y可选，采用 sktime 兼容数据格式的数据，默认=None

self.is_fitted，必须为 True

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

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

  • Primitives，则返回的是 pd.DataFrame，其行数与 X 中的实例数相同 示例：返回的第 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 写入 self._X，并由 X 中的值更新。

参数:
X采用 sktime 兼容数据容器格式的时间序列

用于更新转换的数据

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

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

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

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

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

y可选，采用 sktime 兼容数据格式的数据，默认=None

self.is_fitted，必须为 True

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