RobustSTL 项目使用教程

RobustSTL 项目使用教程

1. 项目目录结构及介绍

RobustSTL/
├── assets/
├── gitignore
├── LICENSE
├── README.md
├── RobustSTL.py
├── l1.py
├── main.py
├── requirments.txt
├── run_example.ipynb
├── sample_generator.py
└── utils.py

• assets/: 存放项目相关的静态资源文件。
• gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• RobustSTL.py: 包含 RobustSTL 算法的核心实现。
• l1.py: 优化器文件，用于 L1 范数近似。
• main.py: 项目的启动文件，包含示例代码。
• requirments.txt: 项目依赖库列表。
• run_example.ipynb: Jupyter Notebook 文件，包含使用 RobustSTL 的示例代码和输出。
• sample_generator.py: 生成合成样本的代码。
• utils.py: 通用工具函数。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，包含了使用 RobustSTL 算法的示例代码。通过运行该文件，可以生成合成样本并进行时间序列分解。

# main.py 示例代码
import RobustSTL
import sample_generator

# 生成合成样本
sample = sample_generator.generate_sample()

# 使用 RobustSTL 进行分解
trend, seasonality, remainder = RobustSTL.decompose(sample)

# 输出分解结果
print("Trend:", trend)
print("Seasonality:", seasonality)
print("Remainder:", remainder)

3. 项目的配置文件介绍

requirments.txt

requirments.txt 文件列出了项目运行所需的 Python 依赖库。可以通过以下命令安装这些依赖：

pip3 install -r requirments.txt

配置参数

在 RobustSTL.py 文件中，可以通过调整以下参数来配置算法的行为：

• input: 输入的时间序列数据。
• season_len: 季节性周期的长度。
• reg1: 趋势提取的第一阶正则化参数。
• reg2: 趋势提取的第二阶正则化参数。
• K: 季节性提取中过去季节样本的数量。
• H: 季节性提取中邻域的数量。
• dn1, dn2: 去噪步骤中的双边滤波超参数。
• ds1, ds2: 季节性提取步骤中的双边滤波超参数。

通过调整这些参数，可以适应不同的时间序列数据和应用场景。