实用函数

aeon 有许多专门用于实用工具的模块：

• aeon.pipeline，包含用于管道构建的函数。

• aeon.testing，包含用于估计器测试和数据生成的函数。

• aeon.utils，包含通用的实用函数。

管道

make_pipeline(*steps)	从aeon和sklearn估计器创建管道。
sklearn_to_aeon(estimator)	将sklearn估计器强制转换为aeon管道接口。

测试

数据生成

make_example_3d_numpy([n_cases, n_channels, ...])	随机生成用于测试的3D numpy X和numpy y数据。
make_example_2d_numpy_collection([n_cases, ...])	随机生成用于测试的2D numpy X和numpy y。
make_example_3d_numpy_list([n_cases, ...])	随机生成用于测试的3D numpy X和numpy y列表。
make_example_2d_numpy_list([n_cases, ...])	随机生成用于测试的numpy X和numpy y的二维列表。
make_example_dataframe_list([n_cases, ...])	随机生成用于测试的DataFrame X和numpy y列表。
make_example_2d_dataframe_collection([...])	随机生成用于测试的2D DataFrame X和numpy y。
make_example_multi_index_dataframe([...])	随机生成多索引的pd.DataFrame X和numpy y数据用于测试。
make_example_1d_numpy([n_timepoints, ...])	随机生成一维numpy X。
make_example_2d_numpy_series([n_timepoints, ...])	随机生成2D numpy X。
make_example_pandas_series([n_timepoints, ...])	随机生成pandas Series X。
make_example_dataframe_series([...])	随机生成pandas DataFrame X。

估计器检查

check_estimator(estimator[, ...])	检查估计器是否遵循aeon的约定。
parametrize_with_checks(estimators[, ...])	用于参数化aeon估计器检查的Pytest特定装饰器。

模拟估计器

MockAnomalyDetector()	模拟异常检测器。
MockAnomalyDetectorRequiresFit()	需要拟合的模拟异常检测器。
MockAnomalyDetectorRequiresY()	需要y的模拟异常检测器。
MockClassifier()	用于测试拟合/预测的模拟分类器。
MockClassifierPredictProba()	用于测试 fit/predict/predict_proba 的模拟分类器。
MockClassifierFullTags()	能够处理所有输入类型的模拟分类器。
MockClassifierParams([return_ones, value])	用于测试具有多个参数的拟合/预测的模拟分类器。
MockClassifierComposite([mock])	包含另一个模拟分类器的模拟分类器。
MockCluster()	用于测试基类 fit/predict 的模拟集群。
MockDeepClusterer([estimator, last_file_name])	用于测试空基础深度类保存工具的模拟深度聚类器。
MockCollectionTransformer()	用于测试标签的BasecollectionTransformer。
MockForecaster()	用于测试的模拟预测器。
MockRegressor([random_state])	用于测试基类拟合/预测的虚拟回归器。
MockRegressorFullTags([random_state])	用于测试基类 fit/predict/predict_proba 的虚拟回归器。
MockSegmenter()	用于测试的模拟分段器。
MockSegmenterRequiresY()	用于测试的模拟分段器。
MockSeriesTransformer()	MockSeriesTransformer 用于设置标签。
MockUnivariateSeriesTransformer([constant, ...])	MockSeriesTransformer 向输入序列添加一个随机值和一个常数。
MockMultivariateSeriesTransformer([...])	MockSeriesTransformer 向输入序列添加一个随机值和一个常数。
MockSeriesTransformerNoFit([constant])	MockSeriesTransformerNoFit 向输入系列的所有元素添加一个值。
MockSimilaritySearch([distance, ...])	用于测试基类预测的模拟相似性搜索。

实用工具

deep_equals(x, y[, ignore_index, return_msg])

测试两个对象的值是否相等。

suppress_output([suppress_stdout, ...])

将stdout和/或stderr重定向到devnull。

工具

估计器发现与标签

get_identifier(estimator)

确定估计器的标识符字符串。

all_estimators([type_filter, exclude_types, ...])

从aeon获取所有估计器的列表。

check_valid_tags(estimator[, tags, ...])	检查估计器的标签的有效性。
all_tags_for_estimator(estimator[, names_only])	获取给定估计器或估计器类型的过滤后的标签字典。

数据转换与验证

resolve_equal_length_inner_type(inner_types)	用于等长内部支持类型的偏好层次结构。
resolve_unequal_length_inner_type(inner_types)	不等长内部支持类型的偏好层次结构。
convert_collection(X, output_type)	将兼容的数据结构从一种集合转换为另一种。
convert_series(y, output_type)	将系列 y 转换为指定的 output_type。

is_int(x)	检查x是否为整数类型，但不是布尔类型。
is_float(x)	检查x是否为浮点类型。
is_timedelta(x)	检查x是否为timedelta类型。
is_date_offset(x)	检查x是否为pd.DateOffset类型。
is_timedelta_or_date_offset(x)	检查x是否为timedelta或pd.DateOffset类型。
check_n_jobs(n_jobs)	根据scikit-learn的惯例检查n_jobs参数。
check_window_length(window_length[, ...])	验证窗口长度。
get_n_cases(X)	返回集合中的案例数量。
get_type(X)	获取与不同数据结构相关联的字符串标识符。
is_equal_length(X)	测试X是否包含等长时间序列。
has_missing(X)	检查X是否有缺失值。
is_univariate(X[, is_collection])	检查X是否为多变量。
is_univariate_series(y)	检查序列是否为单变量。
is_single_series(y)	检查输入是否为单一时间序列。
is_collection(X[, include_2d])	检查X是否为有效的集合数据结构。
is_tabular(X)	检查输入是否为二维表格。
is_hierarchical(y)	检查 y 是否在分层数据框中。

Numba

unique_count(X)	用于一维numpy数组的Numba唯一值计数函数。
first_order_differences(X)	用于一维numpy数组的Numba一阶差分函数。
first_order_differences_2d(X)	用于2D numpy数组的Numba一阶差分函数。
first_order_differences_3d(X)	用于3D numpy数组的Numba一阶差分函数。
z_normalise_series_with_mean(X, series_mean)	用于带有均值的1维numpy数组的Numba序列归一化函数。
z_normalise_series(X)	用于一维numpy数组的Numba序列归一化函数。
z_normalise_series_2d(X)	用于2d numpy数组的Numba序列归一化函数。
z_normalise_series_3d(X)	用于3D numpy数组的Numba序列归一化函数。
set_numba_random_seed(seed)	设置numba的随机种子。
choice_log(n_choice, n_sample, random_generator)	使用对数概率而非均匀分布的随机选择函数。
get_subsequence(X, i_start, length, dilation)	从时间序列中获取一个子序列，给定起始索引。
get_subsequence_with_mean_std(X, i_start, ...)	从时间序列中获取一个子序列，其均值和标准差，给定一个起始索引。
sliding_mean_std_one_series(X, length, dilation)	返回X中所有子序列(l,d)的均值和标准差。
combinations_1d(x, y)	返回由x和y连接而成的二维数组的唯一对。
slope_derivative(X)	用于一维numpy数组的Numba斜率导数变换。
slope_derivative_2d(X)	用于2D numpy数组的Numba斜率导数变换。
slope_derivative_3d(X)	用于3D numpy数组的Numba斜率导数变换。
generate_combinations(n, k)	生成n行k列的组合。

mean(X)	用于一维numpy数组的Numba均值函数。
row_mean(X)	用于2D numpy数组的Numba均值函数。
count_mean_crossing(X)	Numba 计算一维 numpy 数组中一阶差分高于均值的次数。
row_count_mean_crossing(X)	计算二维numpy数组的一阶差分均值的Numba计数。
count_above_mean(X)	计算一维numpy数组中高于平均值的元素数量。
row_count_above_mean(X)	计算二维numpy数组中高于平均值的数量。
quantile(X, q)	用于一维numpy数组的Numba分位数函数。
row_quantile(X, q)	用于2D numpy数组的Numba分位数函数。
median(X)	用于一维numpy数组的Numba中位数函数。
row_median(X)	用于2d numpy数组的Numba中值函数。
quantile25(X)	用于一维numpy数组的Numba 0.25分位数函数。
row_quantile25(X)	用于二维numpy数组的Numba 0.25分位数函数。
quantile75(X)	用于一维numpy数组的Numba 0.75分位数函数。
row_quantile75(X)	用于二维numpy数组的Numba 0.75分位数函数。
std(X)	用于一维numpy数组的Numba标准差函数。
std2(X, X_mean)	用于具有预先计算均值的1维numpy数组的Numba标准差函数。
row_std(X)	用于二维numpy数组的Numba标准差函数。
numba_min(X)	用于一维numpy数组的Numba最小函数。
row_numba_min(X)	用于2d numpy数组的Numba最小函数。
numba_max(X)	用于一维numpy数组的Numba最大函数。
row_numba_max(X)	用于2D numpy数组的Numba最大值函数。
slope(X)	用于一维numpy数组的Numba斜率函数。
row_slope(X)	用于2d numpy数组的Numba斜率函数。
iqr(X)	用于一维numpy数组的Numba四分位距函数。
row_iqr(X)	用于二维numpy数组的Numba四分位距函数。
ppv(X)	用于一维numpy数组的正值比例函数。
row_ppv(X)	用于二维numpy数组的Numba正数值比例函数。
fisher_score(X, y)	Numba Fisher 评分函数。
prime_up_to(n)	检查从1到n的任何数字是否为质数，并返回那些是质数的数字。
is_prime(n)	检查输入的数字是否为质数。

haar_transform(x)	对给定信号执行离散哈尔小波变换。
multilevel_haar_transform(x[, levels])	对给定信号执行多级离散哈尔小波变换。

其他

show_versions([as_str])

打印有用的调试信息。

is_sklearn_estimator(obj)	检查 obj 是否是 sklearn 估计器。
sklearn_estimator_identifier(obj[, var_name])	返回sklearn标识符。
is_sklearn_transformer(obj)	检查 obj 是否是 sklearn 转换器。
is_sklearn_classifier(obj)	检查 obj 是否是 sklearn 分类器。
is_sklearn_regressor(obj)	检查 obj 是否是一个 sklearn 回归器。
is_sklearn_clusterer(obj)	检查 obj 是否是 sklearn 聚类器。

split_series(X, n_intervals)

将时间序列分割为大致相等的区间。

sliding_windows(X, window_size[, stride, axis])	创建时间序列的滑动窗口。
reverse_windowing(y, window_size[, ...])	为原始时间序列的每个点聚合窗口结果。