国家假日变换器#

class CountryHolidaysTransformer(country, subdiv=None, years=None, expand=True, observed=True, categories=None, name=None)[source]#

国家假日变换器。

此实现封装了 vacanza 的 holidays [1] 库。

根据 X 的索引，提取日期并传递给 holidays 库。然后根据传入的国家（和细分区域）信息生成该日期的假日信息（或无信息），准备一个布尔序列，其中 True 表示该日期是假日，False 表示不是。对于此变换器，fit 操作为空。

参数:

countrystr: ISO 3166-1 Alpha-2 国家代码。[2]
subdivstr, 可选: 细分区域（例如州或省）；并非所有国家都已实现（请参阅文档 [3]）。[2]
yearsUnion[int, Iterable[int]], 可选: 在实例化时预计算公共假日的年份。
expandbool, 可选: 当请求该年份的一个日期时，是否计算整个年份的假日。
observedbool, 可选: 是否包含公共假日实际休息的日期（例如，假日落在周日则在下周一休息）。对于所有国家，False 可能无效。
categoriesTuple[str], 可选: 请求的假日类别。
namestr, 可选: 变换后序列的名称。

属性:

is_fitted: 是否已调用 fit 方法。

注意

如果 name 缺失（默认情况下），则使用 country 和 subdiv 自动填充为 {country}_holidays 或 {country}_{subdiv}_holidays。

参考

[1]

vacanza/python-holidays

[2] (1,2)

https://www.iso.org/obp/ui/#search/code/

[3]

https://python-holidays.readthedocs.io/en/stable/#available-countries

示例

>>> from sktime.transformations.series.holiday import CountryHolidaysTransformer
>>>
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>>
>>> y_t = CountryHolidaysTransformer("US").fit_transform(y)  
>>> y_t.dtype  
dtype('bool')
>>> y_t.sum()  
14
>>> y_t.name  
'US_holidays'

方法

`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`()	检查对象是否由其他 BaseObject 组成。
`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 列表, 默认值 = {}: 创建类测试实例的参数

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

未拟合错误: 如果评估器尚未拟合。

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 个元素是测试中 obj 的第 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")。

参数:

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

用于拟合变换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或 2维)
Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time), 3维 np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 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)[来源]#

拟合数据，然后变换它。

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

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

写入 self：_is_fitted：标记设置为 True。_X：X，X 的强制副本，如果 remember_data 标记为 True

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

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

参数:

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

用于拟合转换的数据和要转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或 2维)
Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time), 3维 np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 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)[来源]#

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

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

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

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

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

按继承顺序。

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

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

参数:

tag_namestr: 标签值的名称。
tag_value_default任意类型: 未找到标签时的默认/回退值。

返回:

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

classmethod get_class_tags()[来源]#

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

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

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

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

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

值是相应的标签值，并具有以下优先级顺序的覆盖，按降序排列

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

按继承顺序。

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

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

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

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

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，默认为 True

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

如果为 True，将返回此对象的参数名称：值字典，包括可拟合组件 (= BaseEstimator 值参数) 的拟合参数。
如果为 False，将返回此对象的参数名称：值字典，但不包括组件的拟合参数。

返回:

fitted_params键为 str 的 dict

拟合参数字典，键-值对为 paramname : paramvalue 包括

始终：此对象的所有拟合参数，如通过 get_param_names 获得的值是此对象的该键的拟合参数值
如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [组件名称]__[参数名称]。组件名称的所有参数都以参数名称及其值出现
如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

classmethod get_param_defaults()[来源]#

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]: 键是 cls 的所有参数，这些参数在 __init__ 中定义了默认值。值是默认值，如 __init__ 中所定义。

classmethod get_param_names(sort=True)[来源]#

获取对象的参数名称。

参数:

sortbool，默认为 True: 是否按字母顺序 (True) 或在类 __init__ 中出现的顺序 (False) 返回参数名称。

返回:

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

get_params(deep=True)[来源]#

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

参数:

deepbool，默认为 True

是否返回组件的参数。

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

返回:

params键为 str 的 dict

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

始终：此对象的所有参数，如通过 get_param_names 获得的值是此对象的该键的参数值，值始终与构造时传递的值相同
如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [组件名称]__[参数名称]。组件名称的所有参数都以参数名称及其值出现
如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[组件组件名称]__[参数名称] 等

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

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

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

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

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

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

在实例构造时。

在类的 _tags 属性中设置的标签。
在父类的 _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()[来源]#

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

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

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

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

值是相应的标签值，并具有以下优先级顺序的覆盖，按降序排列

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

在实例构造时。

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

按继承顺序。

返回:

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

inverse_transform(X, y=None)[来源]#

对 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 (1维或 2维)
Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time), 3维 np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

额外数据，例如转换的标签。某些转换器需要此数据，详细信息请参见类文档字符串。

返回:

X 的逆变换版本: 类型与 X 相同，并且符合 mtype 格式规范

is_composite()[来源]#

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

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

返回:

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

property is_fitted[来源]#

是否已调用 fit 方法。

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

返回:

bool: 估计器是否已拟合。

classmethod load_from_path(serial)[来源]#

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)[来源]#

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

参数:

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

返回:

反序列化的 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"，则会

存储在 /home/stored/ 中的一个 zip 文件 estimator.zip。

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对 self 的引用。

注意

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

set_params(**params)[来源]#

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象，即包含其他对象的对象，以访问组件 <component> 中的 <parameter>。如果引用明确，例如没有两个组件参数的名称为 <parameter>，也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**paramsdict: 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_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对 self 的引用

set_tags(**tag_dict)[来源]#

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中（构造期间）或直接在 __init__ 之后调用。

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

参数:

**tag_dictdict: 标签名称：标签值对字典。

返回:

Self: 对 self 的引用。

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

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

所需状态: 要求状态为“已拟合”。

访问 self 中的内容

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

self.is_fitted，必须为 True

参数:

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

要转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或 2维)
Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time), 3维 np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详情，请参阅 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)[来源]#

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

所需状态: 要求状态为“已拟合”。

访问 self 中的内容

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

self.is_fitted，必须为 True

写入 self

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

如果 remember_data 标记为 True，则通过 update_data 写入 self._X，该属性通过 X 中的值更新。

参数:

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

用于更新转换的数据

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

Series scitype = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1维或 2维)
Panel scitype = 时间序列集合。pd.DataFrame 带 2 级行 MultiIndex (instance, time), 3维 np.ndarray (instance, variable, time), list 包含 Series 类型的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

额外数据，例如转换的标签。某些转换器需要此数据，详细信息请参见类文档字符串。

返回:

self评估器的拟合实例