TimeSeriesKernelKMeans#

class TimeSeriesKernelKMeans(n_clusters: int = 8, kernel: str = 'gak', n_init: int = 10, max_iter: int = 300, tol: float = 0.0001, kernel_params: dict | None = None, verbose: bool = False, n_jobs: int | None = None, random_state: int | RandomState = None)[来源]#

核 k-means 聚类，来自 tslearn。

tslearn.clustering.KernelKMeans 的直接接口。

参数：
n_clusters: int, 默认值 = 8

要形成的簇的数量以及要生成的质心的数量。

kernel字符串或可调用对象 (默认值: “gak”)

核应为“gak”，此时使用来自 [2]_ 的全局对齐核 (Global Alignment Kernel)，或者是一个被 scikit-learn 的 pairwise_kernels 接受作为度量的值。

n_init: int, 默认值 = 10

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

kernel_params字典或 None (默认值: None)

要传递给核函数的核参数。None 表示未设置核参数。对于全局对齐核 (Global Alignment Kernel)，唯一相关的参数是 sigma。如果设置为“auto”，则根据训练集的样本计算（参见 tslearn.metrics.sigma_gak）。如果未为 sigma 设置特定值，则默认为 1。

max_iter: int, 默认值 = 300

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

tol: float, 默认值 = 1e-4

两次连续迭代的簇中心差异的 Frobenius 范数的相对容忍度，用于声明收敛。

verbose: bool, 默认值 = False

详细模式。

n_jobsint 或 None, 可选 (默认值=None)

并行运行用于 GAK 交叉相似性矩阵计算的任务数。None 表示 1，除非在 joblib.parallel_backend 上下文中使用。-1 表示使用所有处理器。有关更多详细信息，请参阅 scikit-learn 的术语表。

random_state: int 或 np.random.RandomState 实例或 None, 默认值 = None

确定质心初始化的随机数生成。

属性：
labels_: np.ndarray (形状为 (n_instance,) 的一维数组)

标签，即每个时间序列所属的簇索引。

inertia_: float

样本到其最近簇中心的平方距离之和，如果提供了样本权重，则按样本权重加权。

n_iter_: int

运行的迭代次数。

示例

>>> from sktime.clustering.kernel_k_means import TimeSeriesKernelKMeans
>>> from sktime.datasets import load_arrow_head
>>> X_train, y_train = load_arrow_head(split="train")
>>> X_test, y_test = load_arrow_head(split="test")
>>> clusterer = TimeSeriesKernelKMeans(n_clusters=3)  
>>> clusterer.fit(X_train)  
TimeSeriesKernelKMeans(n_clusters=3)
>>> y_pred = clusterer.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])

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

fit_predict(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 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X[, y])

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

predict_proba(X)

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

reset()

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

save([path, serialization_format])

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

score(X[, y])

评估聚类器的质量。

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') → dict[来源]#

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

参数：
parameter_set字符串, 默认值=”default”

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

返回值：
params字典或字典列表, 默认值 = {}

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

check_is_fitted(method_name=None)[来源]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError 异常。

参数：
method_name字符串, 可选

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

引发：
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。

引发：
如果克隆不符合要求，则引发 RuntimeError，由于 __init__ 错误。
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 检查。

参数：
estimatorAn instance of :class:BaseObject or derived class
tag_names字符串或字符串列表, 默认值 = None

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

返回值：
self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[来源]#

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

参数：
parameter_set字符串, 默认值=”default”

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

返回值：
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[来源]#

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

参数：
parameter_set字符串, 默认值=”default”

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

返回值：
objscls 实例列表

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

names字符串列表, 与 objs 长度相同

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

fit(X, y=None)[来源]#

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

状态改变

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

写入 self

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

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

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

可以是 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忽略，为了 API 一致性保留。
返回值：
self对 self 的引用。
fit_predict(X, y=None) → ndarray[来源]#

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

便捷方法；相当于调用 fit(X) 后再调用 predict(X)

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

要进行聚类的时间序列。

可以是 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: 忽略，为了 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_name字符串

标签值的名称。

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_tags字典

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

get_config()[来源]#

获取对象的配置标志。

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

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

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

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

返回值：
config_dict字典

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

get_fitted_params(deep=True)[来源]#

获取已拟合的参数。

所需状态

需要状态为“已拟合” (fitted)。

参数：
deepbool, 默认值=True

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

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

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

返回值：
fitted_params键为字符串的字典

已拟合参数字典，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，将返回此对象的参数名称 : 值字典，包括组件（= BaseObject 类型参数）的参数。

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

返回值：
params键为字符串的字典

参数字典，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_name字符串

要检索的标签名称

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_tags字典

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

is_composite()[来源]#

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

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

返回值：
composite: bool

对象是否包含任何参数，其值为 BaseObject 的后代实例。

property is_fitted[来源]#

是否已调用 fit。

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

返回值：
bool

估计器是否已拟合 (fit)。

classmethod load_from_path(serial)[来源]#

从文件位置加载对象。

参数：
serialZipFile(path).open(“object) 的结果
返回值：
在 path 处的结果，是 cls.save(path) 的反序列化 self
classmethod load_from_serial(serial)[来源]#

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

参数：
serialcls.save(None) 输出的第一个元素
返回值：
结果为 serial 的反序列化 self，来自 cls.save(None)
predict(X, y=None) → ndarray[来源]#

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

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

要进行聚类的时间序列。

可以是 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: 忽略，为了 API 一致性保留。
返回值：
np.ndarray (形状为 (n_instances,) 的一维数组)

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

predict_proba(X)[来源]#

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

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

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

要进行聚类的时间序列。

可以是 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形状为 [n_instances, n_classes] 的二维数组 - 预测的类概率

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

reset()[来源]#

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

结果是将 self 设置为构造函数调用后直接的状态，具有相同的超参数。通过 set_config 设置的配置值也会保留。

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

  • 超参数 = __init__ 的参数，写入 self，例如 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')[来源]#

将序列化的对象保存到字节类对象或 (.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 的 zip 文件。

  • path=”/home/stored/estimator” 则将创建 estimator.zip 的 zip 文件，

存储在 /home/stored/ 中。

serialization_format: 字符串, 默认值 = “pickle”

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

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

评估聚类器的质量。

参数：
Xnp.ndarray（形状为 (n_instances, series_length) 的 2d 或 3d 数组，或形状为

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

y: 忽略，为了 API 一致性保留。
返回值：
scorefloat

聚类器的分数。

set_config(**config_dict)[源代码]#

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

参数：
config_dict字典

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool，默认值=True

打印 self 时是仅列出自有的与默认值不同的参数 (True)，还是列出所有参数名称和值 (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>。如果这样使引用变得明确，例如没有两个组件参数具有 <parameter> 名称，则也可以使用不带 <component>__ 的字符串 <parameter>。

参数：
**paramsdict

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_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 的引用。