TimeSeriesDBSCAN#
- class TimeSeriesDBSCAN(distance, eps=0.5, min_samples=5, algorithm='auto', leaf_size=30, n_jobs=None)[source]#
用于时间序列距离的 DBSCAN。
sktime 时间序列距离的 sklearn DBSCAN 接口。
- 参数:
- distancestr 或 callable,默认为’euclidean’
计算特征数组中实例之间距离时使用的度量。如果度量是字符串或可调用对象,则必须是
sklearn.metrics.pairwise_distances
的 metric 参数允许的选项之一。如果度量是“precomputed”,则假定 X 是一个距离矩阵,并且必须是方阵。X 可以是一个术语表中的稀疏图,在这种情况下,只有“非零”元素才可能被 DBSCAN 视为邻居。- epsfloat,默认为 0.5
两个样本之间的最大距离,使其中一个被视为另一个的邻域。这并非簇内点之间距离的最大上限。这是为您的数据集和距离函数适当选择的最重要的 DBSCAN 参数。
- min_samplesint,默认为 5
邻域中样本(或总权重)的数量,使一个点被视为核心点。这包括该点本身。
- algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’},默认为’auto’
NearestNeighbors 模块用于计算点间距离和查找最近邻居的算法。详情请参见 NearestNeighbors 模块文档。
- leaf_sizeint,默认为 30
传递给 BallTree 或 cKDTree 的叶子大小。这会影响构建和查询的速度,以及存储树所需的内存。最佳值取决于问题的性质。
- n_jobsint,默认为 None
要运行的并行作业数量。
None
表示 1,除非在joblib.parallel_backend
上下文中。-1
表示使用所有处理器。更多详情请参见术语表。
- 属性:
- core_sample_indices_形状为 (n_core_samples,) 的 ndarray
核心样本的索引。
- components_形状为 (n_core_samples, n_features) 的 ndarray
训练找到的每个核心样本的副本。
- labels_形状为 (n_samples) 的 ndarray
提供给 fit() 的数据集中每个点的簇标签。噪声样本的标签为 -1。
方法
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])从类中获取类标签值,并从父类继承标签级别。
从类中获取类标签,并从父类继承标签级别。
获取 self 的配置标志。
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])将序列化的 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')[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
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]#
将时间序列聚类器拟合到训练数据。
- 状态改变
将状态改变为“fitted”。
- 写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
用于拟合估计器的时间序列。
pd-multiindex: 列为变量,索引为 pd.MultiIndex (第一级为实例索引,第二级为时间索引) 的 pd.DataFrame
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度数,等长序列)
或任何其他支持的
Panel
mtype
mtypes 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多变量或不等长序列的面板,详情请参见标签参考。
- y被忽略,出于 API 一致性原因而存在。
- 返回:
- self对 self 的引用。
- fit_predict(X, y=None) ndarray [source]#
计算簇中心并预测每个时间序列的簇索引。
便捷方法;等同于先调用 fit(X) 再调用 predict(X)
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要聚类的时间序列。
pd-multiindex: 列为变量,索引为 pd.MultiIndex (第一级为实例索引,第二级为时间索引) 的 pd.DataFrame
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度数,等长序列)
或任何其他支持的
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)[source]#
从类中获取类标签值,并从父类继承标签级别。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。get_class_tag
方法是一个类方法,它仅考虑类级别标签值和覆盖来检索标签的值。它返回对象中名称为
tag_name
的标签的值,并考虑标签覆盖,优先级降序排列如下:在类的
_tags
属性中设置的标签。在父类
_tags
属性中设置的标签,
按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索可能带有实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_default任意类型,可选;默认为 None
如果未找到标签,则使用的默认/备用值。
- 返回:
- 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]#
获取 self 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,它们会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回:
- config_dictdict
配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“fitted”。
- 参数:
- 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()[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
,将返回此对象的参数名称 : 值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)[source]#
从实例获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会改变。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,并考虑标签覆盖,优先级降序排列如下:通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型,可选;默认为 None
如果未找到标签,则使用的默认/备用值
- raise_errorbool
未找到标签时是否引发
ValueError
- 返回:
- tag_value任意类型
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,其输出位于
path
,是cls.save(path)
的结果
- 反序列化的 self,其输出位于
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的 self,其输出为
serial
,是cls.save(None)
的结果
- 反序列化的 self,其输出为
- predict(X, y=None) ndarray [source]#
预测 X 中每个样本所属的最接近的簇。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要聚类的时间序列。
pd-multiindex: 列为变量,索引为 pd.MultiIndex (第一级为实例索引,第二级为时间索引) 的 pd.DataFrame
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度数,等长序列)
或任何其他支持的
Panel
mtype
mtypes 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多变量或不等长序列的面板,详情请参见标签参考。
- y: 被忽略,出于 API 一致性原因而存在。
- 返回:
- np.ndarray (形状为 (n_instances,) 的一维数组)
X 中每个时间序列所属簇的索引。
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
默认行为是调用 _predict 并将预测的类概率设置为 1,其他类概率设置为 0。如果可以获得更好的估计,则覆盖此方法。
- 参数:
- XPanel scitype 的 sktime 兼容时间序列面板数据容器
要聚类的时间序列。
pd-multiindex: 列为变量,索引为 pd.MultiIndex (第一级为实例索引,第二级为时间索引) 的 pd.DataFrame
numpy3D: 形状为 [n_instances, n_dimensions, series_length] 的 3D np.array (任意维度数,等长序列)
或任何其他支持的
Panel
mtype
mtypes 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多变量或不等长序列的面板,详情请参见标签参考。
- 返回:
- y形状为 [n_instances, n_classes] 的 2D 数组 - 预测的类概率
第一维索引对应于 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]#
将序列化的 self 保存为字节状对象或 (.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
。
存储在
/home/stored/
中。- serialization_format: str,默认为 “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - 指向该文件的 ZipFile
- 如果
- score(X, y=None) float [source]#
评估聚类器的质量。
- 参数:
- 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)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示:
- displaystr,“diagram”(默认)或“text”
jupyter kernel 如何显示 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
在并行化后关闭。 在并行化后关闭。
- “shutdown_ray”:bool,默认为 True;False 可防止
“logger_name”:str,默认为“ray”;要使用的 logger 名称。
“mute_warnings”:bool,默认为 False;如果为 True,则抑制来自
ray
的警告。
- 返回:
- self对 self 的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 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')[source]#
为 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对自身的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。标签是特定于实例
self
的键值对,它们是静态标志,在对象构建后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。应该仅在对象的
__init__
方法中调用set_tags
方法,即在构建期间,或在通过__init__
构建后直接调用。当前的标签值可以通过
get_tags
或get_tag
检查。- 参数:
- tag_dictdict
标签名称: 标签值 对的字典。
- 返回:
- Self
对自身的引用。