TimeSeriesKMeansTslearn

class TimeSeriesKMeansTslearn(n_clusters=3, max_iter=50, tol=1e-06, n_init=1, metric='euclidean', max_iter_barycenter=100, metric_params=None, n_jobs=None, dtw_inertia=False, verbose=0, random_state=None, init='random')

基于 tslearn 的时间序列 K-means 聚类。

直接接口到 tslearn.clustering.TimeSeriesKMeans。

参数:

n_clustersint（默认值：3）

要形成的聚类数量。

max_iterint（默认值：50）

K-means 算法单次运行的最大迭代次数。

tolfloat（默认值：1e-6）

惯量变化阈值。如果在某个点，惯量在连续两次迭代之间的变化小于此阈值，则认为模型已收敛，算法停止。

n_initint（默认值：1）

K-means 算法将使用不同的中心点种子运行的次数。最终结果将是 n_init 次连续运行中在惯量方面的最佳输出。

metric{“euclidean”, “dtw”, “softdtw”}（默认值：“euclidean”）

用于聚类分配和重心计算的度量。如果为“dtw”，则使用 DBA 进行重心计算。

max_iter_barycenterint（默认值：100）

重心计算过程的迭代次数。仅在 metric="dtw" 或 metric="softdtw" 时使用。

metric_paramsdict 或 None（默认值：None）

所选度量的参数值。对于接受交叉距离矩阵计算并行化的度量，在 metric_params 中传递的 n_jobs 键将被 n_jobs 参数覆盖。

n_jobsint 或 None，可选（默认值=None）

交叉距离矩阵计算并行运行的作业数。如果无法使用并行化计算交叉距离矩阵，则忽略。None 表示 1，除非在 joblib.parallel_backend 上下文中使用。-1 表示使用所有处理器。有关更多详细信息，请参阅 scikit-learn 的 词汇表 。

dtw_inertia: bool（默认值：False）

即使 DTW 不是所选度量，是否也计算 DTW 惯量。

verboseint（默认值：0）

如果非零，则在学习模型期间打印有关惯量的信息，并打印 joblib 进度消息。

random_state整数或 numpy.RandomState，可选

用于初始化中心的生成器。如果给定一个整数，则固定种子。默认为全局 numpy 随机数生成器。

init{‘k-means++’，‘random’ 或 ndarray}（默认值：‘random’）

初始化方法：‘k-means++’：使用 k-means++ 启发式算法。有关更多信息，请参阅 scikit-learn 的 k_init_ 。‘random’：从数据中随机选择 k 个观察值（行）作为初始中心点。如果传递 ndarray，则其形状应为 (n_clusters, ts_size, d)，并给出初始中心。

属性:

labels_numpy.ndarray

每个点的标签。

cluster_centers_形状为 (n_clusters, sz, d) 的 numpy.ndarray

聚类中心。sz 是在拟合时使用的时间序列的大小（如果初始化方法是‘k-means++’或‘random’），以及最长初始中心点的大小（如果通过 init 参数提供了 numpy 数组）。

inertia_float

样本到其最近聚类中心的距离之和。

n_iter_int

拟合期间执行的迭代次数。

注意

如果 metric 设置为 "euclidean"，则算法需要一个等长的时间序列数据集。

方法

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])	将时间序列聚类器拟合到训练数据。
fit_predict(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()	检查对象是否由其他 BaseObject 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
predict(X[, y])	预测 X 中每个样本所属的最接近的聚类。
predict_proba(X)	预测 X 中序列的标签概率。
reset()	将对象重置为干净的初始化后状态。
save([path, serialization_format])	将序列化的 self 保存到类字节对象或 (.zip) 文件。
score(X[, y])	评估聚类器的质量。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 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()

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

克隆是一个没有共享引用的不同对象，处于初始化后状态。此函数等同于返回 self 的 sklearn.clone。

等同于使用 self 的参数构造 type(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 或 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=None)

将时间序列聚类器拟合到训练数据。

状态变更

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

写入 self

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

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

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

• pd-multiindex：pd.DataFrame，其中 columns = variables，index = 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忽略，出于 API 一致性原因存在。

返回值:

self对 self 的引用。

fit_predict(X, y=None) → ndarray

计算聚类中心并预测每个时间序列的聚类索引。

便捷方法；等同于调用 fit(X) 后接 predict(X)

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

要聚类的时间序列。

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

• pd-multiindex：pd.DataFrame，其中 columns = variables，index = 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: 忽略，出于 API 一致性原因存在。

返回值:

np.ndarray（形状为 (n_instances,) 的一维数组）

X 中每个时间序列所属聚类的索引。

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)

获取拟合参数。

所需状态

需要状态为“已拟合”。

参数:

deepbool，默认值=True

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

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

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

返回值:

fitted_params带有 str 值键的字典

拟合参数字典，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 值键的字典

参数字典，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 设置的标签，

在实例构造时。

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 对象属性的任何覆盖和新标签。

is_composite()

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

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

返回值:

composite: bool

对象是否包含任何参数，其参数值是 BaseObject 的子类实例。

属性 is_fitted

是否已调用 fit 方法。

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

返回值:

bool

估计器是否已 fit。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

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

返回值:

反序列化 self，结果位于 path，是 cls.save(path) 的输出

类方法 load_from_serial(serial)

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

参数:

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

返回值:

反序列化 self，结果是 serial，是 cls.save(None) 的输出

predict(X, y=None) → ndarray

预测 X 中每个样本所属的最接近的聚类。

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

要聚类的时间序列。

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

• pd-multiindex：pd.DataFrame，其中 columns = variables，index = 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: 忽略，出于 API 一致性原因存在。

返回值:

np.ndarray（形状为 (n_instances,) 的一维数组）

X 中每个时间序列所属聚类的索引。

predict_proba(X)

预测 X 中序列的标签概率。

默认行为是调用 _predict 并将预测的类别概率设置为 1，将其他类别概率设置为 0。如果可以获得更好的估计值，则覆盖此方法。

参数:

XPanel scitype 的 sktime 兼容时间序列面板数据容器

要聚类的时间序列。

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

• pd-multiindex：pd.DataFrame，其中 columns = variables，index = 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形状为 [n_instances, n_classes] 的二维数组 - 预测的类别概率

第一维索引对应于 X 中的实例索引 第二维索引对应于可能的标签（整数） (i, j) 处的条目是第 i 个实例属于类别 j 的预测概率

reset()

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

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

将序列化的 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/ 中创建 estimator.zip 文件并存储。

serialization_format: str，默认值 = “pickle”

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

返回值:

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

如果 path 是文件位置 - 包含文件引用的 ZipFile 对象

score(X, y=None) → float

评估聚类器的质量。

参数:

Xnp.ndarray（形状为 (n_instances, series_length) 的二维或三维数组，或形状为

(n_instances, n_dimensions, series_length)）或 pd.DataFrame（其中每列是一个维度，每个单元格是一个 pd.Series（任意数量的维度，长度相等或不等的时间序列））。用于训练聚类器的时间序列实例，然后让每个索引都属于返回结果。

y: 忽略，出于 API 一致性原因存在。

返回值:

scorefloat

聚类器的得分。

set_config(**config_dict)

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

参数:

config_dictdict

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

displaystr，“diagram”（默认）或 “text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool，默认值=True

打印 self 时是仅列出与默认值不同的 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，可选，默认值={}（未传递参数）

作为配置传递给并行化后端的附加参数。有效键取决于 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 中的配置复制到 self._config_dynamic。

set_params(**params)

设置此对象的参数。

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

参数:

**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。如果 __ 后缀在 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` 中的 `random_state` 参数（取决于 `self_policy`），并且仅当 `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_policystr，{“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_dictdict

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

返回值:

Self

对 self 的引用。