BaggingClassifier#
- class BaggingClassifier(estimator, n_estimators=10, n_samples=1.0, n_features=1.0, bootstrap=True, bootstrap_features=False, random_state=None)[source]#
时间序列分类器的 Bagging 集成。
在实例子样本和/或变量子样本组成的数据集上拟合分类器的
n_estimators个克隆。对于
predict_proba,返回概率预测的平均值。对于确定性分类器,这导致predict使用多数投票。该评估器允许选择实例、变量的样本大小以及采样是否带放回。
将
sklearn的BaggingClassifier直接推广到时间序列分类任务。注意:如果
n_features=1,BaggingClassifier将单变量分类器转换为多变量分类器,因为estimator看到的切片都是单变量的。这可以用来赋予单变量分类器多变量处理能力。- 参数:
- estimatorsktime 分类器,BaseClassifier 的后代
在 Bagging 评估器中使用的分类器
- n_estimatorsint,默认为 10
Bagging 中样本里的评估器数量
- n_samplesint 或 float,默认为 1.0
在
fit中从X中提取的实例数量,用于训练每个克隆 如果是 int,则精确指定实例数量 如果是 float,则解释为分数,并向上取整 (ceil)- n_featuresint 或 float,默认为 1.0
在
fit中从X中提取的特征/变量数量,用于训练每个克隆 如果是 int,则精确指定实例数量 如果是 float,则解释为分数,并向上取整 (ceil) 注意:如果 n_features=1,BaggingClassifier 将单变量分类器转换为多变量分类器(因为estimator看到的切片都是单变量的)。- bootstrapboolean,默认为 True
样本/实例是否带放回 (True) 或不带放回 (False) 抽取
- bootstrap_featuresboolean,默认为 False
特征/变量是否带放回 (True) 或不带放回 (False) 抽取
- random_stateint, RandomState 实例或 None,可选(默认为 None)
如果为 int,
random_state是随机数生成器使用的种子; 如果为RandomState实例,random_state是随机数生成器; 如果为 None,则随机数生成器是np.random使用的RandomState实例。
- 属性:
- estimators_sktime 分类器列表
estimator中分类器在集成中拟合的克隆
示例
>>> from sktime.classification.ensemble import BaggingClassifier >>> from sktime.classification.kernel_based import RocketClassifier >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train") >>> X_test, y_test = load_unit_test(split="test") >>> clf = BaggingClassifier( ... RocketClassifier(num_kernels=100), ... n_estimators=10, ... ) >>> clf.fit(X_train, y_train) BaggingClassifier(...) >>> y_pred = clf.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[, cv, change_state])拟合并预测 X 中序列的标签。
fit_predict_proba(X, y[, cv, change_state])拟合并预测 X 中序列的标签概率。
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)预测 X 中序列的标签。
预测 X 中序列的标签概率。
reset()将对象重置为干净的初始化后状态。
save([path, serialization_format])将序列化的自身保存到字节类对象或 (.zip) 文件。
score(X, y)评估预测标签相对于 X 上的真实标签的得分。
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"集。对于分类器,应提供“default”参数集用于通用测试,如果通用集产生的概率不适合比较,则提供“results_comparison”集用于与先前记录的结果进行比较。
- 返回:
- paramsdict 或 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。等同于构造一个具有
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)[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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i},否则为{cls.__name__}。
- fit(X, y)[source]#
将时间序列分类器拟合到训练数据。
- 状态改变
将状态更改为“已拟合” (fitted)。
- 写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
- 参数:
- X与 sktime 兼容的 Panel scitype 时间序列面板数据容器
用于拟合评估器的时间序列。
可以是
Panelscitype 的任何 mtype 格式,例如pd-multiindex: 列为变量的 pd.DataFrame,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panelmtype 格式
mtype 列表请参阅
datatypes.SCITYPE_REGISTER详细说明请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有评估器都支持包含多变量或不等长序列的面板数据,详情请参阅标签参考。
- y与 sktime 兼容的 Table scitype 表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回:
- self指向自身的引用。
- fit_predict(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签。
生成样本内预测和交叉验证的样本外预测的便捷方法。
- 如果 change_state=True,则写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- X与 sktime 兼容的 Panel scitype 时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是
Panelscitype 的任何 mtype 格式,例如pd-multiindex: 列为变量的 pd.DataFrame,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panelmtype 格式
mtype 列表请参阅
datatypes.SCITYPE_REGISTER详细说明请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有评估器都支持包含多变量或不等长序列的面板数据,详情请参阅标签参考。
- y与 sktime 兼容的 Table scitype 表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, 或 sklearn 交叉验证对象,可选,默认为 None
None : 预测是样本内的,等同于
fit(X, y).predict(X)cv : 预测等同于
fit(X_train, y_train).predict(X_test),其中多个X_train,y_train,X_test从cv折叠中获取。返回的y是所有测试折叠预测的并集,cv测试折叠必须不相交int : 等同于
cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证的样本外预测,其中random_statex如果存在则取自self,否则x=None
- change_statebool,可选(默认为 True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,self 不改变
如果为 True,则将自身拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
- 返回:
- y_pred与 sktime 兼容的 Table scitype 表格数据容器
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
如果是单变量 y(一维),则为 1D np.ndarray;否则,与 fit 中传入的 y 类型相同
- fit_predict_proba(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签概率。
生成样本内预测和交叉验证的样本外预测的便捷方法。
- 如果 change_state=True,则写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- X与 sktime 兼容的 Panel scitype 时间序列面板数据容器
用于拟合和预测标签的时间序列。
可以是
Panelscitype 的任何 mtype 格式,例如pd-multiindex: 列为变量的 pd.DataFrame,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panelmtype 格式
mtype 列表请参阅
datatypes.SCITYPE_REGISTER详细说明请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有评估器都支持包含多变量或不等长序列的面板数据,详情请参阅标签参考。
- y与 sktime 兼容的 Table scitype 表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, 或 sklearn 交叉验证对象,可选,默认为 None
None : 预测是样本内的,等同于
fit(X, y).predict(X)cv : 预测等同于
fit(X_train, y_train).predict(X_test),其中多个X_train,y_train,X_test从cv折叠中获取。返回的y是所有测试折叠预测的并集,cv测试折叠必须不相交int : 等同于
cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证的样本外预测,其中random_statex如果存在则取自self,否则x=None
- change_statebool,可选(默认为 True)
如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,self 不改变
如果为 True,则将自身拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)
- 返回:
- y_pred形状为 [n_instances, n_classes] 的 2D int np.array
预测的类别标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类别索引,顺序与 self.classes_ 中相同 条目是预测的类别概率,总和为 1
- 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]#
获取自身的配置标志。
配置是
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_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 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- compositebool
对象的任何参数值是否为
BaseObject的派生实例。
- property is_fitted[source]#
fit是否已被调用。检查对象的
_is_fitted属性,该属性在对象构造期间应初始化为False,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
评估器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object”) 的结果
- 返回:
- 反序列化自身,结果输出到
path,相当于cls.save(path)的输出
- 反序列化自身,结果输出到
- classmethod load_from_serial(serial)[源]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)输出的第一个元素
- serial
- 返回:
- 反序列化自身,结果输出
serial,相当于cls.save(None)的输出
- 反序列化自身,结果输出
- predict(X)[源]#
预测 X 中序列的标签。
- 参数:
- X与 sktime 兼容的 Panel scitype 时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panelscitype 的任何 mtype 格式,例如pd-multiindex: 列为变量的 pd.DataFrame,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panelmtype 格式
mtype 列表请参阅
datatypes.SCITYPE_REGISTER详细说明请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有评估器都支持包含多变量或不等长序列的面板数据,详情请参阅标签参考。
- 返回:
- y_pred与 sktime 兼容的 Table scitype 表格数据容器
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
如果是单变量 y(一维),则为 1D np.ndarray;否则,与 fit 中传入的 y 类型相同
- predict_proba(X)[源]#
预测 X 中序列的标签概率。
- 参数:
- X与 sktime 兼容的 Panel scitype 时间序列面板数据容器
用于预测标签的时间序列。
可以是
Panelscitype 的任何 mtype 格式,例如pd-multiindex: 列为变量的 pd.DataFrame,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panelmtype 格式
mtype 列表请参阅
datatypes.SCITYPE_REGISTER详细说明请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有评估器都支持包含多变量或不等长序列的面板数据,详情请参阅标签参考。
- 返回:
- y_pred形状为 [n_instances, n_classes] 的 2D int np.array
预测的类别标签概率。第 0 个索引对应 X 中的实例索引,第 1 个索引对应类别索引,顺序与 self.classes_ 中的顺序相同。条目是预测类别概率,总和为 1。
- reset()[源]#
将对象重置为干净的初始化后状态。
将自身重置为构造函数调用后的状态,保留相同的超参数。通过
set_config设置的配置值也会被保留。reset调用会删除任何对象属性,除了超参数 = 写入自身的
__init__参数,例如self.paramname,其中paramname是__init__的一个参数包含双下划线,即字符串 “__” 的对象属性。例如,名为 “__myattr” 的属性会被保留。
配置属性,配置会原样保留。也就是说,在
reset之前和之后调用get_config的结果是相同的。
类方法和对象方法,以及类属性也不受影响。
等同于
clone,不同之处在于reset修改自身,而不是返回一个新对象。在调用
self.reset()后,自身的值和状态与构造函数调用type(self)(**self.get_params(deep=False))后获得的对象相同。- 返回:
- self
类实例被重置到干净的初始化后状态,但保留当前超参数值。
- save(path=None, serialization_format='pickle')[源]#
将序列化的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path为 None,则返回内存中的序列化自身;如果path是文件位置,则将自身存储在该位置作为 zip 文件保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即
type(self);_obj - 序列化自身。此类使用默认的序列化方式 (pickle)。- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则自身保存到内存对象;如果为文件位置,则自身保存到该文件位置。如果
path=”estimator”,则会在当前工作目录生成一个 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) float[源]#
评估预测标签相对于 X 上的真实标签的得分。
- 参数:
- X与 sktime 兼容的 Panel scitype 时间序列面板数据容器
用于评分预测标签的时间序列。
可以是
Panelscitype 的任何 mtype 格式,例如pd-multiindex: 列为变量的 pd.DataFrame,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array(任意维度,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panelmtype 格式
mtype 列表请参阅
datatypes.SCITYPE_REGISTER详细说明请参阅
examples/AA_datatypes_and_datasets.ipynb并非所有评估器都支持包含多变量或不等长序列的面板数据,详情请参阅标签参考。
- y与 sktime 兼容的 Table scitype 表格数据容器
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回:
- float,
predict(X)与y相比的准确率分数
- float,
- set_config(**config_dict)[源]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称 : 配置值 对的字典。下面列出了有效的配置、值及其含义
- displaystr,“diagram”(默认)或 “text”
jupyter kernel 如何显示自身的实例
“diagram” = HTML 框图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认值=True
打印自身时,是否只列出与默认值不同的自身参数 (True),或列出所有参数名称和值 (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”:bool,默认值=True;False 会阻止
ray在并行化后 关闭。
- “shutdown_ray”:bool,默认值=True;False 会阻止
“logger_name”:str,默认值=”ray”;要使用的 logger 名称。
“mute_warnings”:bool,默认值=False;如果为 True,则抑制警告
- 返回:
- self对自身的引用。
注意
更改对象状态,将
config_dict中的配置复制到self._config_dynamic。
- set_params(**params)[源]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>可用于复合对象(即包含其他对象的对象),以访问组件<component>中的<parameter>。如果引用明确,也可以使用不带<component>__的字符串<parameter>,例如,没有两个组件的参数具有相同的名称<parameter>。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>字符串。__后缀如果其在 get_params 键中唯一,可以作为完整字符串的别名。
- 返回:
- 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应用于自身的random_state参数,并且仅当deep=True时应用于剩余的组件对象。注意:即使自身没有
random_state参数,或者没有任何组件有random_state参数,也会调用set_params。因此,set_random_state将重置任何 scikit-base 对象,即使是那些没有random_state参数的对象。- 参数:
- random_stateint, RandomState 实例 或 None,默认值=None
伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。
- deepbool,默认为 True
是否在值为 skbase 对象的参数中设置随机状态,即组件评估器。
如果为 False,则仅设置自身的
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)[源]#
将实例级别标签覆盖设置为给定值。
每个与
scikit-base兼容的对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self的键值对,它们是静态标志,在对象构造后不会改变。它们可用于元数据检查,或控制对象的行为。set_tags将动态标签覆盖设置为tag_dict中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags方法只能在对象的__init__方法中,即在构造期间或通过__init__直接构造后调用。当前标签值可以通过
get_tags或get_tag查看。- 参数:
- **tag_dictdict
标签名称 : 标签值 对的字典。
- 返回:
- Self
对自身的引用。