TimeSeriesKMedoids

class TimeSeriesKMedoids(n_clusters: int = 8, init_algorithm: str | Callable = 'random', metric: str | Callable = 'dtw', n_init: int = 10, max_iter: int = 300, tol: float = 1e-06, verbose: bool = False, random_state: int | RandomState = None, distance_params: dict = None)

时间序列 K-medoids 实现。

参数:

n_clusters: int, 默认为 8

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

init_algorithm: str, np.ndarray (形状为 (n_clusters, n_dimensions,

series_length) 的 3d 数组)), 默认为 'forgy'。初始化簇中心的方法或初始簇中心的数组。如果是字符串，以下任何字符串都有效

[‘kmeans++’, ‘random’, ‘forgy’]。

如果是 3D np.ndarray，则使用提供的数组初始化簇中心。该数组

必须具有形状 (n_clusters, n_dimensions, series_length)，并且数组中的簇数量必须与提供给 n_clusters 参数的数量相同。

metric: str 或 Callable, 默认为 'dtw'

计算时间序列之间相似性的距离指标。以下任何指标都有效: [‘dtw’, ‘euclidean’, ‘erp’, ‘edr’, ‘lcss’, ‘squared’, ‘ddtw’, ‘wdtw’, ‘wddtw’]

n_init: int, 默认为 10

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

max_iter: int, 默认为 30

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

tol: float, 默认为 1e-6

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

verbose: bool, 默认为 False

详细模式。

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

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

distance_params: dict, 默认为 None

包含所用距离指标的 kwargs 的字典。

属性:

cluster_centers_: np.ndarray (形状为 (n_clusters, n_dimensions,

series_length) 的 3d 数组)) 代表每个簇中心的时间序列。如果算法在完全收敛之前停止，这些将与 labels_ 不一致。

labels_: np.ndarray (形状为 (n_instance,) 的 1d 数组)

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

inertia_: float

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

n_iter_: int

运行的迭代次数。

示例

>>> from sktime.datasets import load_arrow_head
>>> from sktime.clustering.k_medoids import TimeSeriesKMedoids
>>> X_train, y_train = load_arrow_head(split="train")
>>> X_test, y_test = load_arrow_head(split="test")
>>> clusterer = TimeSeriesKMedoids(n_clusters=3)  
>>> clusterer.fit(X_train)  
TimeSeriesKMedoids(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()	检查对象是否由其他 BaseObjects 组成。
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 或 list of dict, 默认为 {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

检查是否存在 _is_fitted 属性且其值为 True。在调用对象的 fit 方法时，应将 is_fitted 属性设置为 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。

引发:

如果克隆不符合规范，则抛出 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 检查当前标签值。

参数:

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。设置以“_”结尾的已拟合模型属性。

参数:

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

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

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

• 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被忽略，出于 API 一致性原因而存在。

返回:

selfself 的引用。

fit_predict(X, y=None) → ndarray

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

便捷方法；等同于先调用 fit(X) 再调用 predict(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

mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

返回:

np.ndarray (形状为 (n_instances,) 的 1d 数组)

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

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:

deepbool, 默认为 True

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

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

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

返回:

fitted_paramsstr 值键的 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，但不包括组件参数。

返回:

paramsstr 值键的 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 在实例上设置的标签，

在实例构造时。

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

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

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

返回:

composite: bool

对象是否有任何参数的值是 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) 输出的第一个元素

返回:

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

predict(X, y=None) → ndarray

预测 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

mtype 列表，请参阅 datatypes.SCITYPE_REGISTER

规范，请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

返回:

np.ndarray (形状为 (n_instances,) 的 1d 数组)

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

predict_proba(X)

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

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

参数:

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

要聚类的时间序列。

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

• 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形状为 [n_instances, n_classes] 的 2D 数组 - 预测的类别概率

第一维索引对应于 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，则返回一个内存中的序列化对象自身；如果 path 是文件位置，则将对象自身作为 zip 文件存储在该位置

保存的文件是 zip 文件，包含以下内容：_metadata - 包含对象自身的类，即 type(self)；_obj - 序列化的对象自身。此类使用默认的序列化格式 (pickle)。

参数:

pathNone 或文件位置 (str 或 Path)

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

• path=”estimator”，则会在当前工作目录 (cwd) 创建一个 zip 文件 estimator.zip。

• path=”/home/stored/estimator”，则会创建一个 zip 文件 estimator.zip 并

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

返回:

如果 path 为 None - 内存中的序列化对象自身

如果 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_dictdict

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

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

jupyter kernel 如何显示对象实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认=True

打印对象时是否只列出与默认值不同的参数，或列出所有参数名称和值。不进行嵌套，即只影响对象自身而不影响组件估计器。

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指代自身对象。

注意事项

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

set_params(**params)

设置此对象的参数。

该方法适用于简单的 skbase 对象以及复合对象。参数键字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以便访问组件 <component> 中的 <parameter>。如果引用清晰明确（例如，没有两个组件参数同名为 <parameter>），则也可以使用不带 <component>__ 的字符串 <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 从链式哈希中采样，并保证 seeded 随机生成器的伪随机独立性。

根据 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 对象类型参数（即组件估计器）中的 random state。

• 如果为 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，

从输入的 random_state 派生而来，通常与输入的不同

返回:

self指代自身对象

set_tags(**tag_dict)

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

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

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

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

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

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

参数:

**tag_dictdict

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

返回:

自身对象

指代自身对象。