统计摘要分类器#

class SummaryClassifier(summary_functions=('mean', 'std', 'min', 'max'), summary_quantiles=(0.25, 0.5, 0.75), estimator=None, n_jobs=1, random_state=None)[source]#

统计摘要分类器。

该分类器仅使用 SummaryTransformer 变换器对输入数据进行变换,并使用变换后的数据构建提供的估计器。

参数::
summary_functionsstr, list, tuple, 默认为 (“mean”, “std”, “min”, “max”)

可以是字符串,也可以是字符串列表或元组,表示用于汇总数据集每列的 pandas 汇总函数。必须是 (“mean”, “min”, “max”, “median”, “sum”, “skew”, “kurt”, “var”, “std”, “mad”, “sem”, “nunique”, “count”) 之一。

summary_quantilesstr, list, tuple 或 None, 默认为 (0.25, 0.5, 0.75)

可选的序列分位数列表,用于计算。如果为 None,则不计算任何分位数。

estimatorsklearn 分类器, 默认为 None

一个 sklearn 估计器,用于使用变换后的数据构建。默认为具有 200 棵树的随机森林。

n_jobsint, 默认为 1

对于 fitpredict,并行运行的作业数量。-1 表示使用所有处理器。

random_stateint 或 None, 默认为 None

随机种子,整数。

属性::
n_classes_int

类别数量。从数据中提取。

classes_ndarray, 形状为 (n_classes)

保存每个类别的标签。

另请参阅

统计摘要变换器

示例

>>> from sktime.classification.feature_based import SummaryClassifier
>>> from sklearn.ensemble import RandomForestClassifier
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train", return_X_y=True)
>>> X_test, y_test = load_unit_test(split="test", return_X_y=True)
>>> clf = SummaryClassifier(estimator=RandomForestClassifier(n_estimators=5))
>>> clf.fit(X_train, y_train)
SummaryClassifier(...)
>>> 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()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

predict_proba(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 属性是否存在且为 Trueis_fitted 属性在调用对象的 fit 方法时应设置为 True

如果不是,则抛出 NotFittedError

参数::
method_namestr, 可选

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

抛出::
未拟合错误

如果估计器尚未拟合。

clone()[source]#

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

克隆是具有相同超参数和配置但没有共享引用,处于初始化后状态的另一个对象。此函数等效于返回 selfsklearn.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 兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。

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

返回::
对自身的引用。

classmethod create_test_instance(parameter_set='default')[source]#

要返回的测试参数集名称,用于测试。如果某个值没有定义特殊参数,则返回 “default” 集。

使用第一个测试参数集构建类的实例。

参数::
parameter_setstr, 默认为”default”

instance具有默认参数的类的实例

返回::
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例列表

创建所有测试实例列表及其名称列表。

参数::
parameter_setstr, 默认为”default”

instance具有默认参数的类的实例

返回::
第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表, 长度与 objs 相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

fit(X, y)[source]#

状态改变

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

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

写入自身

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

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

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

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

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

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对自身的引用。

返回::
fit_predict(X, y, cv=None, change_state=True)[source]#
生成样本内预测和交叉验证样本外预测的便捷方法。

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

如果 change_state=True,则写入 self

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

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

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

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

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认为 None

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

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

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对自身的引用。

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 折交叉验证样本外预测,并且如果 self 中存在 random_state x,则使用 self 中的 x,否则 x=None

  • change_statebool, 可选 (默认为 True)

如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,self 不改变
  • 如果为 True,则将 self 拟合到完整的 X 和 y,最终状态等效于运行 fit(X, y)

  • y_predsktime 兼容的表格数据容器,scitype Table 类型

返回::
预测的类别标签

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

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

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

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

y_pred2D np.array of int, 形状为 [n_instances, n_classes]

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

如果 change_state=True,则写入 self

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

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

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

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

cvNone, int, 或 sklearn 交叉验证对象, 可选, 默认为 None

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

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

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对自身的引用。

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 折交叉验证样本外预测,并且如果 self 中存在 random_state x,则使用 self 中的 x,否则 x=None

  • change_statebool, 可选 (默认为 True)

如果为 False,则不会改变分类器的状态,即 fit/predict 序列使用副本运行,self 不改变
  • 如果为 True,则将 self 拟合到完整的 X 和 y,最终状态等效于运行 fit(X, y)

  • y_predsktime 兼容的表格数据容器,scitype Table 类型

返回::
预测的类别标签概率,第 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 属性中设置的标签。

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

  2. 按继承顺序。

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

要检索可能包含实例覆盖的标签值,请改用 get_tag 方法。

tag_namestr

参数::
标签值的名称。

tag_value_default任何类型

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

tag_value

返回::
self 中 tag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。

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

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

clone_tags 设置来自另一个对象 estimator 的动态标签覆盖。

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

值是对应的标签值,覆盖按以下优先级降序排列:

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

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

  2. 按继承顺序。

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

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

collected_tagsdict

要检索可能包含实例覆盖的标签值,请改用 get_tag 方法。

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

get_config()[source]#

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

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

获取自身的配置标志。

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

配置在 clonereset 调用下保留。

config_dictdict

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

返回::
get_fitted_params(deep=True)[source]#

所需状态

要求状态为“已拟合”。

获取拟合参数。

deepbool, 默认为 True

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

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

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

  • fitted_params键为字符串的字典

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

是否返回组件的参数。

如果 True,则返回此对象的参数名称 : 值 的字典,包括组件(= BaseObject 值参数)的参数。

获取此对象的参数值字典。

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

如果 False,则返回此对象的参数名称 : 值 的字典,但不包括组件的参数。

  • params键为字符串的字典

  • 参数字典,paramname : paramvalue 键值对包括

返回::
始终:此对象的所有参数,如通过 get_param_names 获取的值是该键的参数值,此对象的值始终与构造时传递的值相同

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

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

  • classmethod get_param_defaults()[source]#

  • 获取对象的参数默认值。

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

从实例中获取标签值,并应用标签级别继承和覆盖。

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

clone_tags 设置来自另一个对象 estimator 的动态标签覆盖。

在实例构造时。

  1. 要检索的标签名称

tag_value_default任何类型, 可选; 默认为 None

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

  2. 按继承顺序。

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

参数::
标签值的名称。

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

raise_errorbool

未找到标签时是否抛出 ValueError

tag_value任何类型

self 中 tag_name 标签的值。如果未找到,并且 raise_error 为 True,则抛出错误,否则返回 tag_value_default

返回::
ValueError, 如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则抛出 ValueError

抛出::
get_tags()[source]#

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

collected_tagsdict

从实例中获取标签,并应用标签级别继承和覆盖。

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

clone_tags 设置来自另一个对象 estimator 的动态标签覆盖。

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

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

  1. 要检索的标签名称

tag_value_default任何类型, 可选; 默认为 None

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

  2. 按继承顺序。

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

返回::
is_composite()[source]#

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

composite: bool

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

对象是否有任何参数的值是 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]#
返回::
用于预测标签的时间序列。
predict_proba(X)[source]#

预测 X 中序列的标签。

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

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

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

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

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

返回::
预测的类别标签

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

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

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

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

reset()[source]#

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

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

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

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

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

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

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

self 设置为构造函数调用后直接拥有的状态,具有相同的超参数。通过 set_config 设置的配置值也会被保留。

reset 调用会删除所有对象属性,除了

将对象重置为初始状态。

超参数 = 写入 self__init__ 参数,例如 self.paramname,其中 paramname__init__ 的一个参数

包含双下划线的对象属性,即字符串“__”。例如,名为“__myattr”的属性会被保留。

  • 配置属性,配置会保持不变。也就是说,reset 前后 get_config 的结果是相等的。

  • 类和对象方法以及类属性也不受影响。

  • 配置属性(config attributes)和配置(configs)保持不变。也就是说,在 reset 前后 get_config 的结果是相同的。

类和对象方法,以及类属性也不受影响。

等同于 clone,但有一个例外:reset 会改变 self 本身,而不是返回一个新对象。

调用 self.reset() 后,self 的值和状态与调用构造函数 ``type(self)(**self.get_params(deep=False))`` 后获得的对象相同。

返回::
对自身的引用。

类的实例被重置为初始化后的干净状态,但保留当前超参数值。

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)创建一个 estimator.zip zip 文件。

  • 如果 path=”/home/stored/estimator”,则 estimator.zip zip 文件将存储在

/home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

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

根据 X 上的真实标签评估预测标签。

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

用于计算预测标签得分的时间序列。

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

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

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对自身的引用。

返回::
float,predict(X) 与 y 相比的准确率得分
set_config(**config_dict)[source]#

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

参数::
get_fitted_params(deep=True)[source]#

配置名称 : 配置值的字典。下面列出了有效的配置、值及其含义。

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

jupyter 内核如何显示 self 的实例

  • “diagram” = HTML 框图表示

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

print_changed_onlybool, default=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_jobsbackend 在此情况下必须作为 backend_params 的一个键传递。如果未传递 n_jobs,则默认为 -1,其他参数将默认为 joblib 的默认值。

  • “dask”: 可以传递 dask.compute 的任何有效键,例如 scheduler

  • “ray”: 可以传递以下键

    • “ray_remote_args”: ray.init 的有效键字典

    • “shutdown_ray”: bool, default=True; False 可防止 ray 在并行化后

      关闭。

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

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

返回::
self对 self 的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象和复合对象。参数键字符串 <component>__<parameter> 可用于复合对象(即包含其他对象的对象),以访问组件 <component> 中的 <parameter>。如果引用明确(例如,没有两个组件参数具有相同的名称 <parameter>),也可以使用字符串 <parameter>,而不带 <component>__

参数::
**paramsdict

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

根据 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, default=None

伪随机数生成器,用于控制随机整数的生成。传递 int 值可在多次函数调用中获得可重现的输出。

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

是否在 skbase 对象值参数中设置随机状态,即组件估计器。

  • 如果为 False,则仅设置 selfrandom_state 参数(如果存在)。

  • 如果为 True,则也会设置组件对象中的 random_state 参数。

self_policystr, 以下之一: {“copy”, “keep”, “new”}, default=”copy”
  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持不变

  • “new” : self.random_state 设置为一个新的随机状态,

该状态从输入的 random_state 派生,并且通常与它不同

返回::
self对 self 的引用
set_tags(**tag_dict)[source]#

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

get_class_tag 方法是一个类方法,仅考虑类级别的标签值和覆盖来检索标签的值。

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

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

应仅在对象的 __init__ 方法中、构造期间或直接在 __init__ 之后调用 set_tags 方法。

estimator:class:BaseObject 或派生类的实例

参数::
**tag_dictdict

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

返回::
Self

对 self 的引用。