DateTimeFeatures#

class DateTimeFeatures(ts_freq=None, feature_scope='minimal', manual_selection=None, keep_original_columns=False)[source]#

日期时间特征提取，例如在预测中用作外部数据。

DateTimeFeatures 使用日期索引列并生成日期特征，例如标识年份、一年中的周数、星期几等。

参数：
ts_freqstr, 可选 (默认=”day”)

限制选择项的频率低于由 ts_freq 给定的时间序列频率的项。例如，如果提供的是月度数据，并且 ts_freq = (“M”)，则派生更高频率的虚拟变量（如周度虚拟变量）是没有意义的。由于 Pandas 支持多种不同的频率（例如，Pandas 允许每 4 天的频率），用户必须提供此参数。与其他参数的交互：用于缩小 feature_scope 的特征选择范围，因为只考虑频率低于 ts_freq 的特征。手动指定特征的计算将忽略此参数，但如果提供了手动特征且其频率高于 ts_freq，则会引发警告。仅支持以下频率： * Y - 年 * Q - 季度 * M - 月 * W - 周 * D - 天 * H - 小时 * T - 分钟 * S - 秒 * L - 毫秒

feature_scope: str, 可选 (默认=”minimal”)

指定要返回多少日历特征。例如，像季度的周数这样很少使用的特征只在 feature_scope = “comprehensive” 时返回。 * “minimal” * “efficient” * “comprehensive”

manual_selection: str, 可选 (默认=None)

手动选择虚拟变量。表示法是 parent 的 child 以进行精确表示。将忽略指定的 feature_scope，但仍会检查指定的 ts_freq 并发出警告。返回的所有列都基于整数。日期格式如下所示为 DD-MM-YYYY。支持的值： * None * quarter_of_year

基于 1 的索引 1-(1月至3月), 2-(4月至6月), 3-(7月至9月), 4-(10月至12月)

  • month_of_year

    相对于 1 月的基于 1 的偏移量 1-1月, 2-2月,…, 12-12月

  • week_of_year

    相对于 ISO 年第一周的基于 1 的偏移量

  • day_of_year

    相对于 1 月 1 日的基于 1 的偏移量 1 是 YYYY-01-01，2 是 YYYY-01-02，以此类推。

  • month_of_quarter

    相对于每个季度第一个月的基于 1 的索引 (1月, 4月, 7月, 10月) 对于第一季度：1-1月，2-2月，3-3月

  • week_of_quarter

    相对于季度第一周的基于 1 的偏移量。季度的第一周/最后一周可能包含或不包含 7 天。所有其他周包含 7 天。一周从星期一开始计算。如果月份从星期一开始，则从该月开始到下个星期一的前七天是第 1 周。否则，第 1 周是从该月 1 号到第一个星期一。示例

    如果 YYYY-01-01 是星期一，则第 1 周：周一、周二、周三、周四、周五、周六、周日 (YYYY-01-07)；第 2 周：周一 (YYYY-01-08)、周二、…、周日。如果 YYYY-01-01 是星期四，则第 1 周：周四、周五、周六、周日 (YYYY-01-04)；第 2 周：周一 (YYYY-01-05)、周二、…、周日。

  • day_of_quarter

    基于 1 的索引

  • week_of_month

    基于 1 的索引 1 表示月份的第一周。第一周包括该月的前 7 天（YYYY-MM-01 至 YYYY-MM-07）。2 表示月份的第二周。第二周包括接下来的 7 天（YYYY-MM-08 至 YYYY-MM-14），以此类推。

  • day_of_month

    相对于每月第一天的基于 1 的偏移量 1 是 YYYY-MM-01，2 是 YYYY-MM-02，以此类推。

  • day_of_week

    相对于星期一的基于 0 的偏移量 0-星期一, 1-星期二,…, 6-星期日

  • hour_of_week

    相对于星期一(00:00:00+00:00) 的基于 0 的偏移量

  • hour_of_day

    相对于 00:00:00+00:00 的基于 0 的偏移量

  • minute_of_hour

    相对于 00:00:00 的基于 0 的偏移量

  • second_of_minute

    相对于 00:00:00 的基于 0 的偏移量

  • millisecond_of_second

    相对于 00:00:00.0000 的基于 0 的偏移量

  • is_weekend

    1 表示是周末，0 表示不是周末

  • year (没有更低频率的特殊情况)。

keep_original_columnsboolean, 可选, 默认=False

在传递给 .transform() 的 X 中保留原始列。

属性：
is_fitted

是否已调用 fit 方法。

示例

>>> from sktime.transformations.series.date import DateTimeFeatures
>>> from sktime.datasets import load_airline
>>> y = load_airline()

返回列 y, year, month_of_year

>>> transformer = DateTimeFeatures(ts_freq="M")
>>> y_hat = transformer.fit_transform(y)

返回列 y, month_of_year

>>> transformer = DateTimeFeatures(ts_freq="M", manual_selection=["month_of_year"])
>>> y_hat = transformer.fit_transform(y)

返回列 ‘y’, ‘year’, ‘quarter_of_year’, ‘month_of_year’, ‘month_of_quarter’

>>> transformer = DateTimeFeatures(ts_freq="M", feature_scope="comprehensive")
>>> y_hat = transformer.fit_transform(y)

返回列 ‘y’, ‘year’, ‘quarter_of_year’, ‘month_of_year’

>>> transformer = DateTimeFeatures(ts_freq="M", feature_scope="efficient")
>>> y_hat = transformer.fit_transform(y)

返回列 ‘y’, ‘year’, ‘month_of_year’

>>> transformer = DateTimeFeatures(ts_freq="M", feature_scope="minimal")
>>> 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()

返回估计器的测试参数设置。

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()[source]#

返回估计器的测试参数设置。

返回：
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, 可选

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

引发：
未拟合错误

如果估计器尚未拟合。

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 或 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")。

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

用于拟合转换的数据。

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

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

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

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

状态变化

将状态更改为“fitted”。

写入 self: _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 = 时间序列集合。带有 2 级行 MultiIndex (实例, 时间) 的 pd.DataFrame，3D np.ndarray (实例, 变量, 时间)，Series 类型 pd.DataFrame 的 list

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

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

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

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

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

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

获取已拟合的参数。

所需状态

要求状态为“fitted”。

参数：
deepbool, 默认=True

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

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

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

返回：
fitted_params键为 str 类型的字典

已拟合参数字典，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 方法。

所需状态

要求状态为“fitted”。

访问自身（self）的属性

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

  • self.is_fitted，必须为 True

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

用于拟合转换的数据。

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

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

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

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

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

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

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

返回：
X 的逆转换版本

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

is_composite()[source]#

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

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

返回：
compositebool

对象是否包含任何参数，其值是 BaseObject 的派生实例。

property is_fitted[source]#

是否已调用 fit 方法。

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

返回：
bool

估算器是否已进行 fit（拟合）操作。

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”，则会在当前工作目录创建一个 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]#

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

参数：
config_dictdict

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

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

jupyter 内核如何显示自身的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认为 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”：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>），也可以仅使用字符串 <parameter>，而无需 <component>__ 前缀。

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

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)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

返回：
Self

对自身的引用。

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

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

所需状态

要求状态为“fitted”。

访问自身（self）的属性

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

  • self.is_fitted，必须为 True

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

要转换的数据。

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

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

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

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

有关数据格式的更多详细信息，请参阅 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
返回中的实例对应于 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)[source]#

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

所需状态

要求状态为“fitted”。

访问自身（self）的属性

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

  • self.is_fitted，必须为 True

写入 self

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

  • 如果 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 (实例, 时间) 的 pd.DataFrame，3D np.ndarray (实例, 变量, 时间)，Series 类型 pd.DataFrame 的 list

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

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

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

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

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