ColumnSelect#

class ColumnSelect(columns=None, integer_treatment='col', index_treatment='remove')[source]#

列选择转换器。

在 transform 中，将 X 子集到作为超参数提供的 columns。

Xt=transform(X) 中的列顺序与 columns 超参数中的顺序相同。注意：这意味着 transform 可能会改变列的顺序，

即使在 transform(X) 中没有从 X 中删除列。

参数:
columnspandas 兼容的索引或可强制转换为索引的类型，可选，默认为 None

在 transform 中将 X 子集到的列

integer_treatmentstr，可选，为“col”（默认）和“coerce”之一

确定如何处理整数索引列 “col” = 通过列 iloc 索引子集，即使 columns 不在 X.columns 中 “coerce” = 强制转换为整数 pandas.Index 并尝试子集

index_treatmentstr，可选，为“remove”（默认）或“keep”之一

确定在 Xt = transform(X, y) 中保留哪些列 “remove” = 只有同时出现在 X 和 columns 中的索引才会出现在 Xt 中。 “keep” = columns 中的所有索引都会出现在 Xt 中。如果 X 中不存在，则填充 NA。

属性:
is_fitted

是否已调用 fit。

示例

>>> from sktime.transformations.series.subset import ColumnSelect
>>> from sktime.datasets import load_longley
>>> X = load_longley()[1]
>>> transformer =  ColumnSelect(columns=["GNPDEFL", "POP", "FOO"])
>>> X_subset = transformer.fit_transform(X=X)

方法

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 列表，默认为 {}

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

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

标签是实例 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 的引用。

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。

状态改变

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

写入自身

  • 设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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 (1D 或 2D)

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

  • Hierarchical scitype = 分层时间序列集合。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，X 的强制副本，如果 remember_data 标签为 True

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

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

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

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

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

  • Hierarchical scitype = 分层时间序列集合。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 | 返回类型 |

|----------|————–|------------------------| | 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 实例）。示例：panel 中的所有时间序列都单独进行去趋势

  • 如果 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]#

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

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

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

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

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

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

按继承顺序排列。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签，则为默认/回退值。

返回:
tag_value

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

classmethod get_class_tags()[source]#

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

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

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

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

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

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

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

  2. 在父类 _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 类属性收集，然后收集来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool，默认为 True

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

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

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

返回:
fitted_params带有 str 值键的 dict

已拟合参数的字典，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，默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool，默认为 True

是否返回组件的参数。

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

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

返回:
params带有 str 值键的 dict

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

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

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

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

tag_value_default任何类型，可选；默认为 None

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

raise_error布尔值

未找到标签时是否引发 ValueError

返回:
tag_value任何类型

`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 设置的标签的键。

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

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

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

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

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

按继承顺序排列。

返回:
collected_tags字典

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

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

逆转换 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 (1D 或 2D)

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

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

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

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

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

返回:
X 的逆转换版本

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

is_composite()[source]#

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

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

返回:
composite:布尔值

对象是否包含任何参数，其值是 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]#

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

参数:
serial`cls.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))`` 后获得的对象相等。

返回:
自身

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

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”，则将在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

  • path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将被

存储在 /home/stored/ 中。

serialization_format:字符串，默认为 “pickle”

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

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

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

参数:
config_dictdict

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

display字符串，“diagram”（默认）或“text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 True

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

warnings字符串，“on”（默认）或“off”

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

  • “on” = 将引发来自 sktime 的警告

  • “off” = 不会引发来自 sktime 的警告

backend:parallel字符串，可选，默认为“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”：字符串，默认为“ray”；要使用的日志记录器名称。

    • “mute_warnings”：布尔值，默认为 False；如果为 True，则禁止显示警告

input_conversion字符串，“on”（默认）、“off”或有效的 mtype 字符串之一

控制 _fit、_transform、_inverse_transform、_update 的输入检查和转换

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前，不执行输入检查和转换

  • 有效的 mtype 字符串 - 假定输入为指定的 mtype，执行转换但不进行检查

output_conversion字符串，“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>。

参数:
\*\*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 参数。

参数:
random_stateint，RandomState 实例或 None，默认为 None

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

deepbool，默认为 True

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

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policy字符串，{“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 检查。

参数:
\*\*tag_dict字典

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

返回:
返回值

对 self 的引用。

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

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

所需状态

要求状态为“已拟合”。

self 中访问的属性

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

  • self.is_fitted，必须为 True

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

要转换的数据。

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

  • Hierarchical scitype = 分层时间序列集合。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 实例）。示例：panel 中的所有时间序列都单独进行去趋势

  • 如果 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。

所需状态

要求状态为“已拟合”。

self 中访问的属性

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

  • self.is_fitted，必须为 True

写入自身

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

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

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

用于更新转换的数据

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 实现一个抽象的 scitype。

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

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

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

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

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

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

返回:
self估计器的已拟合实例