BaseCollectionEstimator

class BaseCollectionEstimator

使用时间序列集合进行fit的估计器基类。

提供了一些常见于使用集合的估计器的函数，例如 BaseClassifier, BaseRegressor, BaseClusterer, BaseSimilaritySearch 和 BaseCollectionTransformer。功能包括在相关情况下检查和转换fit, predict 和 predict_proba中的输入。

它还存储了所有子类使用的常见默认标签和描述传递给fit的时间序列特征的元数据。

方法

clone([random_state])	获取具有相同超参数的对象的克隆。
get_class_tag(tag_name[, raise_error, ...])	从估计器类获取标签值（仅限类标签）。
get_class_tags()	从估计器类及其所有父类中获取类标签。
get_fitted_params([deep])	获取拟合参数。
get_metadata_routing()	Sklearn 元数据路由。
get_params([deep])	获取此估计器的参数。
get_tag(tag_name[, raise_error, ...])	从估计器类中获取标签值。
get_tags()	从估计器中获取标签。
reset([keep])	将对象重置为初始化后的干净状态。
set_params(**params)	设置此估计器的参数。
set_tags(**tag_dict)	将动态标签设置为给定值。

clone(random_state=None)

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

克隆是一个没有共享引用的不同对象，处于初始化后的状态。 这个函数等同于返回自身的sklearn.clone。 在值上等同于type(self)(**self.get_params(deep=False))。

Parameters:

random_stateint, RandomState instance, or None, default=None

设置克隆的随机状态。如果为None，则不设置随机状态。 如果为int，random_state是随机数生成器使用的种子。 如果为RandomState实例，random_state是随机数生成器。

Returns:

estimatorobject

type(self) 的实例，self 的克隆（见上文）

classmethod get_class_tag(tag_name, raise_error=True, tag_value_default=None)

从估计器类获取标签值（仅限类标签）。

Parameters:

tag_namestr

标签值的名称。

raise_errorbool, default=True

当未找到标签时是否引发ValueError。

tag_value_defaultany type, default=None

如果未找到标签且未引发错误，则使用默认/回退值。

Returns:

tag_value

cls中tag_name标签的值。 如果未找到，当raise_error为True时返回错误，否则返回tag_value_default。

Raises:

ValueError

如果 raise_error 为 True 并且 tag_name 不在 self.get_tags().keys() 中

示例

>>> from aeon.classification import DummyClassifier
>>> DummyClassifier.get_class_tag("capability:multivariate")
True

classmethod get_class_tags()

从估计器类及其所有父类获取类标签。

Returns:

collected_tagsdict

标签名称和标签值对的字典。 通过嵌套继承从_tags类属性中收集。 这些不会被set_tags或类__init__调用设置的动态标签覆盖。

get_fitted_params(deep=True)

获取拟合参数。

State required:

需要状态为“已拟合”。

Parameters:

deepbool, default=True

如果为True，将返回此估计器的拟合参数以及包含的作为估计器的子对象。

Returns:

fitted_paramsdict

拟合参数名称映射到它们的值。

get_metadata_routing()

Sklearn 元数据路由。

不支持 aeon 估计器。

get_params(deep=True)

获取此估计器的参数。

Parameters:

deepbool, default=True

如果为True，将返回此估计器及其包含的子对象的参数。

Returns:

paramsdict

参数名称映射到它们的值。

get_tag(tag_name, raise_error=True, tag_value_default=None)

从估计器类获取标签值。

包括动态和覆盖的标签。

Parameters:

tag_namestr

要检索的标签名称。

raise_errorbool, default=True

当未找到标签时是否引发ValueError。

tag_value_defaultany type, default=None

如果未找到标签且未引发错误，则使用默认/回退值。

Returns:

tag_value

自身中tag_name标签的值。 如果未找到，当raise_error为True时返回错误，否则返回tag_value_default。

Raises:

ValueError

如果 raise_error 是 True 并且 tag_name 不在 self.get_tags().keys() 中

示例

>>> from aeon.classification import DummyClassifier
>>> d = DummyClassifier()
>>> d.get_tag("capability:multivariate")
True

get_tags()

从估计器中获取标签。

包括动态和覆盖的标签。

Returns:

collected_tagsdict

标签名称和标签值对的字典。 通过嵌套继承从_tags类属性收集，然后从__init__或set_tags中收集任何被覆盖和新添加的标签。

reset(keep=None)

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

在调用self.reset()之后，self的值等于或类似于type(self)(**self.get_params(deep=False))，假设没有使用keep保留其他属性。

Detailed behaviour:

removes any object attributes, except:

超参数（__init__的参数） 包含双下划线的对象属性，即字符串“__”

使用当前超参数的值（get_params的结果）运行__init__

Not affected by the reset are:

包含双下划线的对象属性 类和对象方法，类属性 在keep参数中指定的任何属性

Parameters:

keepNone, str, or list of str, default=None

如果为None，则除了超参数外，所有属性都将被移除。 如果为str，则仅保留具有此名称的属性。 如果为str列表，则仅保留具有这些名称的属性。

Returns:

selfobject

自我引用。

set_params(**params)

设置此估计器的参数。

该方法适用于简单的估计器以及嵌套对象（如Pipeline）。后者具有<component>__<parameter>形式的参数，以便可以更新嵌套对象的每个组件。

Parameters:

**paramsdict

估计器参数。

Returns:

selfestimator instance

估计器实例。

set_tags(**tag_dict)

将动态标签设置为给定值。

Parameters:

**tag_dictdict

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

Returns:

selfobject

自我引用。