WeightedEnsembleClassifier#

class WeightedEnsembleClassifier(classifiers, weights=None, cv=None, metric=None, metric_type='point', random_state=None)[source]#

带有可拟合集成权重的加权分类器集成。

生成概率预测,该预测是个体分类器预测的加权平均。名称为 name 的分类器在 weights_[name] 中具有集成权重。如果 weights 是标量,则 weights_fit 中进行拟合,否则固定。

如果 weights 是标量,则计算每个分类器的经验训练损失。在这种情况下,分类器的集成权重是经验损失的 weights 次幂(标量)。

可以通过 metricmetric_type 参数选择经验训练损失的评估方法。

样本内经验训练损失根据 cv 参数计算,可以是样本内或样本外。None = 样本内;其他 = 交叉验证的样本外。

参数:
classifiersdict 或 None,默认=None

ShapeletTransformClassifier 模块的参数。如果为 None,则使用默认参数,并使用 2 小时转换契约。

weightsfloat,或 float 可迭代对象,可选,默认=None

如果为 float,则分类器 i 的集成权重将是训练分数对此数值的幂;如果为 float 可迭代对象,则必须与分类器的长度相同

分类器 i 的集成权重将是 weights[i]

如果为 None,则集成权重相等(均匀平均)

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_state x 如果存在则取自 self,否则 x=None

metric用于计算训练分数的 sklearn 指标,默认=accuracy_score

仅在 weights 为 float 时使用

metric_typestr,取值“point”或“proba”之一,默认=”point”

sklearn 指标的类型,点预测(“point”)或概率(“proba”) 如果为“point”,则将最可能类别作为 y_pred 传递 如果为“proba”,则将最可能类别的概率作为 y_pred 传递

random_stateint 或 None,默认=None

用于随机数生成的种子。

属性:
classifiers_sktime 分类器的元组列表 (str, classifier)

classifiers 中分类器的克隆,它们在集成中进行拟合 始终采用 (str, classifier) 格式,即使 classifiers 只是一个列表 未在 classifiers 中传递的字符串将被唯一的生成字符串替换 classifier_ 中的第 i 个分类器是 classifier 中第 i 个分类器的克隆

weights_dict,其中 str 为分类器名称,与 classifiers_ 中的名称相同

键对应的值是名称为 key 的分类器的集成权重 如果 weights 是标量,则集成权重在 fit 中进行拟合

示例

>>> from sktime.classification.dummy import DummyClassifier
>>> 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 = WeightedEnsembleClassifier(
...     [DummyClassifier(), RocketClassifier(num_kernels=100)],
...     weights=2,
... ) 
>>> clf.fit(X_train, y_train) 
WeightedEnsembleClassifier(...)
>>> 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_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()

检查对象是否是组合对象。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

predict_proba(X)

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

reset()

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

save([path, serialization_format])

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

score(X, y) float

在 X 上根据真实标签对预测标签进行评分。

set_config(**config_dict)

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

set_params(**kwargs)

设置评估器的参数。

set_random_state([random_state, deep, ...])

为自身设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr,可选

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

引发:
未拟合错误

如果评估器尚未拟合。

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是一个没有共享引用、处于初始化后状态的独立对象。此函数等同于返回 sklearn.cloneself

等同于构造一个 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_tagsget_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)[source]#

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

状态更改

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

写入 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

有关 mtypes 列表,请参见 datatypes.SCITYPE_REGISTER

有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有评估器都支持具有多变量或不等长序列的面板数据,详情请参见标签参考

ysktime 兼容的表格数据容器,类型为 Table scitype

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类别标签 第 0 个索引对应于 X 中的实例索引 第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
self对 self 的引用。
fit_predict(X, y, cv=None, change_state=True)[source]#

拟合并预测 X 中序列的标签。

方便的方法,用于生成样本内预测和交叉验证的样本外预测。

写入 self,如果 change_state=True

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

如果 change_state=False,则不更新状态。

参数:
Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype

用于拟合和预测标签的时间序列。

可以是 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

并非所有评估器都支持具有多变量或不等长序列的面板数据,详情请参见标签参考

ysktime 兼容的表格数据容器,类型为 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_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须互不相交

  • int:等同于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证样本外预测,其中 random_state x 如果存在则取自 self,否则 x=None

change_statebool,可选 (默认=True)
  • 如果为 False,则不会更改分类器的状态,即 fit/predict 序列使用副本运行,self 不会更改

  • 如果为 True,则将 self 拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)

返回:
y_predsktime 兼容的表格数据容器,类型为 Table scitype

预测的类别标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。

1D np.ndarray,如果 y 是单变量(一维);否则,与 fit 中传递的 y 类型相同

fit_predict_proba(X, y, cv=None, change_state=True)[source]#

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

方便的方法,用于生成样本内预测和交叉验证的样本外预测。

写入 self,如果 change_state=True

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

如果 change_state=False,则不更新状态。

参数:
Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype

用于拟合和预测标签的时间序列。

可以是 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

并非所有评估器都支持具有多变量或不等长序列的面板数据,详情请参见标签参考

ysktime 兼容的表格数据容器,类型为 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_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须互不相交

  • int:等同于 cv=KFold(cv, shuffle=True, random_state=x),即 k 折交叉验证样本外预测,其中 random_state x 如果存在则取自 self,否则 x=None

change_statebool,可选 (默认=True)
  • 如果为 False,则不会更改分类器的状态,即 fit/predict 序列使用副本运行,self 不会更改

  • 如果为 True,则将 self 拟合到完整的 X 和 y,最终状态将等同于运行 fit(X, y)

返回:
y_predint 的 2D np.array,形状为 [n_instances, n_classes]

预测的类别标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类别索引,顺序与 self.classes_ 中相同 条目是预测类别概率,总和为 1

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类获取类标签值,并继承父类的标签级别。

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

get_class_tag 方法是一个类方法,它在仅考虑类级别标签值和覆盖的情况下检索标签的值。

它从对象中返回名称为 tag_name 的标签的值,考虑标签覆盖,优先级从高到低如下

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

要检索具有潜在实例覆盖的标签值,请改用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签,则使用的默认/回退值。

返回:
tag_value

selftag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[source]#

从类获取类标签,并继承父类的标签级别。

每个与 scikit-base 兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

get_class_tags 方法是一个类方法,它在仅考虑类级别标签值和覆盖的情况下检索标签的值。

它返回一个字典,其键是在类或其任何父类中设置的 _tags 任何属性的键。

值是相应的标签值,覆盖优先级从高到低如下

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

实例可以根据超参数覆盖这些标签。

要检索具有潜在实例覆盖的标签,请改用 get_tags 方法。

不考虑通过 set_tagsclone_tags 在实例上设置的动态标签覆盖。

要包含来自动态标签的覆盖,请使用 get_tags

collected_tagsdict

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

get_config()[source]#

获取自身的配置标志。

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

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

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

配置在 clonereset 调用下保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合的参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool,默认=True

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

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

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

返回:
fitted_params键为 str 的字典

已拟合参数字典,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]#

获取评估器的参数。

参数:
deep布尔值,可选

如果为 True,将返回此评估器及其包含的子对象(即评估器)的参数。

返回:
params字符串到任意类型的映射

参数名称映射到其值。

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值,包括标签级别继承和覆盖。

每个与 scikit-base 兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,考虑标签覆盖,优先级从高到低如下

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型,可选;默认=None

如果未找到标签,则使用的默认/回退值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

selftag_name 标签的值。如果未找到,则在 raise_error 为 True 时引发错误,否则返回 tag_value_default

引发:
ValueError,如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则会引发 ValueError

get_tags()[source]#

从实例获取标签,包括标签级别继承和覆盖。

每个与 scikit-base 兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会更改的静态标志。

get_tags 方法返回一个标签字典,其键是在类或其任何父类中设置的 _tags 任何属性的键,或通过 set_tagsclone_tags 设置的标签。

值是相应的标签值,覆盖优先级从高到低如下

  1. 通过 set_tagsclone_tags 在实例上设置的标签,

在实例构造时。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

返回:
collected_tagsdict

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

is_composite()[source]#

检查对象是否是组合对象。

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

返回:
composite: bool,表示 self 是否包含一个 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) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self,其结果是输出 serial,即 cls.save(None) 的输出
predict(X)[source]#

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

有关 mtypes 列表,请参见 datatypes.SCITYPE_REGISTER

有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有评估器都支持具有多变量或不等长序列的面板数据,详情请参见标签参考

返回:
y_predsktime 兼容的表格数据容器,类型为 Table scitype

预测的类别标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。

1D np.ndarray,如果 y 是单变量(一维);否则,与 fit 中传递的 y 类型相同

predict_proba(X)[source]#

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

有关 mtypes 列表,请参见 datatypes.SCITYPE_REGISTER

有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有评估器都支持具有多变量或不等长序列的面板数据,详情请参见标签参考

返回:
y_predint 的 2D np.array,形状为 [n_instances, n_classes]

预测的类别标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类别索引,顺序与 self.classes_ 中相同 条目是预测类别概率,总和为 1

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”,则将创建 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str,默认值 = “pickle”

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

返回:
如果 path 为 None - 在内存中序列化自身
如果 path 为文件位置 - 包含文件引用的 ZipFile
score(X, y) float[source]#

在 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

有关 mtypes 列表,请参见 datatypes.SCITYPE_REGISTER

有关规范,请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有评估器都支持具有多变量或不等长序列的面板数据,详情请参见标签参考

ysktime 兼容的表格数据容器,类型为 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 相比的准确率得分
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

displaystr,"diagram"(默认)或 "text"

jupyter 内核如何显示对象的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool,默认值=True

打印对象时是否仅列出与默认值不同的自身参数(为 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”:bool,默认值=True;False 防止 ray

      并行化后关闭。

    • “logger_name”:str,默认值=“ray”;要使用的日志记录器的名称。

    • “mute_warnings”:bool,默认值=False;如果为 True,则抑制警告

返回:
self自身引用。

注意

更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic

set_params(**kwargs)[source]#

设置评估器的参数。

有效的参数键可以通过 get_params() 列出。

返回:
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 从链式哈希中采样,并保证种子随机生成器的伪随机独立性。

根据 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)[source]#

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中调用,即在构建期间或通过 __init__ 直接构建之后。

当前标签值可以通过 get_tagsget_tag 查看。

参数:
**tag_dictdict

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

返回:
自身

自身引用。

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 中的第一个(或唯一的)字典。