SummaryTransformer#

class SummaryTransformer(summary_function=('mean', 'std', 'min', 'max'), quantiles=(0.1, 0.25, 0.5, 0.75, 0.9), flatten_transform_index=True)[source]#

计算时间序列的汇总值。

对于单变量时间序列，计算输入序列的汇总函数和分位数。如果输入是多变量时间序列，则对每列分别计算汇总函数和分位数。

参数:
summary_functionstr, list, tuple 或 None, 默认=(“mean”, “std”, “min”, “max”)

如果非 None，则为一个字符串、字符串列表或元组，表示用于汇总数据集每列的 pandas 汇总函数。必须是 (“mean”, “min”, “max”, “median”, “sum”, “skew”, “kurt”, “var”, “std”, “mad”, “sem”, “nunique”, “count”) 中的一个。如果为 None，则不计算汇总值，此时 quantiles 必须非 None。

quantilesstr, list, tuple 或 None, 默认=(0.1, 0.25, 0.5, 0.75, 0.9)

要计算的时间序列分位数的可选列表。如果为 None，则不计算分位数，此时 summary_function 必须非 None。

flatten_transform_indexbool, 可选 (默认=True)

如果为 True，则返回 DataFrame 的列是扁平的，格式为 “variablename__feature”；如果为 False，则列是 MultiIndex (variablename__feature)。如果返回 mtype 没有列名，则此参数无效。

属性:
is_fitted

是否已调用 fit。

另请参阅

WindowSummarizer

从（移位的）窗口中提取时间序列特征

注意

这提供了 pandas DataFrame 和 Series 的 agg 和 quantile 方法的包装器。

示例

>>> from sktime.transformations.series.summarize import SummaryTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = SummaryTransformer()
>>> y_mean = transformer.fit_transform(y)

方法

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

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

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

获取具有相同超参数和配置的对象的克隆。

克隆是具有不同引用、处于初始化后状态的不同对象。此函数等同于返回 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 的引用。

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")`。

参数:
X采用 sktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的各个数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象 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)，由 Series 类型的 pd.DataFrame 组成的 list`

  • 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 中传递，不是可选的。有关所需格式，请参阅类文档字符串了解详细信息。

返回:
自身估计器的一个已拟合实例
fit_transform(X, y=None)[source]#

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

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

状态变化

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

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

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

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

参数:
X采用 sktime 兼容数据容器格式的时间序列

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

sktime 中的各个数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象 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)，由 Series 类型的 pd.DataFrame 组成的 list`

  • 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，则返回一个 Panel，其实例数量与 X 相同（转换器应用于每个输入的 Series 实例）。示例：Panel 中的所有时间序列都单独进行去趋势化

  • 如果 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 的标签的值，考虑到标签覆盖，优先级从高到低如下：

  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 在实例上设置的动态标签覆盖。

collected_tagsdict

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

get_config()[source]#

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

获取自身的配置标志。

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

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

Configs 在 clone 或 reset 调用下保留。

config_dictdict

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

get_fitted_params(deep=True)[source]#

所需状态

获取已拟合参数。

要求状态为“已拟合”。

deepbool, 默认=True

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

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

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

  • fitted_params键为 str 的 dict

返回:
已拟合参数字典，参数名：参数值 键值对包括

始终：此对象的所有已拟合参数，如通过 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]#

是否返回组件的参数。

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

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

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

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

  • params键为 str 的 dict

返回:
参数字典，参数名：参数值 键值对包括

始终：此对象的所有参数，如通过 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 的单个标签的值，考虑到标签覆盖，优先级从高到低如下：

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

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

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

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

  1. 在实例构造时设置。

要检索的标签名称

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

  2. 在父类的 _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()[source]#

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

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

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

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

collected_tagsdict

值是相应的标签值，覆盖优先级从高到低如下：

  1. 在实例构造时设置。

要检索的标签名称

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

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

按照继承顺序。

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

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

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

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

目前假定只有带有标签的转换器

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

具有 inverse_transform 方法。

要求状态为“已拟合”。

deepbool, 默认=True

访问自身

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

  • self.is_fitted，必须为 True

参数:
X采用 sktime 兼容数据容器格式的时间序列

用于拟合转换的数据。

sktime 中的各个数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象 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)，由 Series 类型的 pd.DataFrame 组成的 list`

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

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

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

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

返回:
X 的逆转换版本

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

is_composite()[source]#

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

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

返回:
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) 的结果
返回:
反序列化的自身，结果输出到 path，是 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的自身，结果输出为 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')[源码]#

将序列化的自身保存为字节类对象或 (.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)[源码]#

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

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

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_only布尔值，默认值=True

self 的打印是否仅列出与默认值不同的自身参数（False），还是列出所有参数名称和值（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)[源码]#

设置此对象的参数。

此方法适用于简单的 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')[源码]#

为自身设置 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_state整数、RandomState 实例或 None，默认值=None

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

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

是否在 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)[源码]#

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

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

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

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

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

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

参数:
**tag_dict字典

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

返回:
Self

对 self 的引用。

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

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

要求状态为“已拟合”。

deepbool, 默认=True

访问自身

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

  • self.is_fitted，必须为 True

参数:
X采用 sktime 兼容数据容器格式的时间序列

要转换的数据。

sktime 中的各个数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象 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)，由 Series 类型的 pd.DataFrame 组成的 list`

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

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

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

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

返回:
X 的转换版本
类型取决于 X 的类型和 scitype:transform-output 标签

transform

X

-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，则返回一个 Panel，其实例数量与 X 相同（转换器应用于每个输入的 Series 实例）。示例：Panel 中的所有时间序列都单独进行去趋势化

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

要求状态为“已拟合”。

deepbool, 默认=True

访问自身

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

  • self.is_fitted，必须为 True

写入自身

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

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

参数:
X采用 sktime 兼容数据容器格式的时间序列

用于更新转换的数据

sktime 中的各个数据格式是所谓的 mtype 规范，每种 mtype 都实现了一个抽象 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)，由 Series 类型的 pd.DataFrame 组成的 list`

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有 3 级或更多行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)`

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

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

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

返回:
自身估计器的一个已拟合实例