PeakTimeFeature

class PeakTimeFeature(ts_freq=None, peak_hour_start=None, peak_hour_end=None, peak_day_start=None, peak_day_end=None, peak_week_start=None, peak_week_end=None, peak_month_start=None, peak_month_end=None, peak_quarter_start=None, peak_quarter_end=None, peak_year_start=None, peak_year_end=None, working_hour_start=None, working_hour_end=None, keep_original_columns=False, keep_original_peaktime_data_columns=False)

PeakTime 特征提取，用于例如基于树的模型。

PeakTimeFeature 使用日期时间索引列并生成峰值/工作时间特征，例如高峰时段、高峰周、高峰月、工作时间等。它基于输入的间隔、开始时间、结束时间工作，例如 peak_hour_start=[6], peak_hour_end=[9]

参数:

ts_freqstr, default= None

将项目的选择限制为频率低于由 ts_freq 给定的时间序列频率的项目。例如，如果提供了每日数据并且 ts_freq = (“D”)，则派生具有更高频率（如小时特征）的 PeakTimeFeature 是没有意义的。因此，输出必须排除 is_peak_hour，并且将是 is_peak_day, is_peak_week, is_peak_month, is_peak_quarter, is_peak_year。仅支持以下频率：{“Y”: 年, “Q”: 季度, “M”: 月, “W”: 周, “D”: 日, “H”: 小时}

peak_hour_startlist, default= None

高峰时段的开始间隔列表，其中第一个参数确定第一个开始小时，第二个参数确定第二个开始小时，依此类推。[peak_hour_start1, peak_hour_start2, peak_hour_start3, …]

peak_hour_endlist, default= None

高峰时段的结束间隔列表，其中第一个参数确定第一个结束小时，第二个参数确定第二个结束小时，依此类推。[peak_hour_end1, peak_hour_end2, peak_hour_end3, …]

peak_day_startlist, default= None

高峰日期的开始间隔列表，其中第一个参数确定第一个开始日期，第二个参数确定第二个开始日期，依此类推。[peak_day_start1, peak_day_start2, peak_day_start3, …]

peak_day_endlist, default= None

高峰日期的结束间隔列表，其中第一个参数确定第一个结束日期，第二个参数确定第二个结束日期，依此类推。[peak_day_end1, peak_day_end2, peak_day_end3, …]

peak_week_startlist, default= None

高峰周的开始间隔列表，其中第一个参数确定第一个开始周，第二个参数确定第二个开始周，依此类推。[peak_week_start1, peak_week_start2, peak_week_start3, …]

peak_week_endlist, default= None

高峰周的结束间隔列表，其中第一个参数确定第一个结束周，第二个参数确定第二个结束周，依此类推。[peak_week_end1, peak_week_end2, peak_week_end3, …]

peak_month_startlist, default= None

高峰月的开始间隔列表，其中第一个参数确定第一个开始月，第二个参数确定第二个开始月，依此类推。[peak_month_start1, peak_month_start2, peak_month_start3, …]

peak_month_endlist, default= None

高峰月的结束间隔列表，其中第一个参数确定第一个结束月，第二个参数确定第二个结束月，依此类推。[peak_month_end1, peak_month_end2, peak_month_end3, …]

peak_quarter_startlist, default= None

高峰季度的开始间隔列表，其中第一个参数确定第一个开始季度，第二个参数确定第二个开始季度，依此类推。[peak_quarter_start1, peak_quarter_start2, peak_quarter_start3, …]

peak_quarter_endlist, default= None

高峰季度的结束间隔列表，其中第一个参数确定第一个结束季度，第二个参数确定第二个结束季度，依此类推。[peak_quarter_end1, peak_quarter_end2, peak_quarter_end3, …]

peak_year_startlist, default= None

高峰年的开始间隔列表，其中第一个参数确定第一个开始年份，第二个参数确定第二个开始年份，依此类推。[peak_year_start1, peak_year_start2, peak_year_start3, …]

peak_year_endlist, default= None

高峰年的结束间隔列表，其中第一个参数确定第一个结束年份，第二个参数确定第二个结束年份，依此类推。[peak_year_end1, peak_year_end2, peak_year_end3, …]

working_hour_startlist, default= None

工作时段的开始间隔列表，其中第一个参数确定第一个开始工作小时，第二个参数确定第二个开始工作小时，依此类推。例如，[working_hour_start1, working_hour_start2, working_hour_start3, …]

working_hour_endlist, default= None

工作时段的结束间隔列表，其中第一个参数确定第一个结束工作小时，第二个参数确定第二个结束工作小时，依此类推。[working_hour_end1, working_hour_end2, working_hour_end3, …]

keep_original_columnsboolean, optional, default=False

如果为 True，则在传递给 .transform() 的主数据框 (X) 中保留原始列。

keep_original_peaktime_data_columns: boolean, optional, default=False

如果为 True，则保留原始 peaktime_data 数据框列，包括所有单独的峰值/工作时间列，例如 peak_hour_1, peak_hour_2, peak_week_1, peak_week_2, …

属性:

is_fitted

是否已调用 fit。

备注

• 日历特征的描述和偏移如下

hour

一天的小时，00:00:00 = 0，23:00:00 = 23。

day_of_week

一周中的某天，星期一=0，星期日=6。

week_of_year

一年中的第几周 (ISO 日历)，开始 = 1，结束 = 52 或 53

month_of_year

月份，一月=1，十二月=12。

quarter

一年中的季度：一月、二月、三月 = 1 四月、五月、六月 = 2 七月、八月、九月 = 3 十月、十一月、十二月 = 4

year

日期时间的年份。

• 不同间隔的描述

1- 一个峰值间隔的示例：peak_hour_start=[6], peak_hour_end=[9] 表示我们只有一个高峰时段间隔，高峰从早上 6 点开始，到早上 9 点结束。

2- 两个峰值间隔的示例：peak_hour_start=[6, 16], peak_hour_end=[9, 20] 表示我们有两个高峰时段间隔，第一个高峰从早上 6 点开始，到早上 9 点结束。第二个高峰从下午 4 点开始，到晚上 8 点结束。我们可以有不止两个间隔。

3- 一个工作间隔的示例：working_hour_start=[8], working_hour_end=[16] 表示我们只有一个工作时段间隔，工作从早上 8 点开始，到下午 4 点结束。

4- 两个工作间隔的示例：working_hour_start=[8, 15], working_hour_end=[12, 19] 表示我们有两个工作时段间隔，第一个从早上 8 点开始，到下午 3 点结束。第二个从下午 3 点开始，到晚上 7 点结束。我们可以有不止两个间隔。

示例

>>> from sktime.transformations.series.peak import PeakTimeFeature  
>>> from sktime.datasets import   
>>> y = load_solar()  
>>> y = y.tz_localize(None)  
>>> y = y.asfreq("H")  

示例 1：一个高峰时段和工作时段的间隔。（基于一个开始/结束间隔）

返回列 is_peak_hour, is_working_hour

>>> transformer = PeakTimeFeature(ts_freq="H",
... peak_hour_start=[6], peak_hour_end=[9],
... working_hour_start=[8], working_hour_end=[16]
... )  
>>> y_hat_peak = transformer.fit_transform(y)  

示例 2：高峰时段和工作时段的两个间隔。（基于两个开始/结束间隔）

返回列 is_peak_hour, is_working_hour

>>> transformer = PeakTimeFeature(ts_freq="H",
... peak_hour_start=[6, 16], peak_hour_end=[9, 20],
... working_hour_start=[8, 15], working_hour_end=[12, 19]
... )  
>>> y_hat_peak = transformer.fit_transform(y)  

示例 3：我们可能有不同季节性的高峰。这是两个间隔（基于两个开始/结束间隔）的高峰小时、高峰日、高峰周、高峰月的示例

返回列 is_peak_hour, is_peak_day, is_peak_week, is_peak_month

>>> transformer = PeakTimeFeature(ts_freq="H",
... peak_hour_start=[6, 16], peak_hour_end=[9, 20],
... peak_day_start=[1, 2], peak_day_end=[2, 3],
... peak_week_start=[35, 45], peak_week_end=[40, 52],
... peak_month_start=[1, 7], peak_month_end=[6, 12]
... )  
>>> y_hat_peak = 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()

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

返回:

paramsdict or list of dict, default = {}

用于创建类的测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一）字典

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在调用对象的 fit 方法时设置为 True。

如果不是，则引发 NotFittedError。

参数:

method_namestr, optional

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是具有相同超参数和配置的不同对象，处于初始化后状态。此函数等同于返回 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。

引发:

如果克隆不符合要求，则引发 RuntimeError，因为 __init__ 存在缺陷。

clone_tags(estimator, tag_names=None)

从另一个对象克隆标签作为动态覆盖。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

动态标签设置为 estimator 中标签的值，名称由 tag_names 指定。

tag_names 的默认值是将 estimator 的所有标签写入 self。

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

estimator:class:BaseObject 或派生类的实例

参数:

tag_namesstr 或 str 列表, default = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

返回:

self 的引用。

classmethod create_test_instance(parameter_set='default')

parameter_setstr, default=”default”

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

参数:

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

instance带有默认参数的类实例

返回:

classmethod create_test_instances_and_names(parameter_set='default')

objscls 实例列表

创建所有测试实例的列表以及它们的名称列表。

参数:

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

instance带有默认参数的类实例

返回:

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

namesstr 列表，与 objs 长度相同

第 i 个元素是测试中 obj 第 i 个实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y=None)

状态改变

将转换器拟合到 X，可选拟合到 y。

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

写入自身

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 (instance, time), 3D np.ndarray (instance, variable, time), Series 类型 pd.DataFrame 的 list

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

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

y可选，sktime 兼容数据格式的数据，default=None

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

self估计器的已拟合实例

返回:

fit_transform(X, y=None)

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

拟合数据，然后转换数据。

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

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

写入自身

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

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

要拟合转换的数据以及要转换的数据。

参数:

要拟合转换的数据。

X 的转换版本

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

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

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

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

y可选，sktime 兼容数据格式的数据，default=None

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

self估计器的已拟合实例

返回:

类型取决于 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，

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

classmethod get_class_tag(tag_name, tag_value_default=None)

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

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

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

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

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

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

2. 按照继承顺序。

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

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

tag_namestr

参数:

标签值的名称。

tag_value_default任何类型

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

tag_value

返回:

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

classmethod get_class_tags()

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

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

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

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

2. 按照继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()

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

获取自身的配置标志。

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

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

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

config_dictdict

返回:

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

get_fitted_params(deep=True)

所需状态

获取已拟合的参数。

需要状态为“已拟合”。

deepbool, default=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()

获取对象的参数默认值。

default_dict: dict[str, Any]

返回:

键是 cls 的所有在 __init__ 中定义了默认值的参数。值是默认值，如 __init__ 中所定义。

classmethod get_param_names(sort=True)

获取对象的参数名称。

sortbool, default=True

参数:

是否按字母顺序排序返回参数名称 (True)，还是按它们在类的 __init__ 中出现的顺序返回 (False)。

param_names: list[str]

返回:

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

get_params(deep=True)

是否返回组件的参数。

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

参数:

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

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

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

• params键为 str 的字典

返回:

参数字典，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)

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

从实例获取标签值，继承标签级别并进行覆盖。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

1. 在实例构造时。

要检索的标签名称

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

3. 按照继承顺序。

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

参数:

标签值的名称。

tag_value_defaultany type, optional; 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()

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

从实例获取标签，继承标签级别并进行覆盖。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

collected_tagsdict

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

1. 在实例构造时。

要检索的标签名称

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

3. 按照继承顺序。

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

返回:

收集的标签字典

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

inverse_transform(X, y=None)

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

目前假设只有具有以下标签的变换器

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

具有 `inverse_transform` 方法。

需要状态为“已拟合”。

deepbool, default=True

self 访问的属性/方法

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

• self.is_fitted，必须为 True

参数:

要拟合转换的数据。

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

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

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

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

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

y可选，sktime 兼容数据格式的数据，default=None

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

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

返回:

X 的逆变换版本

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

is_composite()

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

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

返回:

复合：布尔值

对象是否包含任何参数，其值为 BaseObject 的后代实例。

属性 is_fitted

是否已调用 fit。

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

返回:

布尔值

估计器是否已 fit。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回:

反序列化的 self，其输出在 path 处，即 cls.save(path) 的输出

类方法 load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第 1 个元素

返回:

反序列化的 self，其输出为 serial，即 cls.save(None) 的输出

reset()

将对象重置为干净的初始化后状态。

将 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')

将序列化的自身保存到类字节对象或 (.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 类属性收集，然后通过 _onfig_dynamic 对象属性收集任何覆盖和新标签。

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

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

jupyter kernel 如何显示 self 的实例

• “diagram” = html 框图表示

• “text” = 字符串输出

print_changed_only布尔值，默认值=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:params字典，可选，默认值={}（不传递任何参数）

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

• “None”：无附加参数，backend_params 参数将被忽略

• “loky”、“multiprocessing”和“threading”：默认 joblib 后端，任何对 joblib.Parallel 有效的键都可以在此处传递，例如 n_jobs，但 backend 除外，它直接由 `backend:parallel` 参数控制。如果未传递 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对 self 的引用。

备注

更改对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)

设置此对象的参数。

此方法适用于简单的 skbase 对象和复合对象。对于复合对象（即包含其他对象的对象），可以使用参数键字符串 <component>__<parameter>，以访问组件 <component> 中的 <parameter>。字符串 <parameter>（不带 <component>__ 前缀）也可以使用，如果这样能使引用明确，例如，没有两个组件参数具有相同的名称 <parameter>。

参数:

**params字典

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

返回:

self对 self 的引用（设置参数后）

set_random_state(random_state=None, deep=True, self_policy='copy')

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证已设置种子的随机生成器的伪随机独立性。

适用于 self 中的 random_state 参数，取决于 self_policy，以及剩余的组件对象，当且仅当 deep=True 时。

注意：即使 self 没有 random_state 参数，或者没有任何组件有 random_state 参数，此方法也会调用 set_params。因此，set_random_state 将重置任何 `scikit-base` 对象，即使是那些没有 random_state 参数的对象。

参数:

random_stateint，RandomState 实例 或 None，默认值=None

伪随机数生成器，用于控制随机整数的生成。传递 int 以在多次函数调用中获得可重现的输出。

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

是否设置值为 skbase 对象的参数的 random state，即，组件估计器。

• 如果为 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，

该 state 从输入的 random_state 派生，通常与输入的 state 不同

返回:

self对 self 的引用

set_tags(**tag_dict)

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

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

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

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

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

estimator:class:BaseObject 或派生类的实例

参数:

**tag_dict字典

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

返回:

返回自身

对 self 的引用。

transform(X, y=None)

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

需要状态为“已拟合”。

deepbool, default=True

self 访问的属性/方法

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

• self.is_fitted，必须为 True

参数:

要拟合转换的数据。

要变换的数据。

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

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

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

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

y可选，sktime 兼容数据格式的数据，default=None

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

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

返回:

类型取决于 X 的类型和 scitype:transform-output 标签

X | tf-output | 返回类型 |

	transform
X	-输出	返回类型
Series	Primitives	pd.DataFrame (1行)
Panel	Primitives	pd.DataFrame
Series	Series	Series
Panel	Series	Panel
Series	Panel	Panel

表中未列出的组合目前不受支持

具体示例

如果 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，

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

classmethod get_class_tag(tag_name, tag_value_default=None)

update(X, y=None, update_params=True)

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

需要状态为“已拟合”。

deepbool, default=True

self 访问的属性/方法

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

• self.is_fitted，必须为 True

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 查看。

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

• 如果 remember_data 标签为 True，则写入 self._X，该值通过 X 中的值进行更新，通过调用 update_data 方法。

参数:

要拟合转换的数据。

用于更新变换的数据

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

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

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

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

y可选，sktime 兼容数据格式的数据，default=None

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

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

返回:

fit_transform(X, y=None)