TimeSeriesSVC#

class TimeSeriesSVC(kernel=None, kernel_params=None, kernel_mtype=None, C=1, shrinking=True, probability=False, tol=0.001, cache_size=200, class_weight=None, verbose=False, max_iter=-1, decision_function_shape='ovr', break_ties=False, random_state=None)[source]#

支持向量分类器,用于时间序列核函数。

scikit-learn SVC 用于时间序列数据的改编版本。

任何 sktime 成对(pairwise)变换器都可以用作核函数,包括时间序列核函数和对“展平”时间序列的标准核函数。

注意:通常,SVC 文献假设核函数是半正定的。然而,任何成对变换器都可以作为核函数传递,包括距离函数。这仍然会产生分类结果,但性能可能不受保证。

参数:
kernelpairwise panel transformer 或可调用对象,可选,默认值见下文

继承自 BasePairwiseTransformerPanel 的成对面板变换器,或可调用对象,必须具有签名 (X: Panel, X2: Panel) -> np.ndarray 如果 X 是包含 m 个 Series 的 Panel,X2 包含 n 个 Series,则输出必须是 mxn 数组;如果未设置 distance_mtype,则必须能够接受 X, X2pd_multiindexnumpy3D mtype 默认 = 均值欧氏核函数,与 AggrDist(RBF()) 相同,其中 AggrDist 来自 sktimeRBF 来自 sklearn

kernel_paramsdict, 可选。默认 = None.

如果距离是一个可调用对象,则为距离参数的字典

kernel_mtypestr,或 str 列表,可选。默认 = None.

kernel 期望 X 和 X2 的 mtype,如果 kernel 是可调用对象,则仅当 kernel 不是 BasePairwiseTransformerPanel 的后代时设置此参数

Cfloat, 默认=1.0

正则化参数。正则化的强度与 C 成反比。必须是严格正数。惩罚项是平方 L2 惩罚。

shrinkingbool, 默认=True

是否使用 shrinking 启发式算法。

probabilitybool, 默认=False

是否启用概率估计。必须在调用 fit 之前启用此选项,因为它内部使用 5 折交叉验证,会减慢该方法的速度,并且 predict_proba 可能与 predict 不一致。

tolfloat, 默认=1e-3

停止标准的容差。

cache_sizefloat, 默认=200

指定核函数缓存的大小(单位 MB)。

class_weightdict 或 ‘balanced’,默认=None

为 SVC 设置类 i 的参数 C 为 class_weight[i]*C。如果未给出,所有类都假定权重为 1。“balanced”模式使用 y 的值根据输入数据中类频率的倒数自动调整权重,计算公式为 n_samples / (n_classes * np.bincount(y))

verbosebool, 默认=False

启用详细输出。请注意,此设置利用了 libsvm 中按进程划分的运行时设置,如果启用,在多线程环境中可能无法正常工作。

max_iterint, 默认=-1

求解器内部迭代的硬限制,或 -1 表示无限制。

decision_function_shape{'ovo', 'ovr'}, 默认=’ovr’

是否返回一个形状为 (n_samples, n_classes) 的一对多 (‘ovr’) 决策函数(与其他所有分类器一样),还是返回 libsvm 原始的形状为 (n_samples, n_classes * (n_classes - 1) / 2) 的一对一 (‘ovo’) 决策函数。然而,一对一 (‘ovo’) 始终用作多类策略。此参数对于二分类会被忽略。

break_tiesbool, 默认=False

如果为 true,decision_function_shape='ovr',并且类别数 > 2,则 predict 将根据 decision_function 的置信度值来打破平局;否则返回平局类别中的第一个类别。请注意,打破平局相比简单预测会带来相对较高的计算成本。

random_stateint, RandomState 实例或 None, 默认=None

控制用于打乱数据以进行概率估计的伪随机数生成。当 probability 为 False 时忽略。传递一个 int 值可以在多次函数调用中获得可重现的输出。

属性:
is_fitted

是否已调用 fit

示例

>>> from sktime.classification.kernel_based import TimeSeriesSVC
>>> from sklearn.gaussian_process.kernels import RBF
>>> from sktime.dists_kernels import AggrDist
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(return_X_y=True, split="train")
>>> X_test, y_test = load_unit_test(return_X_y=True, split="test")
>>>
>>> mean_gaussian_tskernel = AggrDist(RBF())
>>> classifier = TimeSeriesSVC(kernel=mean_gaussian_tskernel)
>>> classifier.fit(X_train, y_train)
TimeSeriesSVC(...)
>>> y_pred = classifier.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()

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

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 列表,默认={}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在对象的 fit 方法调用中,is_fitted 属性应设置为 True

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

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

引发:
如果克隆不符合规范,则引发 RuntimeError,因为 __init__ 有错误。
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。设置以“_”结尾的拟合模型属性。

参数:
X sktime 兼容的时间序列面板数据容器,scitype 为 Panel

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

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

并非所有估计器都支持多变量或不等长序列的面板,详情请参见 tag 参考

y sktime 兼容的表格数据容器,scitype 为 Table

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,则不更新状态。

参数:
X sktime 兼容的时间序列面板数据容器,scitype 为 Panel

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

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

并非所有估计器都支持多变量或不等长序列的面板,详情请参见 tag 参考

y sktime 兼容的表格数据容器,scitype 为 Table

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_state x 取自 self(如果存在),否则 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 中的多输出向量索引。

如果 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,则不更新状态。

参数:
X sktime 兼容的时间序列面板数据容器,scitype 为 Panel

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

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

并非所有估计器都支持多变量或不等长序列的面板,详情请参见 tag 参考

y sktime 兼容的表格数据容器,scitype 为 Table

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

change_statebool, 可选 (默认=True)
  • 如果为 False,将不会改变分类器的状态,即 fit/predict 序列是使用副本运行的,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 的键值对,通常用作控制行为的瞬态标志。

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

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

配置在 clonereset 调用时保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, 默认=True

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

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

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

返回:
fitted_params键为 str 的 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,但不包括组件的参数。

返回:
params键为 str 的 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 的单个标签值,考虑标签覆盖,优先级降序排列如下:

  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]#

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

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

返回:
composite: bool

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

property is_fitted[source]#

是否已调用 fit

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

返回:
bool

估计器是否已 拟合

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object”) 的结果
返回:
反序列化的自身,结果是 cls.save(path)path 处的输出
classmethod load_from_serial(serial)[source]#

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

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

预测 X 中序列的标签。

参数:
X sktime 兼容的时间序列面板数据容器,scitype 为 Panel

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

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

并非所有估计器都支持多变量或不等长序列的面板,详情请参见 tag 参考

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

预测的类别标签

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

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

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

predict_proba(X)[source]#

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

参数:
X sktime 兼容的时间序列面板数据容器,scitype 为 Panel

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

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

并非所有估计器都支持多变量或不等长序列的面板,详情请参见 tag 参考

返回:
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”的属性将被保留。

  • config 属性,configs 会保留不变。也就是说,调用 get_config 在调用 reset 前后的结果是相同的。

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

等同于 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” 时,将在

/home/stored/ 中存储一个 zip 文件 estimator.zip

serialization_format: str, 默认值 = “pickle”

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

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

评估预测标签与 X 上的真实标签的得分。

参数:
X sktime 兼容的时间序列面板数据容器,scitype 为 Panel

要为其预测标签的时间序列。

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

并非所有估计器都支持多变量或不等长序列的面板,详情请参见 tag 参考

y sktime 兼容的表格数据容器,scitype 为 Table

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

config 名称 : config 值对的字典。有效的 configs、值及其含义如下所述:

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 方框图表示

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

print_changed_onlybool, 默认值=True

打印 self 时,是否只列出与默认值不同的 self 参数 (False),或列出所有参数名称和值 (False)。不嵌套,即只影响 self 而不影响组件 estimator。

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, 可选, 默认值={} (未传递参数)

作为 config 传递给并行化后端的额外参数。有效键取决于 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对 self 的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**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, 默认=None

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

deepbool, 默认=True

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

  • 如果为 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对 self 的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。