HOG1DTransformer (一维梯度直方图变换器)#

class HOG1DTransformer(num_intervals=2, num_bins=8, scaling_factor=0.1)[source]#

HOG1D transform (HOG1D变换)。

This class is to calculate the HOG1D transform of a dataframe of time series data. Works by splitting the time series num_intervals times, and calculate a histogram of gradients within each interval. (此类用于计算时间序列数据的dataframe的HOG1D变换。其工作原理是将时间序列分割num_intervals次，并在每个区间内计算梯度直方图。)

Parameters: (参数：)

num_intervalsint, default=2 (num_intervalsint, 默认值=2): length of interval. (区间长度。)
num_binsint, default=8 (num_binsint, 默认值=8): num bins in the histogram. (直方图中的 bin 数量。)
scaling_factorfloat, default=0.1 (scaling_factorfloat, 默认值=0.1): a constant that is multiplied to modify the distribution. (一个用于修改分布的乘法常数。)

Attributes: (属性：)

is_fitted (是否已拟合): Whether fit has been called. (fit 方法是否已被调用。)

Examples (示例)

>>> from sktime.transformations.panel.hog1d import HOG1DTransformer
>>> from sktime.datasets import load_arrow_head
>>>
>>> X, y = load_arrow_head(return_X_y=True)
>>>
>>> # Initialize the transformer
>>> hog1d_transformer = HOG1DTransformer(
...     num_intervals=5, num_bins=8, scaling_factor=0.1
... )
>>>
>>> # Transform the data
>>> Xt = hog1d_transformer.fit_transform(X)

Methods (方法)

`check_is_fitted`([method_name]) (检查是否已拟合)	Check if the estimator has been fitted. (检查估计器是否已经拟合。)
`clone (克隆)`()	Obtain a clone of the object with same hyper-parameters and config. (获取一个具有相同超参数和配置的对象克隆。)
`clone_tags`(estimator[, tag_names]) (克隆标签)	Clone tags from another object as dynamic override. (从另一个对象克隆标签作为动态覆盖。)
`create_test_instance`([parameter_set]) (创建测试实例)	Construct an instance of the class, using first test parameter set. (使用第一个测试参数集构造类的实例。)
`create_test_instances_and_names`([parameter_set]) (创建测试实例和名称)	Create list of all test instances and a list of names for them. (创建所有测试实例列表及其名称列表。)
`fit`(X[, y]) (拟合)	Fit transformer to X, optionally to y. (将变换器拟合到 X，可选地拟合到 y。)
`fit_transform`(X[, y]) (拟合并变换)	Fit to data, then transform it. (拟合数据，然后对其进行变换。)
`get_class_tag`(tag_name[, tag_value_default]) (获取类标签)	Get class tag value from class, with tag level inheritance from parents. (从类中获取类标签值，并从父类继承标签级别。)
`get_class_tags (获取类标签)`()	Get class tags from class, with tag level inheritance from parent classes. (从类中获取类标签，并从父类继承标签级别。)
`get_config (获取配置)`()	Get config flags for self. (获取对象的配置标志。)
`get_fitted_params`([deep]) (获取已拟合参数)	Get fitted parameters. (获取已拟合的参数。)
`get_param_defaults (获取默认参数值)`()	Get object's parameter defaults. (获取对象的默认参数值。)
`get_param_names`([sort]) (获取参数名称)	Get object's parameter names. (获取对象的参数名称。)
`get_params`([deep]) (获取参数)	Get a dict of parameters values for this object. (获取此对象的参数值字典。)
`get_tag`(tag_name[, tag_value_default, ...]) (获取标签)	Get tag value from instance, with tag level inheritance and overrides. (从实例获取标签值，包括标签级别的继承和覆盖。)
`get_tags (获取标签)`()	Get tags from instance, with tag level inheritance and overrides. (从实例获取标签，包括标签级别的继承和覆盖。)
`get_test_params`([parameter_set]) (获取测试参数)	Return testing parameter settings for the estimator. (返回估计器的测试参数设置。)
`inverse_transform`(X[, y]) (逆变换)	Inverse transform X and return an inverse transformed version. (对 X 进行逆变换并返回逆变换后的版本。)
`Currently it is assumed that only transformers with tags (目前假定只有具有以下标签的变换器才支持逆变换：)`()	“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”, (“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,)
have an inverse_transform. (支持逆变换。)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`重置`()	将对象重置为初始化后的干净状态。
`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]#

Return testing parameter settings for the estimator. (返回估计器的测试参数设置。)

Parameters: (参数：)

parameter_setstr, 默认值=”default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 "default" 集。

返回:

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

check_is_fitted(method_name=None)[source]#

Check if the estimator has been fitted. (检查估计器是否已经拟合。)

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

如果不是，则会引发 NotFittedError。

Parameters: (参数：)

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

引发:

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

clone()[source]#

Obtain a clone of the object with same hyper-parameters and config. (获取一个具有相同超参数和配置的对象克隆。)

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

等同于使用 self 的参数构造一个新的 type(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]#

Clone tags from another object as dynamic override. (从另一个对象克隆标签作为动态覆盖。)

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

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

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

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

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

tag_names 的默认行为是将 estimator 中的所有标签写入 self。

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

Parameters: (参数：)

estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表，默认值 = None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

自身 (self): 对 self 的引用。

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

Construct an instance of the class, using first test parameter set. (使用第一个测试参数集构造类的实例。)

Parameters: (参数：)

parameter_setstr, 默认值=”default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:

instance具有默认参数的类实例

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

Create list of all test instances and a list of names for them. (创建所有测试实例列表及其名称列表。)

Parameters: (参数：)

parameter_setstr, 默认值=”default”: 要返回的测试参数集的名称，用于测试。如果某个值没有定义特殊参数，将返回 “default” 集。

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
namesstr 列表，与 objs 长度相同: 第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}。

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

Fit transformer to X, optionally to y. (将变换器拟合到 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")。

Parameters: (参数：)

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

用于拟合和转换的数据。

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

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

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

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

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

返回:

self估计器的已拟合实例

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

Fit to data, then transform it. (拟合数据，然后对其进行变换。)

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

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

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

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

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

Parameters: (参数：)

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

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

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

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

有关数据格式的更多详细信息，请参阅 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，则返回是行数与 X 中实例数相同的 pd.DataFrame。示例：返回的第 i 行包含第 i 个序列的均值和方差

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

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

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

Get class tag value from class, with tag level inheritance from parents. (从类中获取类标签值，并从父类继承标签级别。)

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

通过 get_class_tag 方法（一个类方法），仅考虑类级别标签值和覆盖来检索标签的值。

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

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

按继承顺序。

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

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

Parameters: (参数：)

tag_namestr: 标签值的名称。
tag_value_default任意类型: 如果未找到标签，则使用的默认/备用值。

返回:

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

classmethod get_class_tags()[source]#

Get class tags from class, with tag level inheritance from parent classes. (从类中获取类标签，并从父类继承标签级别。)

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

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

通过 get_class_tags 方法（一个类方法），仅考虑类级别标签值和覆盖来检索标签的值。

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

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

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

按继承顺序。

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

要检索可能带有实例覆盖的标签，请改用 get_tags 方法。

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

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

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

get_config()[source]#

Get config flags for self. (获取对象的配置标志。)

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

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

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

Configs 在 clone 或 reset 调用中保留。

返回:

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

get_fitted_params(deep=True)[source]#

Get fitted parameters. (获取已拟合的参数。)

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

Parameters: (参数：)

deep布尔值，默认值=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]#

获取对象的参数名称。

Parameters: (参数：)

sort布尔值，默认值=True: 是按字母顺序返回参数名称 (True)，还是按它们在类 __init__ 中出现的顺序返回 (False)。

返回:

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

get_params(deep=True)[source]#

Get a dict of parameters values for this object. (获取此对象的参数值字典。)

Parameters: (参数：)

deep布尔值，默认值=True

是否返回组件的参数。

如果为 True，将返回此对象的参数名：值字典，包括组件（即值为 BaseObject 的参数）的参数。
如果为 False，将返回此对象的参数名：值字典，但不包括组件的参数。

返回:

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

Get tag value from instance, with tag level inheritance and overrides. (从实例获取标签值，包括标签级别的继承和覆盖。)

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

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

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

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

在实例构造时设置。

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

按继承顺序。

Parameters: (参数：)

tag_namestr: 要检索的标签名称
tag_value_default任意类型，可选；默认值=None: 如果未找到标签，则使用的默认/备用值
raise_error布尔值: 未找到标签时是否引发 ValueError

返回:

tag_value任意类型: self 中 tag_name 标签的值。如果未找到，如果 raise_error 为 True，则引发错误，否则返回 tag_value_default。

引发:

如果 raise_error 为 True，则引发 ValueError。: 如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

Get tags from instance, with tag level inheritance and overrides. (从实例获取标签，包括标签级别的继承和覆盖。)

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

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

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

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

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

在实例构造时设置。

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

按继承顺序。

返回:

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

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

Inverse transform X and return an inverse transformed version. (对 X 进行逆变换并返回逆变换后的版本。)

目前假设只有具有以下标签的转换器: “scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,

具有 inverse_transform 方法。

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

Accesses in self (访问自身属性)

Fitted model attributes ending in “_”. (以“_”结尾的已拟合模型属性。)

self.is_fitted, must be True (self.is_fitted，必须为 True。)

Parameters: (参数：)

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

用于拟合和转换的数据。

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

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

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

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

Additional data, e.g., labels for transformation. Some transformers require this, see class docstring for details. (附加数据，例如用于变换的标签。某些变换器需要此项，详见类文档字符串。)

返回:

inverse transformed version of X (X 的逆变换版本): of the same type as X, and conforming to mtype format specifications (与 X 类型相同，并符合 mtype 格式规范)

is_composite()[source]# (方法：是否为复合对象)

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

A composite object is an object which contains objects, as parameters. Called on an instance, since this may differ by instance. (复合对象是指包含其他对象作为参数的对象。在实例上调用，因为这可能因实例而异。)

返回:

composite: bool (composite: bool): Whether an object has any parameters whose values are BaseObject descendant instances. (对象是否有任何参数的值是 BaseObject 的后代实例。)

property is_fitted[source]# (属性：是否已拟合)

Whether fit has been called. (fit 方法是否已被调用。)

Inspects object’s _is_fitted` attribute that should initialize to ``False during object construction, and be set to True in calls to an object’s fit method. (检查对象的 _is_fitted` 属性，该属性在对象构造期间应初始化为 ``False，并在调用对象的 fit 方法时设置为 True。)

返回:

bool (bool): Whether the estimator has been fit. (估计器是否已 fit。)

classmethod load_from_path(serial)[source]# (类方法：从路径加载)

从文件位置加载对象。

Parameters: (参数：)

serialresult of ZipFile(path).open(“object) (serialZipFile(path).open(“object) 的结果)

返回:

deserialized self resulting in output at path, of cls.save(path) (反序列化后的 self，产生在 path 的输出，与 cls.save(path) 相同。)

classmethod load_from_serial(serial)[source]# (类方法：从序列化对象加载)

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

Parameters: (参数：)

serial1st element of output of cls.save(None) (serialcls.save(None) 输出的第一个元素)

返回:

deserialized self resulting in output serial, of cls.save(None) (反序列化后的 self，产生输出 serial，与 cls.save(None) 相同。)

reset()[source]# (方法：重置)

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

Results in setting self to the state it had directly after the constructor call, with the same hyper-parameters. Config values set by set_config are also retained. (将 self 设置为构造函数调用后直接所处的状态，并保留相同的超参数。set_config 设置的配置值也予以保留。)

A reset call deletes any object attributes, except (一个 reset 调用会删除所有对象属性，除了)

hyper-parameters = arguments of __init__ written to self, e.g., self.paramname where paramname is an argument of __init__ (超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的参数。)
object attributes containing double-underscores, i.e., the string “__”. For instance, an attribute named “__myattr” is retained. (包含双下划线（即字符串“__”）的对象属性。例如，名为“__myattr”的属性会保留。)
config attributes, configs are retained without change. That is, results of get_config before and after reset are equal. (配置属性，配置保持不变。也就是说，在 reset 之前和之后 get_config 的结果相等。)

Class and object methods, and class attributes are also unaffected. (类和对象方法以及类属性也不受影响。)

Equivalent to clone, with the exception that reset mutates self instead of returning a new object. (等同于 clone，不同之处在于 reset 修改 self 而不是返回一个新对象。)

After a self.reset() call, self is equal in value and state, to the object obtained after a constructor call``type(self)(**self.get_params(deep=False))``. (在调用 self.reset() 后，self 在值和状态上与构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获取的对象相等。)

返回:

自身 (self): Instance of class reset to a clean post-init state but retaining the current hyper-parameter values. (类实例重置为干净的初始化后状态，但保留当前的超参数值。)

save(path=None, serialization_format='pickle')[source]#

将序列化的对象自身保存到字节类对象或 (.zip) 文件中。

行为：如果 path 为 None，则返回内存中的序列化对象自身。如果 path 是文件位置，则将对象自身作为 zip 文件存储在该位置

保存的文件是包含以下内容的 zip 文件：_metadata - 包含对象自身的类，即 type(self)。_obj - 序列化的对象自身。此类使用默认序列化方法 (pickle)。

Parameters: (参数：)

pathNone 或文件位置 (str 或 Path)

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

path=”estimator”，则会在当前工作目录 (cwd) 下生成一个 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]#

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

Parameters: (参数：)

config_dict字典

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

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

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

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

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

作为配置传递给并行化后端的附加参数。有效键取决于 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”: 布尔值，默认值=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)[source]#

设置此对象的参数。

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

Parameters: (参数：)

**params字典: 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 参数的对象。

Parameters: (参数：)

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

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

deep布尔值，默认值=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)[source]#

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

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

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

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

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

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

Parameters: (参数：)

**tag_dict字典: 标签名：标签值对的字典。

返回:

自身 (Self): 对 self 的引用。

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

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

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

Accesses in self (访问自身属性)

Fitted model attributes ending in “_”. (以“_”结尾的已拟合模型属性。)

self.is_fitted, must be True (self.is_fitted，必须为 True。)

Parameters: (参数：)

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

要转换的数据。

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

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

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

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

Additional data, e.g., labels for transformation. Some transformers require this, see class docstring for details. (附加数据，例如用于变换的标签。某些变换器需要此项，详见类文档字符串。)

返回:

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，则返回是行数与 X 中实例数相同的 pd.DataFrame。示例：返回的第 i 行包含第 i 个序列的均值和方差

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

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

update(X, y=None, update_params=True)[source]#

使用 X（可选地包括 y）更新转换器。

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

Accesses in self (访问自身属性)

Fitted model attributes ending in “_”. (以“_”结尾的已拟合模型属性。)

self.is_fitted, must be True (self.is_fitted，必须为 True。)

写入自身 (self)

Fitted model attributes ending in “_”. (以“_”结尾的已拟合模型属性。)

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

Parameters: (参数：)

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

用于更新转换的数据

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

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

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

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

Additional data, e.g., labels for transformation. Some transformers require this, see class docstring for details. (附加数据，例如用于变换的标签。某些变换器需要此项，详见类文档字符串。)

返回:

self估计器的已拟合实例