SeasonalityPeriodogram#

类 SeasonalityPeriodogram(min_period=4, max_period=None, thresh=0.1)[源代码]#

根据其频谱功率对周期性进行评分。

对接 seasonal.periodogram 以确定候选季节性参数。

参数:

min_periodint: 忽略短于此样本数的周期。默认为 4
max_periodint: 忽略长于此样本数的周期。默认为 None
threshfloat (0..1): 保留得分高于 thresh*maxscore 的周期。默认为 0.10

属性:

sp_int，功率最高的季节性周期，如果低于阈值则为 1，否则为该周期。
sp_significant_int 列表，按功率降序排列的傅里叶周期数组: of their powers.

示例

>>> from sktime.datasets import load_airline
>>> from sktime.param_est.seasonality import SeasonalityPeriodogram
>>> X = load_airline().diff()[1:]  
>>> sp_est = SeasonalityPeriodogram()  
>>> sp_est.fit(X)  
SeasonalityPeriodogram(...)
>>> sp_est.get_fitted_params()["sp"]  
6
>>> sp_est.get_fitted_params()["sp_significant"]  
array([6, 12, 14, 4, 10, 5])

方法

`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])	拟合估计器并估计参数。
`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)	从序列化内存容器加载对象。
`reset`()	将对象重置为干净的初始化后状态。
`save`([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
`set_config`(**config_dict)	将配置标志设置为给定值。
`set_params`(**params)	设置此对象的参数。
`set_random_state`([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
`set_tags`(**tag_dict)	将实例级标签覆盖设置为给定值。
`update`(X[, y])	使用更多数据更新已拟合参数。

类方法 get_test_params(parameter_set='default')[源代码]#

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

参数:

parameter_setstr, default=”default”: 返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，则将返回 "default" 集。目前没有为 transformer 保留的值。

返回:

paramsdict 或 dict 列表，默认为 {}: 用于创建类测试实例的参数。每个 dict 都是构造“有趣”测试实例的参数，即 MyClass(**params) 或 MyClass(**params[i]) 会创建一个有效的测试实例。create_test_instance 使用 params 中的第一个（或唯一的）字典。

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果估计器尚未拟合。

clone()[源代码]#

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

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

等同于构造一个新的 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)[源代码]#

将标签从另一个对象克隆为动态覆盖。

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

clone_tags 方法只能在对象的 __init__ 方法中调用，在构造期间，或通过 __init__ 直接构造之后。

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

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

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数:

estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表，默认为 None: 要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:

self: 对 self 的引用。

类方法 create_test_instance(parameter_set='default')[源代码]#

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

参数:

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

返回:

instance具有默认参数的类实例

类方法 create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:

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

返回:

objscls 实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
namesstr 列表，与 objs 长度相同: 第 i 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个，命名约定是 {cls.__name__}-{i}，否则是 {cls.__name__}。

fit(X, y=None)[源代码]#

拟合估计器并估计参数。

状态变化: 将状态更改为“已拟合”。
写入 self: 将 self._is_fitted 标志设置为 True。将 X 写入 self._X。如果 y 不为 None，则将 y 写入 self._y。设置以“_”结尾的已拟合模型属性。

参数:

Xsktime 兼容数据容器格式的时间序列。

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

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 的 Series 类型 pd.DataFrame
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

估计器是否支持面板或分层数据由 scitype 标签 scitype:X 和 scitype:y 决定。

有关数据格式的更多详细信息，请参阅关于 mtype 的术语表。

ysktime 兼容数据容器格式的时间序列。

用于拟合参数估计器的第二个时间序列。

仅当估计器是成对估计器时才需要，即如果标签 capability:pairwise 为 True。

否则输入将被忽略，并且不会抛出异常。

返回:

self对 self 的引用。

类方法 get_class_tag(tag_name, tag_value_default=None)[源代码]#

从类获取类标签值，具有来自父类的标签级别继承。

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

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

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

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

按继承顺序。

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

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

参数:

tag_namestr: 标签值的名称。
tag_value_default任何类型: 如果未找到标签，则为默认/回退值。

返回:

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

类方法 get_class_tags()[源代码]#

从类获取类标签，具有来自父类的标签级别继承。

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

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

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

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

按继承顺序。

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

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

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

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

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

get_config()[源代码]#

获取 self 的配置标志。

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

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

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

配置在 clone 或 reset 调用下保留。

返回:

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

get_fitted_params(deep=True)[源代码]#

获取已拟合参数。

所需状态: 要求状态为“已拟合”。

参数:

deepbool，默认为 True

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

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

返回:

fitted_params带有 str 值键的 dict

已拟合参数字典，参数名称 : 参数值键值对包括

始终：此对象的所有已拟合参数，如通过 get_param_names 获取的那样，值是此对象中该键的已拟合参数值
如果 deep=True，还包含组件参数的键/值对，组件参数的索引为 [组件名称]__[参数名称]，组件名称 的所有参数都显示为 参数名称 及其值
如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

类方法 get_param_defaults()[源代码]#

获取对象的参数默认值。

返回:

default_dict: dict[str, Any]: 键是 cls 中所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

类方法 get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数:

sortbool，默认为 True: 是否按字母顺序（True）或按它们在类 __init__ 中出现的顺序（False）返回参数名称。

返回:

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

get_params(deep=True)[源代码]#

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

参数:

deepbool，默认为 True

是否返回组件参数。

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

返回:

params带有 str 值键的 dict

参数字典，参数名称 : 参数值键值对包括

始终：此对象的所有参数，如通过 get_param_names 获取的那样，值是此对象中该键的参数值，值始终与构造时传递的值相同
如果 deep=True，还包含组件参数的键/值对，组件参数的索引为 [组件名称]__[参数名称]，组件名称 的所有参数都显示为 参数名称 及其值
如果 deep=True，还包含任意级别的组件递归，例如 [组件名称]__[子组件名称]__[参数名称] 等

if deep=True, also contains arbitrary levels of component recursion, e.g., [componentname]__[componentcomponentname]__[paramname], etc

从实例获取标签值，具有标签级别继承和覆盖。

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

get_tag(tag_name, tag_value_default=None, raise_error=True)[源代码]#

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

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

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

按继承顺序。

参数:

tag_namestr: 在实例构造时。
要检索的标签名称: tag_value_default任何类型，可选；默认为 None
raise_errorbool: 未找到标签时是否引发 ValueError

返回:

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

引发:

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

get_tags()[源代码]#

从实例获取标签，具有标签级别继承和覆盖。

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

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

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

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

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

按继承顺序。

返回:

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

is_composite()[源代码]#

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

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

返回:

composite: bool: 对象是否有任何参数的值是 BaseObject 后代实例。

属性 is_fitted[源代码]#

是否已调用 fit。

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

返回:

bool: 估计器是否已 fit。

类方法 load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:

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

返回:

cls.save(path) 在 path 生成的输出的自反序列化

类方法 load_from_serial(serial)[源代码]#

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

参数:

serialcls.save(None) 输出的第一个元素

返回:

cls.save(None) 生成输出 serial 的自反序列化

reset()[源代码]#

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

结果是将 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: 类实例重置为干净的初始化后状态，但保留当前的超参数值。

save(path=None, serialization_format='pickle')[源代码]#

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

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

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

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，self 将保存到内存对象；如果是文件位置，self 将保存到该文件位置。如果

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

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)[源代码]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串打印输出

print_changed_onlybool，默认为 True

self 的打印是否仅列出与默认值不同的 self 参数（True），或所有参数名称和值（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_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 中的配置复制到 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]#

为 self 设置 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 instance 或 None, 默认值=None

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

deepbool，默认为 True

是否在 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)[source]#

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

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

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

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

set_tags 方法应该只在对象的 __init__ 方法中，在构建期间或直接在 __init__ 之后调用。

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数:

**tag_dictdict: 标签名：标签值对的字典。

返回:

Self: 对 self 的引用。

update(X, y=None)[source]#

使用更多数据更新已拟合参数。

如果未实现特定于估计器的更新方法，默认的备用方法是根据目前观察到的所有数据进行拟合

所需状态: 要求状态为“已拟合”。
在 self 中访问: 以 “_” 结尾的拟合模型属性。指向已见数据的指针，self._X self._is_fitted 以 “_” 结尾的模型属性。
写入 self: 通过附加行更新 self._X。更新以 “_” 结尾的拟合模型属性。

参数:

Xsktime 兼容数据容器格式的时间序列。

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

sktime 中的个体数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series scitype = 个体时间序列，普通预测。pd.DataFrame, pd.Series, 或 np.ndarray (1D 或 2D)
Panel scitype = 时间序列集合，全局/面板预测。pd.DataFrame 具有 2 级行 MultiIndex (实例, 时间)，3D np.ndarray (实例, 变量, 时间)，list 的 Series 类型 pd.DataFrame
Hierarchical scitype = 分层集合，用于分层预测。pd.DataFrame 具有 3 级或更多级行 MultiIndex (层级_1, ..., 层级_n, 时间)

估计器是否支持面板或分层数据由 scitype 标签 scitype:X 和 scitype:y 决定。

有关数据格式的更多详细信息，请参阅关于 mtype 的术语表。

ysktime 兼容数据容器格式的时间序列。

用于拟合参数估计器的第二个时间序列。

仅当估计器是成对估计器时才需要，即如果标签 capability:pairwise 为 True。

否则输入将被忽略，并且不会抛出异常。

返回:

self对 self 的引用