PyTorch 项目模板由以下工具赞助；请帮忙支持我们，查看并注册免费试用：

PyTorch 项目模板

以智能的方式实现你的 PyTorch 项目。

这是一个适用于 PyTorch 项目的可扩展模板，包含图像分割、目标分类、GAN 和强化学习等示例。

鉴于深度学习项目的特性，我们往往没有太多时间去思考项目结构或代码的模块化。在参与过多个深度学习项目，并遇到文件组织混乱和代码重复等问题后，我们设计了一种模块化的项目结构，可以适应任何 PyTorch 项目。同时，我们也希望为社区提供一个基于 PyTorch 的模型基础框架，供大家在此基础上进行开发。

本项目由 Hager Rady 和 Mo'men AbdelRazek 共同完成。

目录：

• PyTorch 项目模板
  • 为什么使用这个模板？
  • 教程
  • 贡献
  • 模板类图
  • 参考仓库
  • 仓库迁移总结
  • 模板仓库结构
  • 依赖项
  • 未来工作
  • 许可证

为什么使用这个模板？

我们提出了一种基准模板，适用于任何 PyTorch 项目，帮助你快速入门。这样你可以把更多精力放在模型实现上，而其他部分则由我们来处理。该方法的新颖之处在于：

• 提供可扩展的项目结构，每个子模块都有对应的模板文件。
• 引入配置文件机制，用于管理与特定问题相关的所有超参数。
• 在模板中嵌入了多种不同问题的示例，你只需简单地更改配置文件名，即可独立运行任意一个示例。
• 提供教程，帮助你快速上手。

教程：

我们提供了一系列教程，帮助你快速开始：

• 入门教程：介绍如何开始你的项目的主要步骤。
• MNIST 教程：我们将一个已实现的 MNIST 神经网络模型适配到我们的模板结构中。

贡献：

• 我们希望这个模板能够成为许多知名 PyTorch 深度学习模型变体的集中平台。
• 我们欢迎社区的任何贡献，以实现这一目标，因此鼓励大家将自己的 PyTorch 模型加入到模板中。
• 同时，我们也欢迎对本项目所采用的类设计模式提出的改进建议或讨论。

模板类图：

参考仓库：

1. ERFNet：一种用于语义分割的模型，在 Pascal VOC 数据集上训练。
2. DCGAN：深度卷积生成对抗网络，在 CelebA 数据集上运行。
3. CondenseNet：一种用于图像分类的模型，在 CIFAR-10 数据集上训练。
4. DQN：深度 Q 网络模型，是强化学习的一个例子，在 CartPole-V0 环境中测试。
5. RecAE：基于循环神经网络的自编码器，用于时间序列异常检测，在 ECG5000 数据集上运行。

仓库迁移总结：

1. 我们首先引入了 DCGAN，将其自定义配置添加到 JSON 文件中。由于 DCGAN 包含生成器和判别器两个模型，因此没有单一的模型文件。
2. 接着，我们加入了 CondenseNet，为此需要在 models 文件夹中创建一个自定义的 blocks 文件夹，用于存放模型中自定义层的定义。
3. 随后，我们添加了 DQN 项目，将与环境相关的所有类移至 utils 文件夹中。同时，还将动作选择和模型优化逻辑整合到了训练代理中。
4. 最后加入的是 ERFNet 示例；代理、模型和工具类分别被添加到各自的文件夹中，且未出现任何冲突。

这样做是为了确保我们提出的项目结构能够兼容不同的问题，并能处理各种相关的变化。

仓库结构：

在添加完所有示例后，仓库的结构如下：

├── agents
|  └── dcgan.py
|  └── condensenet.py
|  └── mnist.py
|  └── dqn.py
|  └── example.py
|  └── base.py
|  └── erfnet.py
|
├── configs
|  └── dcgan_exp_0.py
|  └── condensenet_exp_0.py
|  └── mnist_exp_0.py
|  └── dqn_exp_0.py
|  └── example_exp_0.py
|  └── erfnet_exp_0.py
|
├── data
|
├── datasets
|  └── cifar10.py
|  └── celebA.py
|  └── mnist.py
|  └── example.py
|  └── voc2012.py
|
├── experiments
|
├── graphs
|  └── models
|  |  └── custome_layers
|  |  |  └── denseblock.py
|  |  |  └── layers.py
|  |  |
|  |  └── dcgan_discriminator.py
|  |  └── dcgan_generator.py
|  |  └── erfnet.py
|  |  └── erfnet_imagenet.py
|  |  └── condensenet.py
|  |  └── mnist.py
|  |  └── dqn.py
|  |  └── example.py
|  |
|  └── losses
|  |  └── loss.py
|
├── pretrained_weights
|
├── tutorials
|
├── utils
|  └── assets
|
├── main.py
└── run.sh

依赖项：

easydict==1.7
graphviz==0.8.4
gym==0.10.5
imageio==2.3.0
matplotlib==2.2.2
numpy==1.14.5
Pillow==5.2.0
scikit-image==0.14.0
scikit-learn==0.19.1
scipy==1.1.0
tensorboardX==1.2
torch==0.4.0
torchvision==0.2.1
tqdm==4.23.4

未来工作：

我们计划在模板中添加更多示例，以涵盖各类问题。接下来我们将加入以下内容：

• MobileNetV2
• visual-interaction-networks-pytorch
• variational-Autoencoder-pytorch

许可证：

本项目采用 MIT 许可证授权——详情请参阅 LICENSE 文件。

PyTorch Project Template 快速上手指南

PyTorch Project Template 是一个可扩展的 PyTorch 项目模板，旨在帮助开发者以模块化、结构化的方式构建深度学习项目。它内置了图像分割、目标分类、GAN 和强化学习等多个示例，通过配置文件即可轻松切换不同任务。

环境准备

系统要求

• Python 3.x
• 支持 CUDA 的 GPU（可选，用于加速训练）

前置依赖

本项目依赖以下核心库，建议先安装基础科学计算包：

pip install numpy scipy matplotlib Pillow scikit-image scikit-learn

国内加速建议：推荐使用清华或阿里镜像源加速安装：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple <package_name>

安装步骤

1. 克隆仓库

   git clone https://github.com/moemen95/PyTorch-Project-Template.git
   cd PyTorch-Project-Template
   

2. 安装依赖 创建虚拟环境并安装 requirements.txt 中列出的所有依赖：

   python -m venv venv
   source venv/bin/activate  # Windows 用户请使用: venv\Scripts\activate
   
   pip install -r requirements.txt
   

   若使用国内镜像源加速安装：

   pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt
   

基本使用

本模板的核心优势在于通过修改配置文件即可运行不同的模型示例。

1. 运行示例项目（以 MNIST 为例）

确保 configs 目录下存在 mnist_exp_0.py 配置文件。

执行主程序并指定配置：

python main.py --config configs/mnist_exp_0.py

或者使用提供的脚本运行：

./run.sh configs/mnist_exp_0.py

2. 切换其他任务

只需更改配置文件名称即可运行其他内置示例（如 GAN、DQN 等）：

• 运行 DCGAN:

  python main.py --config configs/dcgan_exp_0.py
  

• 运行强化学习 (DQN):

  python main.py --config configs/dqn_exp_0.py
  

• 运行图像分割 (ERFNet):

  python main.py --config configs/erfnet_exp_0.py
  

3. 开始新项目

若要开发自己的模型：

1. 复制 agents/example.py 和 graphs/models/example.py 作为起点。
2. 复制 configs/example_exp_0.py 并重命名，修改其中的超参数和数据路径。
3. 运行新配置的脚本即可。