TimeSeriesKShapes#
- class TimeSeriesKShapes(n_clusters: int = 8, init_algorithm: str | ndarray = 'random', n_init: int = 10, max_iter: int = 300, tol: float = 0.0001, verbose: bool = False, random_state: int | RandomState = None)[source]#
时间序列的 K-shape 聚类,来自 tslearn 库。
直接封装
tslearn.clustering.KShape
。- 参数:
- n_clusters: int, 默认值 = 8
要形成的簇数量以及生成的质心数量。
- init_algorithm: str 或 np.ndarray, 默认值 = ‘random’
初始化簇中心的方法。以下任一选项均有效:['random']。或者是一个形状为 (n_clusters, ts_size, d) 的 np.ndarray,给出初始中心。
- n_init: int, 默认值 = 10
k-means 算法将使用不同质心种子运行的次数。最终结果将是 n_init 次连续运行中惯性(inertia)方面最好的输出。
- max_iter: int, 默认值 = 30
单次运行中 k-means 算法的最大迭代次数。
- tol: float, 默认值 = 1e-4
两次连续迭代中簇中心差异的 Frobenius 范数的相对容差,用于声明收敛。
- verbose: bool, 默认值 = False
详细模式。
- random_state: int 或 np.random.RandomState 实例或 None, 默认值 = None
确定质心初始化的随机数生成。
- 属性:
- labels_: np.ndarray (形状为 (n_instance,) 的一维数组)
每个时间序列所属的簇索引标签。
- inertia_: float
样本到其最近簇中心的平方距离之和,如果提供样本权重则按权重计算。
- n_iter_: int
运行的迭代次数。
方法
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_fitted_params
([deep])获取已拟合的参数。
获取对象的默认参数。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例中获取标签值,具有标签级别继承和覆盖。
get_tags
()从实例中获取标签,具有标签级别继承和覆盖。
get_test_params
([parameter_set])返回估计器的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化的内存容器加载对象。
predict
(X[, y])预测 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')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。
- 返回:
- paramsdict 或 dict 列表, 默认值 = {}
用于创建类测试实例的参数。每个 dict 是用于构造一个“有趣”的测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
会创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则抛出
NotFittedError
。- 参数:
- method_namestr, 可选
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 抛出:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象克隆。
克隆是另一个没有共享引用且处于初始化后状态的对象。此函数等同于返回
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
。- 抛出:
- 如果由于有缺陷的
__init__
导致克隆不符合规范,则抛出 RuntimeError。
- 如果由于有缺陷的
- clone_tags(estimator, tag_names=None)[source]#
从另一个对象克隆标签作为动态覆盖。
每个
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
指向自身的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的实例。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例列表及其名称列表。
- 参数:
- 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=None)[source]#
将时间序列聚类器拟合到训练数据。
- 状态改变
将状态改为“已拟合”。
- 写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Panel 科学类型 (scitype)
用于拟合估计器的时间序列。
可以是 Panel 科学类型的任何 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 一致性。
- 返回:
- self指向自身的引用。
- fit_predict(X, y=None) ndarray [source]#
计算簇中心并预测每个时间序列的簇索引。
便利方法;等同于先调用 fit(X) 再调用 predict(X)
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Panel 科学类型 (scitype)
要聚类的时间序列。
可以是 Panel 科学类型的任何 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,) 的一维数组)
X 中每个时间序列所属的簇索引。
- classmethod get_class_tag(tag_name, tag_value_default=None)[source]#
从类中获取类标签值,具有来自父类的标签级别继承。
每个
scikit-base
兼容的对象都有一个标签字典,用于存储对象的元数据。get_class_tag
方法是一个类方法,只考虑类级别标签值和覆盖来检索标签的值。它从对象中返回名称为
tag_name
的标签的值,考虑标签覆盖,优先级从高到低顺序如下:类
_tags
属性中设置的标签。父类
_tags
属性中设置的标签,
按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值名称。
- tag_value_default任意类型
如果未找到标签,使用的默认/回退值。
- 返回:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类中获取类标签,具有来自父类的标签级别继承。
每个
scikit-base
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是实例
self
特定的键值对,它们是对象构造后不会更改的静态标志。get_class_tags
方法是一个类方法,只考虑类级别标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中设置的
_tags
属性的任何键。值是相应的标签值,覆盖的优先级从高到低顺序如下:
类
_tags
属性中设置的标签。父类
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能包含实例覆盖的标签,请改用
get_tags
方法。不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要包含动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集。不受通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是自身的键值对,通常用作控制行为的瞬态标志。
get_config
返回动态配置,它会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并通过set_config
设置的动态配置覆盖。配置在调用
clone
或reset
时保留。- 返回:
- config_dictdict
配置名 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后收集来自
_onfig_dynamic
对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合的参数。
- 所需状态
需要状态为“已拟合”。
- 参数:
- deepbool, 默认值=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名 : 值字典,包括可拟合组件(= BaseEstimator 值的参数)的已拟合参数。
如果为 False,将返回此对象的参数名 : 值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为 str 类型的 dict
已拟合参数的字典,参数名 : 参数值 键值对包括
总是:此对象的所有已拟合参数,通过
get_param_names
获取,值是该键对应的此对象的已拟合参数值如果
deep=True
,还包含组件参数的键/值对,组件参数以[componentname]__[paramname]
索引,componentname
的所有参数都以paramname
形式出现,带有其值如果
deep=True
,还包含任意层级的组件递归,例如,[componentname]__[componentcomponentname]__[paramname]
等
- classmethod get_param_defaults()[source]#
获取对象的默认参数。
- 返回:
- default_dict: dict[str, Any]
键是
cls
中所有在__init__
中定义了默认值的参数。值是在__init__
中定义的默认值。
- classmethod get_param_names(sort=True)[source]#
获取对象的参数名称。
- 参数:
- sortbool, 默认值=True
是否按字母顺序排序返回参数名称 (True),或按它们在类
__init__
中出现的顺序返回 (False)。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,顺序与它们在类__init__
中出现的顺序相同。如果sort=True
,按字母顺序排序。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, 默认值=True
是否返回组件的参数。
如果
True
,将返回此对象的参数名 : 值字典,包括组件(=BaseObject
值的参数)的参数。如果
False
,将返回此对象的参数名 : 值字典,但不包括组件的参数。
- 返回:
- params键为 str 类型的 dict
参数字典,参数名 : 参数值 键值对包括
总是:此对象的所有参数,通过
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)[source]#
从实例中获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是实例
self
特定的键值对,它们是对象构造后不会更改的静态标志。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级从高到低顺序如下:通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类
_tags
属性中设置的标签。父类
_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
。
- ValueError, 如果
- get_tags()[source]#
从实例中获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是实例
self
特定的键值对,它们是对象构造后不会更改的静态标志。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
属性的任何键,或通过set_tags
或clone_tags
设置的标签的键。值是相应的标签值,覆盖的优先级从高到低顺序如下:
通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类
_tags
属性中设置的标签。父类
_tags
属性中设置的标签,
按继承顺序。
- 返回:
- collected_tagsdict
标签名 : 标签值 对的字典。通过嵌套继承从
_tags
类属性收集,然后收集来自_tags_dynamic
对象属性的任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是指包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象是否有任何参数的值是
BaseObject
的派生实例。
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
估计器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化
self
,结果是cls.save(path)
在path
生成的输出
- 反序列化
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化
self
,结果是cls.save(None)
生成的输出serial
- 反序列化
- predict(X, y=None) ndarray [source]#
预测 X 中每个样本所属的最接近的簇。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Panel 科学类型 (scitype)
要聚类的时间序列。
可以是 Panel 科学类型的任何 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,) 的一维数组)
X 中每个时间序列所属的簇索引。
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
默认行为是调用
_predict
并将预测的类别概率设置为 1,其他类别概率设置为 0。如果可以获得更好的估计,则覆盖此方法。- 参数:
- Xsktime 兼容的时间序列面板数据容器,Panel 科学类型 (scitype)
要聚类的时间序列。
可以是 Panel 科学类型的任何 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] 的二维数组 - 预测的类别概率
第一维索引对应于 X 中的实例索引 第二维索引对应于可能的标签(整数) (i, j) 位置的条目是第 i 个实例属于类别 j 的预测概率
- 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"
,则会在当前工作目录 (cwd) 创建一个 zip 文件estimator.zip
。path="/home/stored/estimator"
,则会在
/home/stored/
中存储一个 zip 文件estimator.zip
。- serialization_format: str, 默认值 = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
为文件位置 - 引用该文件的 ZipFile 对象
- 如果
- score(X, y=None) float [source]#
评估聚类器的质量。
- 参数:
- Xnp.ndarray (形状为 (n_instances, series_length) 的二维或三维数组,或形状为
(n_instances, n_dimensions, series_length)),或 pd.DataFrame (其中每列是一个维度,每个单元格是一个 pd.Series (任意维度,等长或不等长序列))。用于训练聚类器的时间序列实例,然后返回每个实例所属的簇索引。
- y: 被忽略,存在是为了 API 一致性。
- 返回:
- scorefloat
聚类器的得分。
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名 : 配置值 对的字典。有效的配置、值及其含义如下所示
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示自身的实例
“diagram” = HTML 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认值=True
打印 self 时是否只列出与默认值不同的参数 (False),或列出所有参数名称和值 (False)。不嵌套,即只影响自身,不影响组件估计器。
- 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”:布尔值,默认值=True;False 会阻止
ray
在并行化后 关闭。
- “shutdown_ray”:布尔值,默认值=True;False 会阻止
“logger_name”:字符串,默认值=”ray”;要使用的日志记录器名称。
“mute_warnings”:布尔值,默认值=False;如果为 True,则抑制警告
- 返回:
- self指向 self 的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及组合对象。对于组合对象(即包含其他对象的对象),可以使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果引用明确(例如,没有两个组件参数具有相同的名称<parameter>
),也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **params字典
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果__
后缀在 get_params 键中是唯一的,则可以作为完整字符串的别名。
- 返回:
- self指向 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
中采样,并保证 seeded 随机生成器的伪随机独立性。根据
self_policy
,应用于self
中的random_state
参数,并且仅当deep=True
时才应用于剩余的组件对象。注意:即使
self
没有random_state
参数,或者没有一个组件有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是没有random_state
参数的对象。- 参数:
- random_state整数, RandomState 实例或 None, 默认值=None
伪随机数生成器,用于控制随机整数的生成。传入整数以实现多次函数调用之间的可复现输出。
- 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指向 self 的引用
- set_tags(**tag_dict)[source]#
将实例级标签覆盖设置为给定值。
每个
scikit-base
兼容的对象都有一个标签字典,用于存储对象的元数据。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要将标签设置到的值。set_tags
方法只能在对象的__init__
方法中(在构造期间),或通过__init__
直接构造后调用。当前标签值可以通过
get_tags
或get_tag
查看。- 参数:
- **tag_dict字典
标签名称: 标签值 的字典。
- 返回:
- Self
指向 self 的引用。