Id#

class Id[source]#

恒等转换器，在 transform/inverse_transform 中返回未更改的数据。

属性：
is_fitted

是否已调用 fit。

方法

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])

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

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

set_tags(**tag_dict)

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

transform(X[, y])

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

update(X[, y, update_params])

使用 X 更新转换器，y 是可选的。
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数：
method_namestr，可选

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

抛出异常：
NotFittedError

如果估计器尚未拟合。

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 兼容的对象都有一个标签字典。标签可用于存储有关对象的元数据，或控制对象的行为。

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

The clone_tags method should be called only in the __init__ method of an object, during construction, or directly after construction via __init__.

The dynamic tags are set to the values of the tags in estimator, with the names specified in tag_names.

The default of tag_names writes all tags from estimator to self.

Current tag values can be inspected by get_tags or 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具有默认参数的类实例

self
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例列表

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

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

instance具有默认参数的类实例

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

namesstr 列表，与 objs 长度相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定是 {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 兼容数据容器格式的时间序列

参数：
用于拟合转换的数据。

Individual data formats in sktime are so-called mtype specifications, each mtype implements an abstract 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)、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估计器的拟合实例

self
fit_transform(X, y=None)[source]#
将转换器拟合到 X 和 y，并返回 X 的转换版本。

拟合数据，然后对其进行转换。

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

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

写入 self

如果可能，通过引用强制转换为内部类型或与 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)、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估计器的拟合实例

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，

  • 则返回一个 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 属性中设置的标签。

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

  2. 按继承顺序。

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

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

tag_namestr

参数：
标签值的名称。

tag_value_default任意类型

如果未找到标签，则使用默认/备用值。

tag_value

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

classmethod get_class_tags()[source]#

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

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

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

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

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

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

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

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

  2. 按继承顺序。

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

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

collected_tagsdict

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

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

get_config()[source]#

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

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

获取自身的配置标志。

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

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

config_dictdict

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

self
get_fitted_params(deep=True)[source]#

所需状态

要求状态为“fitted”（已拟合）。

获取已拟合的参数。

deepbool，默认值=True

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

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

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

  • fitted_params键为 str 类型的 dict

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

self
始终：此对象的所有拟合参数，如同通过 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__ 中定义的默认值。

self
classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

sortbool，默认值=True

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

参数：
param_names: list[str]

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

self
get_params(deep=True)[source]#

是否返回组件的参数。

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

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

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

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

  • params键为 str 类型的 dict

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

self
始终：此对象的所有参数，如同通过 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 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，优先级按以下降序排列：

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

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

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

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

在实例构建时。

  1. 要检索的标签名称

tag_value_default任意类型，可选；默认值=None

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

  2. 按继承顺序。

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

参数：
标签值的名称。

如果未找到标签，则使用默认/备用值

raise_errorbool

当未找到标签时是否抛出 ValueError

tag_valueAny

self 中 tag_name 标签的值。如果未找到，则在 raise_error 为 True 时抛出错误，否则返回 tag_value_default。

self
ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则抛出 ValueError。

抛出异常：
get_tags()[source]#

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

collected_tagsdict

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

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

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

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

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

  1. 要检索的标签名称

tag_value_default任意类型，可选；默认值=None

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

  2. 按继承顺序。

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

self
classmethod get_test_params(parameter_set='default')[source]#

get_test_params 是一个统一的接口点，用于存储用于测试目的的参数设置。此函数也用于 create_test_instance 和 create_test_instances_and_names 来构造测试实例。

get_test_params 应该返回一个 dict，或一个 dict 列表。

返回 skbase 对象的测试参数设置。

每个 dict 是一个用于测试的参数配置，可用于构造一个“有趣”的测试实例。对于 get_test_params 返回中的所有字典 params，调用 cls(**params) 都应是有效的。

get_test_params 不需要返回固定的字典列表，它也可以返回动态或随机参数设置。

paramsdict 或 dict 列表，默认值 = {}

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

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

instance具有默认参数的类实例

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

目前假设只有带有以下标签的转换器：

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

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

具有 inverse_transform。

访问 self 中的内容

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

deepbool，默认值=True

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

self.is_fitted，必须为 True

  • 附加数据，例如用于转换的标签。有些转换器需要此项，详细信息请参阅类文档字符串。

  • X 的逆转换版本

参数：
用于拟合转换的数据。

Individual data formats in sktime are so-called mtype specifications, each mtype implements an abstract 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)、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 类型相同，并符合 mtype 格式规范

self
is_composite()[source]#

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

composite: bool

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

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

self
property is_fitted[source]#

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

bool

是否已调用 fit。

估计器是否已 fit。

self
classmethod load_from_path(serial)[source]#

从文件位置加载对象。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object”) 的结果
self
对 self 进行反序列化，得到 path 处的输出，即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
self
对 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
self 的引用。

类的实例重置为干净的初始化后状态，但保留当前的超参数值。

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

将序列化后的 self 保存到类字节对象或 (.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。

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

self
如果 path 是 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#

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

参数：
get_fitted_params(deep=True)[source]#

配置名称 : 配置值 对组成的字典。下面列出了有效的配置、值及其含义

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

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印 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对 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对 self 的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为 self 设置 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 值以在多次函数调用中获得可重复的输出。

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

是否设置 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对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

self
Self

对 self 的引用。

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

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

deepbool，默认值=True

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

self.is_fitted，必须为 True

  • 附加数据，例如用于转换的标签。有些转换器需要此项，详细信息请参阅类文档字符串。

  • 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)、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 类型相同，并符合 mtype 格式规范

self
类型取决于 X 的类型和 scitype:transform-output 标签
X | tf-output | 返回类型 |

转换

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，

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

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

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

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

deepbool，默认值=True

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

self.is_fitted，必须为 True

  • 附加数据，例如用于转换的标签。有些转换器需要此项，详细信息请参阅类文档字符串。

  • X 的逆转换版本

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

  • 附加数据，例如用于转换的标签。有些转换器需要此项，详细信息请参阅类文档字符串。

  • 如果 remember_data 标签为 True，则通过 update_data 将更新后的值写入 self._X，更新内容来自 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)、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 类型相同，并符合 mtype 格式规范

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