EGADS 项目使用教程

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

EGADS（Extensible Generic Anomaly Detection System）是一个用于自动检测大规模时间序列数据中异常的开源Java包。以下是EGADS项目的目录结构及其介绍：

egads/
├── doc/
│   └── 项目文档和说明文件
├── lib/
│   └── Synthetic_Anomalies/
│       └── 合成异常数据相关文件
├── src/
│   └── 项目源代码
├── .gitignore
├── travis.yml
├── LICENSE
├── README.md
├── pom.xml
└── screwdriver.yaml

目录结构说明：

• doc/：包含项目的文档和说明文件。
• lib/Synthetic_Anomalies/：包含合成异常数据的相关文件。
• src/：项目的源代码目录。
• .gitignore：Git忽略文件配置。
• travis.yml：Travis CI配置文件。
• LICENSE：项目许可证文件。
• README.md：项目介绍和使用说明。
• pom.xml：Maven项目配置文件。
• screwdriver.yaml：Screwdriver CI配置文件。

2. 项目的启动文件介绍

EGADS项目的启动文件主要是通过Java命令行来运行。以下是启动EGADS的示例命令：

java -Dlog4j.configurationFile=src/test/resources/log4j2.xml -cp target/egads-*-jar-with-dependencies.jar com.yahoo.egads.Egads src/test/resources/sample_config.ini src/test/resources/sample_input.csv

启动文件说明：

• log4j.configurationFile：指定Log4j2的配置文件路径。
• cp：指定包含所有依赖的JAR文件路径。
• com.yahoo.egads.Egads：EGADS的主类。
• sample_config.ini：配置文件路径。
• sample_input.csv：输入数据文件路径。

3. 项目的配置文件介绍

EGADS的配置文件通常是一个INI格式的文件，用于指定各种参数和模型配置。以下是一个示例配置文件的内容及其说明：

# 只显示不早于这个时间的异常
# 如果设置为0，则只输出最后一个时间戳的异常
MAX_ANOMALY_TIME_AGO = 999999999

# 表示时间序列应按多少进行聚合
# 如果设置为1或更小，则忽略此设置
AGGREGATION = 1

# OP_TYPE指定操作类型
# 选项：DETECT_ANOMALY, UPDATE_MODEL, TRANSFORM_INPUT
OP_TYPE = DETECT_ANOMALY

# TS_MODEL指定时间序列模型类型
# 选项：AutoForecastModel, DoubleExponentialSmoothingModel, MovingAverageModel, MultipleLinearRegressionModel, NaiveForecastingModel, OlympicModel, PolynomialRegressionModel, RegressionModel, SimpleExponentialSmoothingModel, TripleExponentialSmoothingModel, WeightedMovingAverageModel, SpectralSmoother, NullModel
TS_MODEL = OlympicModel

# AD_MODEL指定异常检测模型类型
# 选项：ExtremeLowDensityModel, AdaptiveKernelDensityChangePointDetector, KSigmaModel, NaiveModel, DBScanModel, SimpleThresholdModel
AD_MODEL = ExtremeLowDensityModel

配置文件说明：

• MAX_ANOMALY_TIME_AGO：指定只显示不早于某个时间的异常。
• AGGREGATION：指定时间序列的聚合方式。
• OP_TYPE：指定操作类型，如检测异常、更新模型等。
• TS_MODEL：指定时间序列模型类型。
• AD_MODEL：指定异常检测模型类型。

通过以上配置文件，可以灵活地调整EGADS的行为，以适应不同的使用场景。