BaseDeepClassifier#

class BaseDeepClassifier[source]#

深度学习时间序列分类器的抽象基类。

该基类为 _predict 和 _predict_proba 提供了一个深度学习默认方法,并为构建模型提供了一个新的抽象方法。

参数:
batch_sizeint, default = 40

模型的训练批次大小

属性:
self.model_ - 拟合的 DL 模型

方法

build_model(input_shape, n_classes, **kwargs)

构建一个已编译、未训练的 keras 模型,该模型已准备好进行训练。

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()

获取 self 的配置标志。

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()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

predict(X)

预测 X 中序列的标签。

predict_proba(X)

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

reset()

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

save([path, serialization_format])

将序列化的 self 保存到类字节对象或 (.zip) 文件中。

score(X, y)

评估 predict(X) 相对于真实标签 y 的得分。

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

summary()

摘要函数,返回模型拟合的损失/指标。

abstract build_model(input_shape, n_classes, **kwargs)[source]#

构建一个已编译、未训练的 keras 模型,该模型已准备好进行训练。

参数:
input_shapetuple

输入层接收的数据形状

n_classes: int

类的数量,将成为输出层的大小

返回:
一个已编译的 Keras 模型
summary()[source]#

摘要函数,返回模型拟合的损失/指标。

返回:
history: dict 或 None,

包含模型训练/验证损失和指标的字典

save(path=None, serialization_format='pickle')[source]#

将序列化的 self 保存到类字节对象或 (.zip) 文件中。

行为:如果 path 为 None,则返回一个内存中的序列化 self;如果 path 是文件,则在该位置存储一个带该名称的 zip 文件。zip 文件的内容为:_metadata - 包含 self 的类,即 type(self)。_obj - 序列化的 self。此类别使用默认序列化 (pickle)。keras/ - 模型、优化器和状态存储在此目录中。history - 序列化的 history 对象。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None,则将 self 保存到内存对象中;如果为文件位置,则将 self 保存到该文件位置。例如:

path=”estimator” 则会在当前工作目录 (cwd) 下生成一个 zip 文件 estimator.zip。path=”/home/stored/estimator” 则会在 /home/stored/ 中存储一个 zip 文件 estimator.zip

serialization_formatstr, default = “pickle”

用于序列化的模块。可用选项在 sktime.base._base.SERIALIZATION_FORMATS 下列出。请注意,非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向该文件的 ZipFile
classmethod load_from_serial(serial)[source]#

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

参数:
serial: ``cls.save(None)`` 输出的第一个元素

这是一个大小为 3 的元组。第一个元素代表 pickle 序列化的实例。第二个元素代表 h5py 序列化的 keras 模型。第三个元素代表 pickle 序列化的 .fit() 的 history。

返回:
由 ``cls.save(None)`` 产生的输出 serial 的反序列化 self
classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialzip 文件的名称。
返回:
由 ``cls.save(path)`` 在 path 产生的输出的反序列化 self
check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等同于使用 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_tagsget_tag 检查当前的标签值。

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 list of str, default = None

要克隆的标签名称。默认值(None)克隆 estimator 的所有标签。

返回:
self

self 的引用。

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

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

参数:
parameter_setstr, default=”default”

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

返回:
instance具有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:
parameter_setstr, default=”default”

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

返回:
objslist of instances of cls

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

nameslist of str, same length as objs

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

fit(X, y)[source]#

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

状态改变

将状态改为“fitted”。

写入 self

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

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 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

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

yTable scitype 的 sktime 兼容表格数据容器

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

返回:
selfReference to self.
fit_predict(X, y, cv=None, change_state=True)[source]#

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

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

写入 self,如果 change_state=True

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

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

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 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

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

yTable scitype 的 sktime 兼容表格数据容器

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

cvNone, int, 或 sklearn 交叉验证对象, 可选, default=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, 可选 (default=True)
  • 如果为 False,则不会改变分类器的状态,即拟合/预测序列使用副本运行,self 不会改变。

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

返回:
y_predTable scitype 的 sktime 兼容表格数据容器

预测的类别标签

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 中序列的标签概率。

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

写入 self,如果 change_state=True

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

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

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

可以是 Panel scitype 的任何 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

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

yTable scitype 的 sktime 兼容表格数据容器

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

cvNone, int, 或 sklearn 交叉验证对象, 可选, default=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, 可选 (default=True)
  • 如果为 False,则不会改变分类器的状态,即拟合/预测序列使用副本运行,self 不会改变。

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

返回:
y_pred2D np.array of int, 形状为 [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 的配置标志。

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

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

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

配置在 clonereset 调用中保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

需要状态为“fitted”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsdict with str-valued keys

已拟合参数的字典,key 为 paramname,value 为 paramvalue。包含:

  • 总是:此对象的所有已拟合参数,通过 get_param_names 获取;值是该 key 对应的已拟合参数值。

  • 如果 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, default=True

是否按字母顺序排序返回参数名称 (True),或按它们在类的 __init__ 中出现的顺序返回 (False)。

返回:
param_names: list[str]

cls 的参数名称列表。如果 sort=False,则按它们在类的 __init__ 中出现的顺序排列。如果 sort=True,则按字母顺序排列。

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称 : 值 dict,包括组件(= BaseObject 值的参数)的参数。

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

返回:
paramsdict with str-valued keys

参数字典,key 为 paramname,value 为 paramvalue。包含:

  • 总是:此对象的所有参数,通过 get_param_names 获取;值是该 key 对应的参数值,始终与构造时传入的值相同。

  • 如果 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 的单个标签值,考虑标签覆盖,优先级降序排列如下:

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

在实例构造时。

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

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

按继承顺序排列。

参数:
tag_namestr

要检索的标签名称

tag_value_default任何类型,可选;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 对象属性中的任何覆盖和新标签。

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

返回估计器的测试参数设置。

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 "default" 集。对于分类器,应提供“default”参数集用于通用测试,提供“results_comparison”参数集用于与先前记录的结果进行比较(如果通用参数集未生成合适的概率进行比较)。

返回:
paramsdict or list of dict, default={}

用于创建类测试实例的参数。每个 dict 是构造一个“有趣的”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典。

is_composite()[source]#

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

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

返回:
composite: bool

对象的任何参数的值是否是 BaseObject 的派生实例。

property is_fitted[source]#

fit 是否已被调用。

检查对象的 _is_fitted` 属性,该属性应在对象构造期间初始化为 ``False,并在调用对象的 fit 方法时设置为 True。

返回:
bool

估计器是否已 fit

predict(X)[source]#

预测 X 中序列的标签。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

要预测标签的时间序列。

可以是 Panel scitype 的任何 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

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

返回:
y_predTable scitype 的 sktime 兼容表格数据容器

预测的类别标签

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

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

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

predict_proba(X)[source]#

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

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

要预测标签的时间序列。

可以是 Panel scitype 的任何 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

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

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

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

reset()[source]#

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

结果是将 self 设置为构造函数调用后立即具有的状态,使用相同的超参数。通过 set_config 设置的配置值也保留。

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

  • 超参数 = __init__ 的参数,写入 self 中,例如 self.paramname,其中 paramname__init__ 的参数。

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

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

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

等同于 clone,不同之处在于 reset 修改 self 而不是返回一个新对象。

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

返回:
self

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

score(X, y float[source]#

评估 predict(X) 相对于真实标签 y 的得分。

参数:
XPanel scitype 的 sktime 兼容时间序列面板数据容器

要评估预测标签的时间序列。

可以是 Panel scitype 的任何 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

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

yTable scitype 的 sktime 兼容表格数据容器

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

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

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

参数:
config_dictdict

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

displaystr, “diagram” (default), 或 “text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = HTML 框图表示

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

print_changed_onlybool, default=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对自身的引用。

Notes

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

set_params(**params)[source]#

设置此对象的参数。

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

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

根据 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,默认值=None

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

deepbool, default=True

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

  • 如果为 False,则仅设置 selfrandom_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

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

返回:
Self

对自身的引用。