时间序列生成器教程

项目介绍

timeseries-generator 是一个由 Nike-Inc 开发的 Python 包，用于生成合成的时间序列数据集。这个包提供了一种通用的方法来创建时间序列数据，包括线性趋势、季节性趋势、随机噪声等。它还支持使用外部因素来影响生成的数据，并且提供了一个基于 Streamlit 的 Web 界面，用于交互式地生成合成时间序列数据。

项目快速启动

安装

首先，你需要安装 timeseries-generator 包。你可以使用 pip 进行安装：

pip install timeseries-generator

基本使用

以下是一个简单的示例，展示如何使用 timeseries-generator 生成一个包含线性趋势的时间序列数据：

from timeseries_generator import LinearTrend, Generator, WhiteNoise
import pandas as pd

# 设置一个线性趋势
lt = LinearTrend(coef=2.0, offset=1, col_name="my_linear_trend")

# 创建生成器
g = Generator(factors={lt}, features=None, date_range=pd.date_range(start="01-01-2020", end="01-20-2020"))

# 生成数据并绘图
g.generate()
g.plot()

# 添加一些白噪声
wn = WhiteNoise(stdev_factor=0.05)
g.update_factor(wn)
g.generate()
g.plot()

应用案例和最佳实践

生成季节性趋势

你可以使用 SeasonalTrend 因子来生成季节性趋势：

from timeseries_generator import SeasonalTrend

# 设置一个季节性趋势
st = SeasonalTrend(amplitude=10, period=12, col_name="my_seasonal_trend")

# 更新生成器
g.update_factor(st)
g.generate()
g.plot()

使用外部因素

你可以使用 ExternalFactor 来引入外部因素，例如温度对销售的影响：

from timeseries_generator import ExternalFactor

# 设置一个外部因素
ef = ExternalFactor(factor_name="temperature", effect_coef=0.5, col_name="sales")

# 更新生成器
g.update_factor(ef)
g.generate()
g.plot()

典型生态项目

Streamlit Web 界面

timeseries-generator 提供了一个基于 Streamlit 的 Web 界面，用于交互式地生成合成时间序列数据。你可以通过以下命令启动这个界面：

streamlit run examples/streamlit/app.py

Jupyter Notebook 示例

项目还提供了一些 Jupyter Notebook 示例，展示如何生成不同类型的时间序列数据：

• generate_stationary_process.ipynb：介绍如何生成平稳过程。
• generate_seasonal_trends.ipynb：展示如何生成季节性趋势。

你可以通过克隆项目并运行这些 Notebook 来学习更多高级用法。

git clone https://github.com/Nike-Inc/timeseries-generator.git
cd timeseries-generator/examples
jupyter notebook

通过这些示例，你可以更好地理解和应用 timeseries-generator 包来生成各种复杂的时间序列数据。