TorchGAN 是一个基于 PyTorch 的生成对抗网络设计与开发框架。该框架旨在为流行的 GAN 提供构建模块，同时也支持针对前沿研究的自定义扩展。借助 TorchGAN 的模块化结构，用户可以：

• 在自己的数据集上尝试流行的 GAN 模型。
• 将新的损失函数、架构等与传统方法无缝集成。
• 通过多种日志记录后端流畅地可视化训练过程。

系统 / PyTorch 版本	1.8	1.9	夜间版
Linux py3.8
Linux py3.9
OSX py3.8
OSX py3.9
Windows py3.9
Windows py3.9

安装

使用 pip（稳定版）：

  $ pip install torchgan

使用 pip（最新 master 分支）：

  $ pip install git+https://github.com/torchgan/torchgan.git

从源码安装：

  $ git clone https://github.com/torchgan/torchgan.git
  $ cd torchgan
  $ python setup.py install

文档

文档可在 这里 查阅。

您也可以在本地生成该包的文档：

  $ git clone https://github.com/torchgan/torchgan.git
  $ cd torchgan/docs
  $ pip install -r requirements.txt
  $ make html

然后打开 build 目录下的相应文件即可。

教程

tutorials 目录包含一系列入门教程，帮助您快速上手 TorchGAN。这些教程可以通过 Google Colab 或 Binder 运行。强烈建议您按照以下顺序学习这些教程：

1. 入门教程：
   • 教程 1：TorchGAN 简介
   • 教程 2：自定义损失函数
2. 中级教程：
   • 教程 3：CycleGAN
   • 教程 4：自注意力 GAN
3. 高级教程：
   • 教程 5：对抗自编码器

支持与引用

本软件是作为学术研究的一部分开发的。如果您希望支持该项目，请给仓库点个赞。如果您在研究、教学或其他活动中使用了本软件，我们非常感谢您能够引用以下文献：

@article{Pal2021,
  doi = {10.21105/joss.02606},
  url = {https://doi.org/10.21105/joss.02606},
  year = {2021},
  publisher = {The Open Journal},
  volume = {6},
  number = {66},
  pages = {2606},
  author = {Avik Pal 和 Aniket Das},
  title = {TorchGAN：一个灵活的 GAN 训练与评估框架},
  journal = {开源软件期刊}
}

使用 TorchGAN 的出版物及投稿列表（请提交 Pull Request 以添加缺失条目）：

• GAN 生成的网络流量能否用于训练流量异常分类器？
• Ward2ICU：普通病房住院患者的生命体征数据集

贡献

我们欢迎所有贡献。如果您计划提交 bug 修复，请直接操作，无需进一步讨论。如果您打算贡献新功能、工具函数或扩展，请先创建一个问题，并与我们讨论该功能的具体细节。更多详细指南请参阅官方文档。

贡献者

本软件由以下人员开发：

• Avik Pal (@avik-pal)
• Aniket Das (@Aniket1998)

本项目得以持续发展，离不开所有贡献者的支持。

TorchGAN 快速上手指南

TorchGAN 是一个基于 PyTorch 的框架，旨在简化生成对抗网络（GAN）的设计与训练。它提供了模块化结构，支持快速复现经典 GAN 模型，并允许研究者轻松自定义损失函数、网络架构及日志记录方式。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows
• Python 版本: 3.8 或 3.9 (推荐)
• PyTorch 版本: 1.8, 1.9 或 nightly 版本
• 前置依赖: 已安装 PyTorch (torch 和 torchvision)

提示: 国内用户建议使用清华源或阿里源加速 PyTorch 及相关依赖的安装。

安装步骤

您可以选择以下任意一种方式进行安装。

方式一：通过 pip 安装（稳定版，推荐）

pip install torchgan

国内加速方案（使用清华源）：

pip install torchgan -i https://pypi.tuna.tsinghua.edu.cn/simple

方式二：通过 pip 安装（最新开发版）

如果您需要使用 GitHub 上的最新功能：

pip install git+https://github.com/torchgan/torchgan.git

方式三：源码安装

git clone https://github.com/torchgan/torchgan.git
cd torchgan
python setup.py install

基本使用

TorchGAN 的核心优势在于其模块化设计。以下是一个最简化的使用流程示例，展示如何构建并运行一个基础的 GAN 训练循环。

1. 导入模块与定义模型

首先导入必要的组件，并定义您的生成器（Generator）和判别器（Discriminator）。TorchGAN 兼容标准的 nn.Module。

import torch
import torch.nn as nn
from torchgan.inference import Visualizer
from torchgan.trainer import Trainer

# 定义简单的生成器和判别器 (示例)
class Generator(nn.Module):
    def __init__(self):
        super(Generator, self).__init__()
        # 定义网络层...
        pass
    def forward(self, z):
        # 前向传播...
        pass

class Discriminator(nn.Module):
    def __init__(self):
        super(Discriminator, self).__init__()
        # 定义网络层...
        pass
    def forward(self, x):
        # 前向传播...
        pass

generator = Generator()
discriminator = Discriminator()

2. 配置损失函数与优化器

TorchGAN 内置了多种常见的 GAN 损失函数（如 Minimax, WGAN 等），您也可以自定义。

from torchgan.losses import MinimaxLossG, MinimaxLossD
from torch.optim import Adam

# 实例化损失函数
losses = {
    "generator": MinimaxLossG(),
    "discriminator": MinimaxLossD()
}

# 实例化优化器
optimizers = {
    "generator": Adam(generator.parameters(), lr=0.0002),
    "discriminator": Adam(discriminator.parameters(), lr=0.0002)
}

3. 创建 Trainer 并开始训练

使用 Trainer 类将模型、数据加载器、损失函数和优化器组装起来。这是启动训练的最简单方式。

# 假设 train_loader 是您的 DataLoader
# trainer = Trainer(losses, optimizers, generator, discriminator, device='cuda')

# 伪代码示例：实际使用时需传入具体的 dataloader
trainer = Trainer(
    losses=losses,
    optimizers=optimizers,
    generator=generator,
    discriminator=discriminator,
    device='cuda' if torch.cuda.is_available() else 'cpu'
)

# 开始训练 (epochs, dataloader 等参数根据实际情况调整)
# trainer(train_loader, epochs=100)

4. 可视化结果

TorchGAN 支持无缝集成多种日志后端。您可以在训练过程中轻松保存生成的图像样本。

# 设置可视化器
visualizer = Visualizer(output_dir='./generated_images')

# 在 Trainer 中注册 hook 或在训练循环中调用
# 具体用法可参考官方 tutorials 中的详细示例

进阶学习: 更多复杂模型（如 CycleGAN, Self-Attention GAN）的实现及自定义损失函数的教程，请访问项目 tutorials 目录或在 Google Colab/Binder 中直接运行官方笔记本。