GluonTS 开源项目安装与使用指南
目录结构及介绍
根目录
LICENSE
: 显示了项目的许可协议。README.md
: 提供了项目概述、安装说明和其他相关信息。gluonts/
: 包含项目的主代码库。
gluonts/
目录
__init__.py
: 初始化Python包。dataset/
: 存储关于数据集的处理逻辑。common.py
: 定义了数据集的公共接口。splitter.py
: 实现数据分割策略。transform.py
: 数据转换模块。
estimator/
: 承载用于训练时间序列模型的估计器类。- 多种模型对应的子模块,如
deepar.py
,simple_feedforward.py
。
- 多种模型对应的子模块,如
model/
: 包含定义具体模型架构的文件。distribution/
: 关注于概率分布相关的数学对象和方法。trainer/
: 控制模型训练流程。predictor/
: 含有用于预测的类和函数。utils/
: 公用程序模块,包括时间序列相关函数。evaluate/
: 评估模型性能的模块。block/
: 内含构建深层模型所需的块元素。
配置与启动文件
项目启动文件
在gluonts/
目录下没有单独定义的“启动”文件,因为GlounTS被设计成一个导入式的库。但是,你可以创建一个新的Python脚本来运行示例预测:
import os
os.environ['MXNET_CUDNN_AUTOTUNE_DEFAULT'] = '0'
from gluonts.model.predictor import Predictor
from gluonts.dataset.common import ListDataset
from gluonts.evaluation.backtest import backtest_metrics
train_data = ListDataset(
[{"start": start_date, "target": target_series}],
freq="D",
)
predictor = Predictor(...)
forecast_it, ts_it = backtest_metrics(train_data, predictor=predictor)
for forecast, ts in zip(forecast_it, ts_it):
print("Forecast:", forecast)
print("Target Series:", ts)
配置文件
GluonTS并不强制要求使用特定的配置文件。它的灵活性体现在,大多数参数都可以通过函数调用来动态设置。不过,在实际部署时,你可以考虑使用yaml
或者.json
配置文件来管理复杂的设置,如:
# example_config.yaml
freq: D
context_length: 90
prediction_length: 30
batch_size: 32
num_batches_per_epoch: 50
learning_rate: 1e-3
epochs: 100
...
然后利用Python中的argparse
或自定义解析器加载此配置文件到你的脚本中。
项目的配置文件介绍
虽然GluonTS项目本身不硬性规定使用配置文件,但在复杂应用或生产环境中,采用配置文件管理项目设置是一种常见做法。以下是一种可能的配置文件模板,允许用户灵活地调整训练和预测参数:
# config.yml 示例配置文件
# 设置时间序列频率(D=天, H=小时)
freq: D
# 设置上下文长度和预测长度
context_length: 90
prediction_length: 30
# 训练参数
training:
batch_size: 32
num_batches_per_epoch: 50
learning_rate: 0.001
epochs: 100
# 模型参数
model:
type: DeepAR # 可选其他模型类型,如SimpleFeedForward
likelihood_type: Gaussian # 依据模型需求选择不同的似然分布
# 数据预处理选项
data_preprocessing:
imputation_strategy: zero # 或可选择'last', 'mean'等
scaling_method: standard # 或min_max, max_abs等
# 评估指标列表
evaluation_metrics:
- MSE
- MAE
- R2
# 日志和结果存储路径
output:
log_dir: logs/
model_save_path: saved_models/
prediction_output: results.csv
这种类型的配置文件使得开发者能够在无需修改任何代码的情况下,便捷地调整项目的主要方面,从而提高了项目的维护性和扩展性。为了读取和解析YAML配置文件,Python项目可以利用第三方库如PyYAML,这在许多现实应用案例中都是标准实践。
项目的启动文件介绍
GluonTS作为一个专注于时间序列预测的库,其设计初衷是为了便于集成进更大的应用程序或分析管道中,因此并没有传统的“main”入口点。然而,当开发者希望独立测试某个模型的功能或了解其工作原理时,可以通过编写一个简单的Python脚本来初始化GluonTS环境和模型实例,进行端到端的预测流程。以下是一份简化版的启动脚本示例,展示如何使用DeepAR模型进行预测:
# start_gluonts_example.py
import os
import logging.config
from gluonts.dataset.field_names import FieldName
from gluonts.evaluation import Evaluator, MultivariateEvaluator
from gluonts.dataset.common import ListDataset
from gluonts.trainer import Trainer
from gluonts.model.deep_ar import DeepAREstimator
from gluonts.model.predictor import Predictor
from gluonts.transform import (
AddObservedValuesIndicator,
VstackFeatures,
InstanceSplitter,
TransformationChain,
Chain,
RenameFields,
)
logging.basicConfig(level=logging.INFO)
# 加载配置文件
config = load_yaml('config.yml')
def create_dataset():
# 创建数据集...(此处省略具体实现)
pass
def train_model(dataset):
estimator = DeepAREstimator(freq=config.freq, context_length=config.context_length, prediction_length=config.prediction_length, trainer=Trainer())
predictor = estimator.train(training_data=dataset)
return predictor
def predict_and_evaluate(predictor, test_data):
forecasts = list(predictor.predict(test_data))
evaluator = Evaluator()
agg_metrics, item_metrics = evaluator(iter(list(forecasts)), iter(test_data))
return agg_metrics
if __name__ == "__main__":
# 准备数据集
train_data = create_dataset()
# 训练模型
predictor = train_model(train_data)
# 加载测试数据
test_data = create_dataset() # 确保这是测试集的实例
# 预测和评价
metrics = predict_and_evaluate(predictor, test_data)
logging.info(f'Model evaluation metrics: {metrics}')
这份脚本不仅能够快速启动GluonTS环境,还提供了基本的工作流,从数据准备到模型训练、预测直至最后的评估步骤。此外,它也是引入和测试新特性、算法或优化方案的理想起点。