RandomSamplesAugmenter

class RandomSamplesAugmenter(n=1.0, without_replacement=True, random_state=42)

从时间序列中抽取随机样本。

transform 接受一个具有 \(m\) 个元素的时间序列 \(X={x_1, x_2, ... , x_m}\)，并返回 \(X_t={x_i, x_{i+1}, ... , x_n}\)，其中 \({x_i, x_{i+1}, ... , x_n}\) 是从 \(X\) 中抽取（有或without_replacement）的 \(n`=``n`\) 个随机样本。

参数:

n: int 或 float, 可选 (默认 = 1.0)

要指定抽取的样本的确切数量，将 n 设置为 int 值。要指定的返回样本作为给定时间序列的比例，将 n 设置为 float 值 \(n \in [0, 1]\)。默认情况下，返回的样本数量与输入时间序列给定的数量相同。

without_replacement: bool, 可选 (默认 = True)

是否无放回抽样。如果为 True，输入时间序列 X 的每个样本在 Xt 中最多出现一次。

random_state: None 或 int 或 ``np.random.RandomState`` 实例, 可选

“如果为 int 或 RandomState，则用于抽取随机变量。如果为 None，则依赖于 self.random_state。默认值为 None。” [1]

参考与脚注

———-

[1]: https://docs.scipy.org.cn/doc/scipy/reference/generated/scipy.stats.rv_continuous.random_state.html

属性:

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()	获取 self 的配置标志。
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()	检查对象是否由其他 BaseObjects 组成。
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)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

method_namestr, 可选

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

引发:

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等效于返回 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)

从另一个对象克隆标签作为动态覆盖。

每个兼容 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 或 list of str, 默认 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

parameter_setstr, default=”default”

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

返回:

objscls 实例列表

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

namesstr 列表，长度与 objs 相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果多于一个实例，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y=None)

将转换器拟合到 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 兼容数据容器格式的时间序列

要拟合转换的数据。

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)

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

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

状态变化

将状态更改为“fitted”。

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

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

要拟合转换的数据以及要转换的数据。

参数:

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

X 的转换版本

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

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

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

表中未包含的组合目前不受支持

classmethod get_class_tag(tag_name, tag_value_default=None)#

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

每个兼容 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()

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

每个兼容 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()

获取 self 的配置标志。

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

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

所需状态

需要状态为“fitted”。

参数:

deepbool, 默认=True

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

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

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

返回:

fitted_params键为 str 的 dict

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

• 始终：此对象的所有拟合参数，通过 get_param_names 获取。值是此对象该键的拟合参数值。

• 如果 deep=True，还包含组件参数的键/值对。组件参数索引为 [组件名]__[参数名]。 组件名 的所有参数以 参数名 及其值出现。

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名]__[子组件名]__[参数名] 等。

classmethod get_param_defaults()

获取对象的默认参数。

返回:

default_dict: dict[str, Any]

键是 cls 在 __init__ 中定义了默认值的所有参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数:

sortbool, 默认=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, 默认=True

是否返回组件的参数。

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

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

返回:

params键为 str 的 dict

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

• 始终：此对象的所有参数，通过 get_param_names 获取。值是此对象该键的参数值。值始终与构造时传入的值相同。

• 如果 deep=True，还包含组件参数的键/值对。组件参数索引为 [组件名]__[参数名]。 组件名 的所有参数以 参数名 及其值出现。

• 如果 deep=True，还包含任意级别的组件递归，例如 [组件名]__[子组件名]__[参数名] 等。

get_tag(tag_name, tag_value_default=None, raise_error=True)

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

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

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

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

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

在实例构建时。

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

3. 父类 _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()

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

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

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

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

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

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

在实例构建时。

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

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

按继承顺序。

返回:

collected_tagsdict

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

classmethod get_test_params(parameter_set='default')

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

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

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

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

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

参数:

parameter_setstr, default=”default”

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

返回:

paramsdict 或 dict 列表, 默认 = {}

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

inverse_transform(X, y=None)

逆转换 X 并返回逆转换版本。

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

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

具有 inverse_transform。

所需状态

需要状态为“fitted”。

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

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

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

返回:

composite: bool

对象是否具有任何参数，其值为 BaseObject 派生实例。

property is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的结果

返回:

通过 cls.save(path) 得到的结果，即在 path 位置反序列化的 self

classmethod load_from_serial(serial)

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

参数:

serialcls.save(None) 输出的第 1 个元素

返回:

通过 cls.save(None) 得到的结果，即反序列化的 self serial

reset()

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

结果是将 self 设置为其构造函数调用后立即处于的状态，具有相同的超参数。通过 set_config 设置的配置值也得到保留。

reset 调用删除除以下项之外的所有对象属性：

• 超参数 = __init__ 的参数，写入 self，例如 self.paramname，其中 paramname 是 __init__ 的参数

• 包含双下划线（即字符串“__”）的对象属性。例如，名为“__myattr”的属性被保留。

• 配置属性，配置保持不变。也就是说，get_config 在 reset 前后的结果是相同的。

类和对象方法以及类属性也不受影响。

等效于 clone，区别在于 reset 改变 self 而不是返回新对象。

在调用 self.reset() 后，self 在值和状态上等于构造函数调用 ``type(self)(**self.get_params(deep=False))`` 后获得的对象。

返回:

self

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

save(path=None, serialization_format='pickle')

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

行为：如果 path 为 None，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 存储在该位置作为 zip 文件

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

参数:

pathNone 或文件位置 (str 或 Path)

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

• path=”estimator”，则将在当前工作目录创建 zip 文件 estimator.zip。

• path=”/home/stored/estimator”，则将在

存储在 /home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self

如果 path 是文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)

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

参数:

config_dictdict

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

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

jupyter 内核如何显示自身实例

• “diagram” = html 盒图表示

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

print_changed_onlybool, default=True

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

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, default=True; False 阻止 ray 在并行化后关闭。

    并行化后关闭。

  • “logger_name”：str, default=”ray”; 要使用的日志记录器名称。

  • “mute_warnings”：bool, default=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对自身的引用。

注意

改变对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，如果在 get_params 键中唯一。

返回:

self对自身的引用 (设置参数后)

set_random_state(random_state=None, deep=True, self_policy='copy')

为 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, default=None

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

deepbool, 默认=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对自身的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中（在构建期间）或在通过 __init__ 构建后立即调用。

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

参数:

**tag_dictdict

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

返回:

Self

对自身的引用。

transform(X, y=None)

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

所需状态

需要状态为“fitted”。

访问 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 的类型和 scitype:transform-output 标签

X | tf-output | 返回类型 |

	transform
X	-输出	返回类型
序列	原语	pd.DataFrame (1行)
面板	原语	pd.DataFrame
序列	序列	序列
面板	序列	面板
序列	面板	面板

表中未包含的组合目前不受支持

明确说明，带示例

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

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

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

表中未包含的组合目前不受支持

update(X, y=None, update_params=True)

用 X 更新转换器，可选地用 y。

所需状态

需要状态为“fitted”。

访问 self 中的内容

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

• self.is_fitted，必须为 True

写入 self

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

• 如果 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估计器的拟合实例