deepepochs 0.4.16

An easy-to-use tool for training Pytorch deep learning models

DeepEpochs

Pytorch深度学习模型训练工具。

安装

pip install deepepochs

使用

数据要求

• 训练集、验证集和测试集是torch.utils.data.Dataloader对象
• Dataloaer所构造的每个mini-batch数据（collate_fn返回值）是一个tuple或list，其中最后一个是标签
  • 如果训练中不需要标签，则需将最后一项置为None

指标计算

• 每个指标是一个函数
  • 有两个参数，分别为模型预测和数据标签
  • 返回值为当前mini-batch上的指标值

应用

from deepepochs import Trainer, CheckCallback, rename, EpochTask, LogCallback
import torch
from torch import nn
from torch.nn import functional as F
from torchvision.datasets import MNIST
from torchvision import transforms
from torch.utils.data import DataLoader, random_split
from torchmetrics import functional as MF

# datasets
data_dir = './datasets'
transform = transforms.Compose([transforms.ToTensor(), transforms.Normalize((0.1307,), (0.3081,))])
mnist_full = MNIST(data_dir, train=True, transform=transform, download=True)
train_ds, val_ds, _ = random_split(mnist_full, [5000, 5000, 50000])
test_ds = MNIST(data_dir, train=False, transform=transform, download=True)

# dataloaders
train_dl = DataLoader(train_ds, batch_size=32)
val_dl = DataLoader(val_ds, batch_size=32)
test_dl = DataLoader(test_ds, batch_size=32)

# pytorch model
channels, width, height = (1, 28, 28)
model = nn.Sequential(
    nn.Flatten(),
    nn.Linear(channels * width * height, 64),
    nn.ReLU(),
    nn.Dropout(0.1),
    nn.Linear(64, 64),
    nn.ReLU(),
    nn.Dropout(0.1),
    nn.Linear(64, 10)
)

def acc(preds, targets):
    return MF.accuracy(preds, targets, task='multiclass', num_classes=10)

@rename('')
def multi_metrics(preds, targets):
    return {
        'p': MF.precision(preds, targets, task='multiclass', num_classes=10),
        'r': MF.recall(preds, targets, task='multiclass', num_classes=10)
        }
checker = CheckCallback('loss', on_stage='val', mode='min', patience=2)
opt = torch.optim.Adam(model.parameters(), lr=2e-4)

trainer = Trainer(model, F.cross_entropy, opt=opt, epochs=5, callbacks=checker, metrics=[acc])

progress = trainer.fit(train_dl, val_dl, metrics=[multi_metrics])
test_rst = trainer.test(test_dl)

示例

序号	功能说明	代码
1	基本使用	examples/1-basic.py
2	训练器、fit方法、test方法的常用参数	examples/2-basic-params.py
3	模型性能评价指标的使用	examples/3-metrics.py
4	Checkpoint和EarlyStop	examples/4-checkpoint-earlystop.py
5	检测适当的学习率	examples/5-lr-find.py
6	利用Tensorboad记录训练过程	examples/6-logger.py
7	利用tensorboard记录与可视化超参数	examples/7-log-hyperparameters.py
8	分析与解释模型的预测效果	examples/8-interprete.py
9	学习率调度	examples/9-lr-schedule.py
10	使用多个优化器	examples/10-multi-optimizers.py
11	在训练、验证、测试中使用多个Dataloader	examples/11-multi-dataloaders.py
12	利用图神经网络对节点进行分类	examples/12-node-classification.py
13	模型前向输出和梯度的可视化	examples/13-weight-grad-visualize.py
14	自定义Callback	examples/14-costomize-callback.py
15	通过TrainerBase定制train_step和evaluate_step	examples/15-customize-steps-1.py
16	通过EpochTask定制train_step和eval_step和test_step	examples/16-customize-steps-2.py
17	通过EpochTask定制*step	examples/17-costomize-steps-3.py
18	内置Patch的使用	examples/18-use_patches.py
19	自定义Patch	examples/19-customize-patch.py

定制训练流程

• 方法1:
  • 第1步：继承deepepochs.Callback类，定制满足需要的Callback
  • 第2步：使用deepepochs.Trainer训练模型，将定制的Callback对象作为Trainer的callbacks参数
• 方法2:
  • 第1步：继承deepepochs.TrainerBase类，定制满足需要的Trainer，实现step、train_step、val_step、test_step或evaluate_step方法
    • 这些方法有三个参数
      • batch_x： 一个mini-batch的模型输入数据
      • batch_y： 一个mini-batch的标签
      • **step_args：可变参数字典，包含do_loss、metrics等参数
    • 返回值为字典
      • key：指标名称
      • value：deepepochs.PatchBase子类对象，可用的Patch有
        • ValuePatch： 根据每个batch指标均值（提前计算好）和batch_size，累积计算Epoch指标均值
        • TensorPatch： 保存每个batch模型预测输出及标签，根据指定指标函数累积计算Epoch指标均值
        • MeanPatch： 保存每个batch指标均值，根据指定指标函数累积计算Epoch指标均值
        • ConfusionPatch：累积计算基于混淆矩阵的指标
        • 也可以继承PatchBase定义新的Patch（存在复杂指标运算的情况下）
          • PatchBase.add方法
          • PatchBase.forward方法
  • 第2步：调用定制Trainer训练模型。
• 方法3:
  • 第1步：继承deepepochs.EpochTask类，在其中定义step、train_step、val_step、test_step或evaluate_step方法
    • 它们的定义方式与Trainer中的*step方法相同
    • step方法优先级最高，即可用于训练也可用于验证和测试（定义了step方法，其他方法就会失效）
    • val_step、test_step优先级高于evaluate_step方法
    • EpochTask中的*_step方法优先级高于Trainer中的*_step方法
  • 第2步：使用新的EpochTask任务进行训练
    • 将EpochTask对象作为Trainer.fit中train_tasks和val_tasks的参数值，或者Trainer.test方法中tasks的参数值

数据流图