ScaledLogitTransformer#

class ScaledLogitTransformer(lower_bound=None, upper_bound=None)[source]#

缩放 Logit 转换或对数转换。

如果 lower_bound 和 upper_bound 都不是 None，则对数据应用缩放 Logit 转换。否则，应用的转换是对数转换的一种变体，它确保逆转换得到的值相应地被限制在范围内。该转换应用于输入数组的每个标量元素。

与 sktime.forecasting.compose.TransformedTargetForecaster 结合使用时，它可以确保预测值保持在指定的界限（lower_bound, upper_bound）之间。

默认值是 lower_bound = upper_bound = None，即恒等转换。

当 lower_bound = 0，upper_bound = None 时，获得对数转换。

参数:

lower_bound浮点数, 可选, 默认=None: 逆转换函数的下界
upper_bound浮点数, 可选, 默认=None: 逆转换函数的上界

属性:

is_fitted: 是否已调用 fit。

另请参阅

sktime.transformations.series.boxcox.LogTransformer: 使用自然对数转换输入数据。可以帮助规范化数据并压缩序列的方差。
sktime.transformations.series.boxcox.BoxCoxTransformer: 应用 Box-Cox 幂转换。可以帮助规范化数据并压缩序列的方差。
sktime.transformations.series.exponent.ExponentTransformer: 通过将其提高到指数来转换输入数据。如果提供了分数指数，可以帮助压缩序列的方差。
sktime.transformations.series.exponent.SqrtTransformer: 通过取其平方根来转换输入数据。可以帮助压缩输入序列的方差。

注意事项

当 upper_bound 和 lower_bound 都不是 None 时，应用缩放 logit 转换

not None

\(log(\frac{x - a}{b - x})\)，其中 a 是下界，b 是上界。

如果 upper_bound 是 None 且 lower_bound 不是 None，则应用的转换是

形式为

\(log(x - a)\)

如果 lower_bound 是 None 且 upper_bound 不是 None，则应用的转换是

形式为

\(- log(b - x)\)

参考资料

[1]

Hyndsight - 在限制范围内预测：https://robjhyndman.com/hyndsight/forecasting-within-limits/

[2]

Hyndman, R.J., & Athanasopoulos, G. (2021) Forecasting: principles and practice, 3rd edition, OTexts: Melbourne, Australia. OTexts.com/fpp3。访问日期：2022年1月24日。

示例

>>> import numpy as np
>>> from sktime.datasets import load_airline
>>> from sktime.transformations.series.scaledlogit import ScaledLogitTransformer
>>> from sktime.forecasting.trend import PolynomialTrendForecaster
>>> from sktime.forecasting.compose import TransformedTargetForecaster
>>> y = load_airline()
>>> fcaster = TransformedTargetForecaster([
...     ("scaled_logit", ScaledLogitTransformer(0, 650)),
...     ("poly", PolynomialTrendForecaster(degree=2))
... ])
>>> fcaster.fit(y)
TransformedTargetForecaster(...)
>>> y_pred = fcaster.predict(fh = np.arange(32))

方法

`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_set字符串, 可选, 默认=”default”: 返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。

返回值:

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

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

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_names字符串或字符串列表, 默认 = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回值:

self: 对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

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

参数:

parameter_set字符串, 可选, 默认=”default”: 返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。

返回值:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例的列表及其名称列表。

参数:

parameter_set字符串, 可选, 默认=”default”: 返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 “default” 集。

返回值:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
names字符串列表, 与 objs 等长: 第 i 个元素是测试中 objs 的第 i 个实例的名称。命名约定是，如果实例多于一个，则为 {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 科学类型 = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)。
Panel 科学类型 = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list。
Hierarchical 科学类型 = 时间序列的分层集合。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 的转换版本。

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

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

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

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

参数:

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

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

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

Series 科学类型 = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)。
Panel 科学类型 = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list。
Hierarchical 科学类型 = 时间序列的分层集合。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 | 返回类型 |

|----------|————–|------------------------| | 序列 | 基本类型 | 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 个窗口。

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

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

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

按继承顺序。

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

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

参数:

tag_name字符串: 标签值的名称。
tag_value_default任意类型: 如果未找到标签的默认/备用值。

返回值:

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

classmethod get_class_tags()[source]#

从类中获取类标签，包含来自父类的标签级别继承。

每个兼容 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()[source]#

获取自身的配置标志。

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

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

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

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

返回值:

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态: 要求状态为“fitted”。

参数:

deepbool, default=True

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

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

返回值:

fitted_paramsdict with str-valued keys

拟合参数的字典，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, default=True: 是否按字母顺序排序返回参数名称 (True)，或按它们在类 __init__ 中出现的顺序返回 (False)。

返回值:

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

get_params(deep=True)[source]#

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

参数:

deepbool, default=True

是否返回组件的参数。

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

返回值:

paramsdict with str-valued keys

参数字典，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 的单个标签的值，并考虑标签覆盖，按以下优先级从高到低排序：

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

在实例构建时设置的标签。

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

按继承顺序。

参数:

tag_name字符串: 要检索的标签名称
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 设置的标签。

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

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

在实例构建时设置的标签。

在类的 _tags 属性中设置的标签。
在父类的 _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 科学类型 = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)。
Panel 科学类型 = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list。
Hierarchical 科学类型 = 时间序列的分层集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

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

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

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

返回值:

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

is_composite()[source]#

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

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

返回值:

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 调用会删除任何对象属性，除了

超参数 = 写入 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，则返回内存中的序列化 self；如果 path 是文件位置，则将 self 作为 zip 文件存储在该位置

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

参数:

pathNone 或文件位置 (str 或 Path)

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

如果 path=”estimator”，则将在当前工作目录创建一个 estimator.zip 的 zip 文件。
如果 path=”/home/stored/estimator”，则将在 /home/stored/ 中创建一个 estimator.zip 的 zip 文件。

存储。

serialization_format: str, default = “pickle”

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

返回值:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - ZipFile，带有对文件的引用

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool, default=True

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

warningsstr, “on” (默认), 或 “off”

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

“on” = 将引发 sktime 发出的警告
“off” = 不会引发 sktime 发出的警告

backend:parallelstr, 可选, default=”None”

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

“None”：顺序执行循环，简单的列表推导式
“loky”, “multiprocessing” 和 “threading”：使用 joblib.Parallel
“joblib”：自定义和第三方 joblib 后端，例如 spark
“dask”：使用 dask，需要环境中安装 dask 包
“ray”：使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict, 可选, default={} (未传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于 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)[source]#

设置此对象的参数。

该方法适用于简单的 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')[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, default=None

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

deepbool, default=True

是否在 skbase 对象类型参数（即组件估计器）中设置随机状态。

如果为 False，则仅设置 self 的 random_state 参数（如果存在）。
如果为 True，也会在组件对象中设置 random_state 参数。

self_policystr, {“copy”, “keep”, “new”} 之一, default=”copy”

“copy” : self.random_state 被设置为输入的 random_state
“keep” : self.random_state 保持原样
“new” : self.random_state 被设置为一个新的随机状态，

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

返回值:

self对 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 科学类型 = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)。
Panel 科学类型 = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list。
Hierarchical 科学类型 = 时间序列的分层集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

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

写入自身

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

如果 remember_data 标签为 True，则通过 update_data 将 X 中的值写入 self._X 进行更新。

参数:

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

用于更新转换的数据

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

Series 科学类型 = 单个时间序列。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)。
Panel 科学类型 = 时间序列集合。pd.DataFrame 带有 2 级行 MultiIndex (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型的 pd.DataFrame list。
Hierarchical 科学类型 = 时间序列的分层集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)。

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

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

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

返回值:

self估计器的已拟合实例