KNeighborsTimeSeriesRegressor#

class KNeighborsTimeSeriesRegressor(n_neighbors=1, weights='uniform', algorithm='brute', distance='dtw', distance_params=None, distance_mtype=None, pass_train_distances=False, leaf_size=30, n_jobs=None)[源码]#

K近邻时间序列回归器。

它是 scikit-learn 的 KNeighborsRegressor 的改编版本，适用于时间序列数据。

时间序列距离通过 distance argument 参数传递，它可以是

  • 一个字符串。这将替换来自 sktime.distances 的硬编码距离指标。这些默认距离旨在提高性能，但不能处理不等长或多元序列。

  • 一个 sktime 配对变换器。这些可在 sktime.dists_kernels 中找到，并且可以通过搜索 pairwise-transformer 类型通过 registry.all_estimators 发现，它们是 sktime 框架中的可组合的一等公民。处理不等长或多元序列的距离可用，这些距离可以通过 capability:unequal_length 和 capability:multivariate 标签发现。

  • 一个可调用对象。下面描述了可调用对象的精确签名。

参数：
n_neighborsint (默认: 5)

用于决策的最近邻居数量。

weightsstr 或 callable，可选 (默认: ‘uniform’)

预测中使用的权重函数。可能的值

  • ‘uniform’ : 均匀权重。每个邻域中的所有点权重相等。

  • ‘distance’ : 按其距离的倒数加权点。在这种情况下，查询点附近较近的邻居将比距离较远的邻居影响更大。

  • [callable] : 用户定义的函数，接受距离数组，并返回具有相同形状的包含权重的数组。

algorithmstr，可选。默认 = ‘brute’

邻居搜索方法之一：{‘auto’, ‘ball_tree’, ‘brute’, ‘brute_incr’}

  • ‘brute’ 预先计算距离矩阵并直接应用 sklearn KNeighborsRegressor。这种算法的内存效率不高，因为它随着距离矩阵的大小而扩展，但运行时效率可能更高。

  • ‘brute_incr’ 将距离传递给 sklearn KNeighborsRegressor，并使用 algorithm='brute'。这对于大型数据集提高内存效率很有用，因为距离是增量使用的，无需预计算。但是，这可能导致运行时效率较低。

  • ‘ball_tree’ 使用 BallTree 查找最近邻居，使用来自 sklearn 的 KNeighborsRegressor。在中到大型数据集上，运行时和内存效率可能更高，但距离计算可能较慢。

distancestr, sktime 配对变换器，或 callable，可选。默认 =’dtw’

时间序列之间的距离度量

  • 如果为 str，必须是以下字符串之一：‘euclidean’, ‘squared’, ‘dtw’, ‘ddtw’, ‘wdtw’, ‘wddtw’, ‘lcss’, ‘edr’, ‘erp’, ‘msm’, ‘twe’ 这将替换来自 sktime.distances 的硬编码距离指标

  • 如果为 sktime 配对变换器，必须实现 pairwise-transformer 接口。sktime 变换器可在 sktime.dists_kernels 中找到，并且可以通过搜索 pairwise-transformer 类型通过 registry.all_estimators 发现。

  • 如果为非类 callable，参数可以通过 distance_params 传递 例如: knn_dtw = KNeighborsTimeSeriesClassifier( distance=’dtw’, distance_params={‘epsilon’:0.1})

  • 如果为任意 callable，签名必须是 (X: Panel, X2: Panel) -> np.ndarray。如果 X 是 m 个序列的 Panel，X2 是 n 个序列的 Panel，输出必须是 mxn 数组；如果 distance_mtype 未设置，则必须能够接受 X，X2 的 mtype 为 pd_multiindex 和 numpy3D

distance_paramsdict，可选。默认 = None。

度量参数字典，当 distance 是字符串时使用

distance_mtypestr 或 str 列表，可选。默认 = None。
distance 作为 callable 时，期望 X 和 X2 的 mtype

仅当 distance 不是 BasePairwiseTransformerPanel 的后代时设置此项

pass_train_distancesbool，可选，默认 = False。

是否计算训练点之间的距离并将其传递给 sklearn。对于 algorithm=’brute’，传递是多余的，但否则可能产生影响。

leaf_sizeint，可选，默认=30

传递给 BallTree 或 KDTree 的叶子大小。这会影响构建和查询的速度，以及存储树所需的内存。最佳值取决于问题的性质。

n_jobsint，可选，默认=None

邻居搜索并行运行的作业数量。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。不影响 fit 方法。

属性：
is_fitted

是否已调用 fit。

示例

>>> from sktime.datasets import load_unit_test
>>> from sktime.regression.distance_based import KNeighborsTimeSeriesRegressor
>>> X_train, y_train = load_unit_test(return_X_y=True, split="train")
>>> X_test, y_test = load_unit_test(return_X_y=True, split="test")
>>> regressor = KNeighborsTimeSeriesRegressor()
>>> regressor.fit(X_train, y_train)
KNeighborsTimeSeriesRegressor(...)
>>> y_pred = regressor.predict(X_test)

方法

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

获取自身的配置标志。

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

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

kneighbors(X[, n_neighbors, return_distance])

找到一个点的 K 近邻。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

reset()

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

save([path, serialization_format])

将序列化的自身保存到类似字节的对象或 (.zip) 文件中。

score(X, y[, multioutput])

根据 X 上的真实标签对预测标签进行评分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

将实例级别的标签覆盖设置为给定值。
classmethod get_test_params(parameter_set='default')[源码]#

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

参数：
parameter_setstr，默认=”default”

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

返回：
paramsdict 或 dict 列表，默认={}

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

check_is_fitted(method_name=None)[源码]#

检查评估器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：
method_namestr，可选

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

引发：
NotFittedError

如果评估器尚未拟合。

clone()[源码]#

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

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

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

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

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

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

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

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

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

参数：
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表，默认 = None

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

返回：
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 个元素是测试中第 i 个 obj 实例的名称。命名约定是如果实例多于一个，则为 {cls.__name__}-{i}，否则为 {cls.__name__}

fit(X, y)[源码]#

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

状态更改

将状态更改为“fitted”。

写入自身

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

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

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

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

  • pd-multiindex: pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

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

  • 或任何其他支持的 Panel mtype

mtypes 列表，参见 datatypes.SCITYPE_REGISTER

规范，参见 examples/AA_datatypes_and_datasets.ipynb

并非所有评估器都支持具有多元或不等长序列的面板，详细信息参见标签参考。

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

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

返回：
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 的键值对，通常用作控制行为的临时标志。

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，还包含组件参数的键/值对 组件参数的索引为 [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)[源码]#

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

参数：
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)[源码]#

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

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

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

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，考虑标签覆盖，优先级从高到低如下：

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

在实例构建时。

  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()[源码]#

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

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

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

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

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

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

在实例构建时。

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

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

按继承顺序。

返回：
collected_tagsdict

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

is_composite()[源码]#

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

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

返回：
composite: bool

对象的任何参数值是否为 BaseObject 的派生实例。

property is_fitted[源码]#

是否已调用 fit。

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

返回：
bool

评估器是否已 fit。

kneighbors(X, n_neighbors=None, return_distance=True)[源码]#

找到一个点的 K 近邻。

返回每个点的邻居索引和距离。

参数：
Xsktime 兼容的数据格式，Panel 或 Series，包含 n_samples 个序列
n_neighborsint

获取的邻居数量（默认值为构造函数传递的值）。

return_distanceboolean, optional. Defaults to True.

如果为 False，将不返回距离

返回：
distarray

表示点之间长度的数组，仅在 return_distance=True 时存在

indarray

总体矩阵中最近点的索引。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果
返回：
反序列化 self，结果输出到 path，是 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回：
反序列化 self，结果输出 serial，是 cls.save(None) 的输出
predict(X) → ndarray[source]#

预测 X 中序列的标签。

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

需要预测标签的时间序列。

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

  • pd-multiindex: pd.DataFrame，列 = 变量，索引 = pd.MultiIndex，第一层 = 实例索引，第二层 = 时间索引

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

  • 或任何其他支持的 Panel mtype

mtypes 列表，参见 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()[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

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

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

  • 如果 path=”/home/stored/estimator”，则 zip 文件 estimator.zip 将存储在

/home/stored/ 中。

serialization_format: str, default = “pickle”

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

返回：
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用文件的 ZipFile
score(X, y, multioutput='uniform_average') → float[source]#

根据 X 上的真实标签对预测标签进行评分。

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

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

y用于拟合的 2D np.array (int)，形状为 [n_instances, n_dimensions] - 回归标签，索引对应于 X 中的实例索引

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

multioutputstr, optional (default=”uniform_average”)

{“raw_values”, “uniform_average”, “variance_weighted”}，形状为 (n_outputs,) 的 array-like 或 None，default=”uniform_average”。定义如何聚合多输出分数。array-like 值定义用于平均分数的权重。

返回：
float (默认) 或 1D np.array (float)

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

set_config(**config_dict)[source]#

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

参数：
config_dictdict

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

打印 self 时是只列出与默认值不同的 self 参数 (False)，还是列出所有参数名和值 (False)。不嵌套，即只影响 self 而不影响组件估计器。

warningsstr, “on” (默认), 或 “off”

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

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

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

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行处理的后端，可选之一

  • “None”: 顺序执行循环，简单的列表推导式

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

  • “joblib”: 自定义和第三方 joblib 后端，例如 spark

  • “dask”: 使用 dask，需要环境中安装 dask 包

  • “ray”: 使用 ray，需要环境中安装 ray 包

backend:parallel:paramsdict, optional, 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，抑制警告

    • “mute_warnings”: 布尔值，默认为 False；如果为 True，则抑制警告

返回：
self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

该方法适用于简单的 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')[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, 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)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

返回：
Self

对自身的引用。