MultiplexRegressor

class MultiplexRegressor(regressors: list, selected_regressor=None)

MultiplexRegressor 用于在不同模型之间进行选择。

MultiplexRegressor 提供了一个框架，用于在不同模型类别上执行模型选择过程。应与 GridSearchCV 结合使用以充分发挥作用。它可以用于单变量和多变量回归器，单输出和多输出回归器。

MultiplexRegressor 通过一个（命名）回归器列表和一个 selected_regressor 超参数指定，其中 selected_regressor 是其中一个回归器的名称。然后 MultiplexRegressor 的行为将完全等同于名称为 selected_regressor 的回归器，忽略其他回归器的功能。

与 GridSearchCV 一起使用时，MultiplexRegressor 提供了跨多个估计器进行调优的能力，即通过调整 selected_regressor 超参数来执行 AutoML。这种组合将通过调优算法选择传入的回归器之一。

参数:

regressorssktime 回归器列表，或

sktime 回归器的元组 (str, estimator) 列表 MultiplexRegressor 可以在这些回归器之间切换（“复用”）。这些是“蓝图”回归器，调用 fit 时其状态不会改变。

selected_regressor: str 或 None，可选，默认值=None。

如果为 str，必须是回归器名称之一。

如果未提供名称，则必须与自动生成的名称字符串一致。要检查自动生成的名称字符串，请调用 get_params。

如果为 None，则其行为类似于选择了列表中的第一个回归器。选择 MultiplexRegressor 表现为的回归器。

属性:

regressor_sktime 回归器

选择的回归器的克隆，用于拟合和回归。

_regressors(str, regressor) 元组列表

将回归器转换为名称/估计器元组。

方法

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)	将时间序列回归器拟合到训练数据。
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])	返回估计器的测试参数设置。
is_composite()	检查对象是否是复合对象。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict(X)	预测 X 中序列的标签。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
score(X, y[, multioutput])	根据 X 上的地面真实标签评分预测的标签。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**kwargs)	设置估计器的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	将实例级标签覆盖设置为给定值。

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 上设置了 config，则克隆也将具有与原始对象相同的 config，等同于调用 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 设置动态标签覆盖。

在对象的 __init__ 方法中、构造期间或通过 __init__ 直接在构造后，才能调用 clone_tags 方法。

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

tag_names 的默认设置 (None) 克隆 estimator 中的所有标签到 self 中。

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

参数:

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

tag_namesstr 或 str 列表，默认值 = None

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

返回:

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

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

参数:

parameter_setstr，默认值=”default”

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

返回:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数:

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)

将时间序列回归器拟合到训练数据。

状态变化

将状态更改为“fitted”。

写入 self

将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于拟合估计器的时间序列。

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex: 列为变量、索引为 pd.MultiIndex 的 pd.DataFrame，其中第一级为实例索引，第二级为时间索引。

• numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维数，等长序列）。

• 或任何其他支持的 Panel mtype。

mtype 列表请参见 datatypes.SCITYPE_REGISTER。

规范请参见 examples/AA_datatypes_and_datasets.ipynb。

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参见标签参考。

ysktime 兼容的 Table scitype 表格数据容器

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]，用于拟合的类标签 0 级索引对应于 X 中的实例索引 1 级索引（如果适用）对应于 X 中的多输出向量索引 支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:

self对 self 的引用。

说明

通过创建一个拟合模型来改变状态，该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。

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 的配置标志。

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

get_config 返回动态 config，这些 config 覆盖了默认 config。

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

在调用 clone 或 reset 后，config 被保留。

返回:

config_dictdict

config 名称 : config 值对的字典。通过嵌套继承从 _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，还包含组件参数的键/值对 组件的参数索引为 [componentname]__[paramname] componentname 的所有参数都以 paramname 及其值的形式出现

• 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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)

获取估计器的参数。

参数:

deepboolean，可选

如果为 True，将返回此估计器及其包含的作为估计器的子对象的参数。

返回:

paramsstring 到 any 的映射

参数名称映射到其值。

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

返回估计器的测试参数设置。

参数:

parameter_setstr，默认值=”default”

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

返回:

paramsdict 或 dict 列表

is_composite()

检查对象是否是复合对象。

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

返回:

composite: bool，表示 self 是否包含一个 BaseObject 类型的参数

property is_fitted

是否已调用 fit。

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

返回:

bool

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

反序列化的 self，产生在 path 处的输出，即 cls.save(path) 的输出

classmethod load_from_serial(serial)

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

参数:

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

返回:

反序列化的 self，产生输出 serial，即 cls.save(None) 的输出

predict(X) → ndarray

预测 X 中序列的标签。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器

用于预测标签的时间序列。

可以是 Panel scitype 的任何 mtype，例如

• pd-multiindex: 列为变量、索引为 pd.MultiIndex 的 pd.DataFrame，其中第一级为实例索引，第二级为时间索引。

• numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维数，等长序列）。

• 或任何其他支持的 Panel mtype。

mtype 列表请参见 datatypes.SCITYPE_REGISTER。

规范请参见 examples/AA_datatypes_and_datasets.ipynb。

并非所有估计器都支持包含多变量或不等长序列的面板，详情请参见标签参考。

返回:

y_predsktime 兼容的 Table scitype 表格数据容器

预测的回归标签

1D 可迭代对象，形状为 [n_instances]，或 2D 可迭代对象，形状为 [n_instances, n_dimensions]。

0 级索引对应于 X 中的实例索引，1 级索引（如果适用）对应于 X 中的多输出向量索引。

如果 y 是单变量（一维），则为 1D np.npdarray；否则，与 fit 中传入的 y 类型相同。

reset()

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

结果是将 self 设置为其在构造函数调用后的状态，并保留相同的超参数。通过 set_config 设置的 Config 值也会被保留。

调用 reset 会删除任何对象属性，除了

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

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

• config 属性，config 会被保留且不改变。也就是说，在 reset 前后调用 get_config 的结果是相同的。

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

等同于 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” 则会在当前工作目录创建 estimator.zip 文件。

• path=”/home/stored/estimator” 则会在

存储在 /home/stored/ 中。

serialization_format: str，默认值 = “pickle”

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

返回:

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

如果 path 为文件位置 - ZipFile，并带有对文件的引用

score(X, y, multioutput='uniform_average') → float

根据 X 上的地面真实标签评分预测的标签。

参数:

Xsktime 兼容的 Panel scitype 时间序列面板数据容器，例如：

pd-multiindex: 列为变量、索引为 pd.MultiIndex 的 pd.DataFrame，其中第一级为实例索引，第二级为时间索引。 numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array（任意维数，等长序列），或任何其他支持的 Panel mtype。mtype 列表请参见 datatypes.SCITYPE_REGISTER；规范请参见 examples/AA_datatypes_and_datasets.ipynb。

y2D np.array of int，形状为 [n_instances, n_dimensions] - 回归标签

用于拟合的索引对应于 X 中的实例索引，或 1D np.array of int，形状为 [n_instances] - 用于拟合的回归标签，索引对应于 X 中的实例索引。

multioutputstr，可选（默认值=”uniform_average”）

{"raw_values", "uniform_average", "variance_weighted"}，形状为 (n_outputs,) 的类数组对象或 None，默认值="uniform_average"。定义了多输出分数的聚合方式。类数组值定义了用于平均分数的权重。

返回:

float（默认值）或 1D np.array of float

predict(X) 与 y 之间的 R-squared 分数；如果 multioutput=”uniform_average” 或 “variance_weighted”，或 y 是单变量，则为 float；如果 multioutput=”raw_values” 且 y 是多变量，则为 1D np.array。

set_config(**config_dict)

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

参数:

config_dictdict

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

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，可选，默认值={}（未传入参数）

作为 config 传入并行化后端的额外参数。有效键取决于 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，则抑制警告

返回:

self对 self 的引用。

说明

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

set_params(**kwargs)

设置估计器的参数。

有效参数键可以通过 get_params() 列出。

返回:

self返回 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，默认值=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自身的引用

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dict字典

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

返回:

Self

自身的引用。