Pyculiarity 开源项目教程
pyculiarity项目地址:https://gitcode.com/gh_mirrors/pyc/pyculiarity
1. 项目的目录结构及介绍
Pyculiarity 是一个用于检测时间序列数据中异常点的 Python 库。项目的目录结构如下:
pyculiarity/
├── LICENSE
├── README.md
├── pyculiarity
│ ├── __init__.py
│ ├── detect_anoms.py
│ ├── preprocessing.py
│ └── util.py
└── setup.py
LICENSE
:项目许可证文件。README.md
:项目说明文档。pyculiarity/
:项目的主要代码目录。__init__.py
:模块初始化文件。detect_anoms.py
:核心功能,用于检测异常点。preprocessing.py
:数据预处理功能。util.py
:工具函数。
setup.py
:用于安装项目的脚本。
2. 项目的启动文件介绍
项目的启动文件是 detect_anoms.py
,它包含了检测异常点的主要功能。以下是该文件的主要内容:
from .preprocessing import preprocess_data
from .util import get_max_outliers
def detect_anoms(data, k=0.49, alpha=0.05, num_obs_per_period=None, use_decomp=True, use_esd=False, direction='both', verbose=False):
# 数据预处理
data = preprocess_data(data)
# 检测异常点
anomalies = []
# 具体检测逻辑
return anomalies
detect_anoms
函数是核心函数,用于检测数据中的异常点。- 参数
data
是输入的时间序列数据。 - 其他参数如
k
,alpha
,num_obs_per_period
等用于控制检测的细节。
3. 项目的配置文件介绍
Pyculiarity 项目没有显式的配置文件,但可以通过函数参数进行配置。例如,在调用 detect_anoms
函数时,可以传入不同的参数来调整检测的行为。
anomalies = detect_anoms(data, k=0.49, alpha=0.05, num_obs_per_period=1440, use_decomp=True, use_esd=False, direction='both', verbose=False)
k
:控制异常点的比例。alpha
:显著性水平。num_obs_per_period
:每个周期的观测数。use_decomp
:是否使用季节性分解。use_esd
:是否使用极端学生化偏差(ESD)方法。direction
:检测异常点的方向('both', 'pos', 'neg')。verbose
:是否输出详细信息。
通过这些参数,用户可以根据具体需求调整异常检测的行为。
pyculiarity项目地址:https://gitcode.com/gh_mirrors/pyc/pyculiarity