SUOD 项目使用教程

1. 项目的目录结构及介绍

SUOD 项目的目录结构如下：

suod/
├── docs/
├── examples/
├── suod/
│   ├── __init__.py
│   ├── models/
│   ├── utils/
│   └── ...
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── setup.py
└── ...

目录介绍

• docs/: 包含项目的文档文件。
• examples/: 包含使用示例代码。
• suod/: 项目的主要代码目录，包含模型、工具等子目录。
  • models/: 包含各种异常检测模型的实现。
  • utils/: 包含辅助工具和函数。
• tests/: 包含测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

SUOD 项目的启动文件主要是 setup.py，它负责项目的安装和依赖管理。

setup.py

setup.py 文件内容如下：

from setuptools import setup, find_packages

setup(
    name='suod',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        'joblib',
        'numpy>=1.13',
        'pandas',
        'pyod',
        'scipy>=0.19.1',
        'scikit-learn>=1.0'
    ],
    author='Your Name',
    author_email='[e-mail]',
    description='Scalable Unsupervised Outlier Detection',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yzhao062/suod',
    classifiers=[
        'License :: OSI Approved :: BSD License',
        'Programming Language :: Python :: 3.8',
    ],
)

使用方法

通过以下命令安装项目：

pip install .

3. 项目的配置文件介绍

SUOD 项目没有特定的配置文件，但可以通过代码中的参数进行配置。例如，在初始化 SUOD 模型时，可以设置不同的参数：

from suod import SUOD
from pyod.models.lof import LOF
from pyod.models.iforest import IForest

# 初始化一组异常检测器以加速
detector_list = [
    LOF(n_neighbors=15),
    LOF(n_neighbors=20),
    LOF(n_neighbors=25),
    LOF(n_neighbors=35),
    COPOD(),
    IForest(n_estimators=100),
    IForest(n_estimators=200)
]

# 设置并行进程数和组合方法
clf = SUOD(base_estimators=detector_list, n_jobs=2, combination='average', verbose=False)

参数说明

• base_estimators: 一组基础异常检测器。
• n_jobs: 并行进程数。
• combination: 组合方法，如 'average'。
• verbose: 是否显示详细信息。

通过这些参数，可以灵活配置 SUOD 模型以适应不同的需求。