FlatDist#

class FlatDist(transformer)[source]#

通过对展平的时间序列应用表格变换获得的面板距离或核函数。

将封装的表格距离或核函数应用于展平的时间序列。展平是将时间序列转换为形状为 (n_instances, (n_vars, n_timepts)) 的二维 numpy 数组。

形式化细节（对于实值对象，混合类型行以此类推）：令 \(d:\mathbb{R}^k \times \mathbb{R}^{k}\rightarrow \mathbb{R}\) 是 transformer 中的成对函数，当应用于 k 向量时（此处，\(d\) 可以是距离函数或核函数）。令 \(x_1, \dots, x_N\in \mathbb{R}^{n \times \ell}\), \(y_1, \dots y_M \in \mathbb{R}^{n \times \ell}\) 为矩阵集合，表示时间序列面板值输入 X 和 X2，如下所示：\(x_i\) 是 X 中的第 i 个实例，\(x_{i, j\ell}\) 是 X 的第 j 个时间点、第 \ell 个变量。对于 \(y\) 和 X2 同理。令 \(f:\mathbb{R}^{n \times \ell} \rightarrow \mathbb{R}^{n \cdot \ell}\) 是按列优先字典序展平矩阵的映射，并假设 \(k = n \cdot \ell\)。

然后，transform(X, X2) 返回一个 \((N \times M)\) 矩阵，其 \((i, j)\) 项为 \(d\left(f(x_i), f(y_j)\right)\)。

参数:
transformer: scitype 为 BasePairwiseTransformer 的成对变换器，或

callable np.ndarray (n_samples, d) x (n_samples, d) -> (n_samples x n_samples)

属性:
is_fitted

是否已调用 fit 方法。

示例

等长时序之间的欧几里得距离，将其视为向量

>>> from sktime.dists_kernels import FlatDist, ScipyDist
>>> euc_tsdist = FlatDist(ScipyDist())

等长时序之间的 Gaussian 核函数，将其视为向量

>>> from sklearn.gaussian_process.kernels import RBF
>>> flat_gaussian_tskernel = FlatDist(RBF())

方法

__call__(X[, X2])

计算距离/核函数矩阵，调用简写。

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, X2])

用于接口兼容性的拟合方法（内部无逻辑）。

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

FlatDist 的测试参数。

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

transform(X[, X2])

计算距离/核函数矩阵。

transform_diag(X)

计算距离/核函数矩阵的对角线。
classmethod get_test_params(parameter_set='default')[source]#

FlatDist 的测试参数。

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

克隆是另一个没有共享引用、处于初始化后状态的对象。此函数等同于返回 self 的 sklearn.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) 设置动态标签覆盖。

仅应在对象的 __init__ 方法中、构造期间，或在构造后通过 __init__ 直接调用 clone_tags 方法。

动态标签设置为 estimator 中标签的值，名称在 tag_names 中指定。

tag_names 的默认行为是将 estimator 中的所有标签写入 self。

当前标签值可通过 get_tags 或 get_tag 查看。

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

参数:
tag_namesstr 或 list of str, 默认 = None
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self
self 的引用。

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

parameter_setstr, 默认=”default”

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

参数:
要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回“default”集合。

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

self
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objs类实例列表

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

参数:
要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回“default”集合。

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

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

names字符串列表，长度与 objs 相同

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

fit(X=None, X2=None)[source]#

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

用于接口兼容性的拟合方法（内部无逻辑）。

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

从类中获取类标签值，包括从父类继承的标签级别。

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

它从对象中返回名称为 tag_name 的标签的值，考虑标签覆盖，按以下降序优先级：

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

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

  2. 按继承顺序。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖，这些覆盖定义在实例上。

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

tag_namestr

参数:
标签值的名称。

tag_value_default任何类型, 可选

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

tag_value

self
self 中 tag_name 标签的值。如果找不到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

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

从类中获取类标签，包括从父类继承的标签级别。

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

clone_tags 从另一个对象 (estimator) 设置动态标签覆盖。

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

值是相应的标签值，按以下降序优先级进行覆盖：

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

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

  2. 按继承顺序。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖，这些覆盖定义在实例上。

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

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

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

collected_tagsdict

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

get_config()[source]#

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

获取对象的配置标志。

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

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

配置在 clone 或 reset 调用中得以保留。

config_dictdict

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

get_fitted_params(deep=True)[source]#

所需状态

获取已拟合参数。

要求状态为“已拟合”（”fitted“）。

deepbool, 默认=True

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

如果为 True，将返回此对象的参数名 : 值字典，包括可拟合组件（即 BaseEstimator 值的参数）的已拟合参数。

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

  • fitted_params键为字符串的字典

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

self
键是 cls 的所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

sortbool, 默认=True

参数:
是按字母顺序返回参数名称 (True)，还是按它们在类 __init__ 中出现的顺序返回 (False)。

param_names: list[str]

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

get_params(deep=True)[source]#

是否返回组件的参数。

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

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

如果为 True，将返回此对象的参数名 : 值 dict，包括组件（= BaseObject 值的参数）的参数。

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

  • params键为字符串的字典

self
参数字典，paramname : paramvalue 键值对包括

始终：此对象的所有参数，如通过 get_param_names 获取，值是该键对应的此对象的参数值，这些值始终与构造时传递的值相同

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

  • 如果 deep=True，还包含任意级别的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

  • classmethod get_param_defaults()[source]#

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，考虑标签覆盖，按以下降序优先级：

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

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

clone_tags 从另一个对象 (estimator) 设置动态标签覆盖。

通过 set_tags 或 clone_tags 在实例上设置的标签，

  1. 在实例构建时。

要检索的标签名称

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

  2. 按继承顺序。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖，这些覆盖定义在实例上。

参数:
标签值的名称。

tag_value_default任何类型, 可选；默认=None

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

raise_errorbool

在找不到标签时是否引发 ValueError

tag_valueAny

self
self 中 tag_name 标签的值。如果找不到，并且 raise_error 为 True，则引发错误；否则返回 tag_value_default。

ValueError, 如果 raise_error 为 True。

引发:
如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

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

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

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

clone_tags 从另一个对象 (estimator) 设置动态标签覆盖。

collected_tagsdict

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

  1. 在实例构建时。

要检索的标签名称

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

  2. 按继承顺序。

不考虑通过 set_tags 或 clone_tags 在实例上设置的动态标签覆盖，这些覆盖定义在实例上。

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

is_composite()[source]#

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

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

composite: bool

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

property is_fitted[source]#

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

是否已调用 fit 方法。

bool

self
估计器是否已 `fit`（拟合）。

classmethod load_from_path(serial)[source]#

serialZipFile(path).open(“object) 的结果

从文件位置加载对象。

参数:
反序列化的对象，结果输出到 path，是 cls.save(path) 的输出。
self
classmethod load_from_serial(serial)[source]#
serialcls.save(None) 输出的第一个元素

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

参数:
反序列化的对象，结果输出为 serial，是 cls.save(None) 的输出。
self
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
self 的引用。

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

行为：如果 path 为 None，返回一个内存中的序列化对象；如果 path 是文件位置，则将对象在该位置存储为 zip 文件

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

保存的文件是 zip 文件，包含以下内容： _metadata - 包含对象所属的类，即 type(self) _obj - 序列化的对象。此类使用默认序列化 (pickle)。

pathNone 或文件位置 (字符串或 Path)

参数:
如果为 None，对象保存到内存中；如果为文件位置，对象保存到该文件位置。如果

path=”estimator”，则在当前工作目录创建 estimator.zip zip 文件。

  • path=”/home/stored/estimator”，则 estimator.zip zip 文件将保存到

  • 存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

如果 path 为 None - 内存中的序列化对象

self
如果 path 是文件位置 - 引用该文件的 ZipFile
set_config(**config_dict)[source]#
配置名 : 配置值对的字典。有效配置、值及其含义如下所示：

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

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

displaystr, “diagram”（默认）或“text”

jupyter kernel 如何显示对象实例

“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”：布尔值，默认=True；False 防止 ray

    • 在并行化后关闭。

      “logger_name”：字符串，默认=”ray”；要使用的 logger 名称。

    • “mute_warnings”：布尔值，默认=False；如果为 True，则抑制警告

    • self对象的引用。

self
注意

更改对象状态，将 config_dict 中的配置复制到 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]#
通过 self.get_params 找到名为 random_state 的参数，并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样，并保证种子随机生成器的伪随机独立性。

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

根据 self_policy 应用于 self 中的 random_state 参数，并且仅当 deep=True 时应用于剩余组件对象。

注意：即使 self 没有 random_state 参数，或者任何组件都没有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是那些没有 random_state 参数的对象。

random_state整数, RandomState 实例或 None, 默认=None

参数:
用于控制随机整数生成的伪随机数生成器。传递整数以实现多次函数调用之间可复现的输出。

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

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

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

  • 如果为 False，则仅设置 self 的 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
self对自身的引用
set_tags(**tag_dict)[来源]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

self
Self

对自身的引用。

transform(X, X2=None)[来源]#

计算距离/核函数矩阵。

行为：返回成对距离/核矩阵

X 和 X2 中的样本之间（如果 X2 未传入，则 X2 等于 X）

参数:
XSeries 或 Panel，任何支持的 mtype，包含 n 个实例
要转换的数据，Python 类型如下

Series: pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D) Panel: 带有两级 MultiIndex 的 pd.DataFrame, pd.DataFrame 列表,

嵌套的 pd.DataFrame, 或 long/wide 格式的 pd.DataFrame

遵循 sktime mtype 格式规范，更多详情请参见

examples/AA_datatypes_and_datasets.ipynb

X2Series 或 Panel，任何支持的 mtype，包含 m 个实例

可选，默认为：X = X2

要转换的数据，Python 类型如下

Series: pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D) Panel: 带有两级 MultiIndex 的 pd.DataFrame, pd.DataFrame 列表,

嵌套的 pd.DataFrame, 或 long/wide 格式的 pd.DataFrame

遵循 sktime mtype 格式规范，更多详情请参见

examples/AA_datatypes_and_datasets.ipynb

X 和 X2 不需要具有相同的 mtype

self
distmat: np.array of shape [n, m]

第 (i,j) 个条目包含 X[i] 和 X2[j] 之间的距离/核

transform_diag(X)[来源]#

计算距离/核函数矩阵的对角线。

行为：返回 X 中样本的距离/核矩阵的对角线

参数:
XSeries 或 Panel，任何支持的 mtype，包含 n 个实例
要转换的数据，Python 类型如下

Series: pd.Series, pd.DataFrame, 或 np.ndarray (1D 或 2D) Panel: 带有两级 MultiIndex 的 pd.DataFrame, pd.DataFrame 列表,

嵌套的 pd.DataFrame, 或 long/wide 格式的 pd.DataFrame

遵循 sktime mtype 格式规范，更多详情请参见

examples/AA_datatypes_and_datasets.ipynb

self
diag: np.array of shape [n]

第 i 个条目包含 X[i] 和 X[i] 之间的距离/核