Flux 模型 zoo

本仓库包含了 Flux 机器学习库的各种示例。这些示例均可自由用作您构建模型的起点。

模型大致被分类到以下文件夹中：vision（例如大型卷积神经网络 CNN）、text（例如各种循环神经网络 RNN 和自然语言处理 NLP 模型）、games（强化学习 RL）。更多详细信息请参阅各模型的 README 文件。

使用方法

每个模型都自带一个 Julia 项目。要使用它，请在项目文件夹中打开 Julia，并输入以下命令：

using Pkg; Pkg.activate("."); Pkg.instantiate()

这将安装所有必要的包，并且版本与模型上次更新时完全一致。之后，您可以使用 include("<model-to-run>.jl") 运行模型代码，或者逐行执行模型脚本。

如果已安装 CUDA，模型也可以在 NVIDIA GPU 上运行。大多数模型默认具备此功能，通过模型代码中的 gpu 调用来启用。

Gitpod 在线 IDE

每个模型都可以在 Gitpod 中使用，只需 通过 Gitpod 打开仓库 即可。

• 根据 Gitpod 的政策，免费访问是有限制的。
• 您的所有工作都将保存在 Gitpod 的云端。
• 这并非官方维护的功能。

贡献

我们欢迎新模型和文档的贡献。

分享新模型

如果您想分享一个新模型，建议遵循以下指南：

• 模型应放置在一个包含项目文件和 manifest 文件的文件夹中，以固定所有相关依赖包的版本。
• 模型应包含一个 README(.md) 文件，说明模型的作用、如何运行以及可能取得的结果（如适用）。
• 模型最好能够同时支持 CPU 和 GPU，不应直接依赖 GPU 功能。
• 请保持代码简洁、清晰且易于理解，尽量减少冗余代码。

创建或改进文档

您可以通过以下方式参与贡献：

• 为现有模型添加或改进文档：撰写以下内容：
  • 简要介绍模型的架构及其目标。
  • 描述模型所演示的 Flux API（高级 API、自动微分、自定义操作、自定义层等）。
  • 添加该模型的相关文献背景，例如论文、博客文章、视频等有助于更好地理解模型的资源。
  • 提及所演示的技术类型，简要说明其所属的学习领域（计算机视觉、回归、NLP、时间序列等）。
• 为某个模型编写深入教程：您可以进一步扩展模型的文档，创建一个教程来更详细地解释模型的架构、训练流程、使用自定义数据等内容。完成教程后，将其作为 PR 提交至 FluxML 官网的 Tutorials 版块。

更新模型

每个示例都会列出其最近一次更新所使用的 Flux 版本。将其更新到最新版本是很好的学习方式！Flux 有一个 NEWS 页面，列出了重要的变更记录。

（对于其他包，请查看其发布页面：MLUtils、MLDatasets 等。）

要运行旧版本的示例，可以安装 Flux v0.11 并在 Julia 1.6 LTS 版本 上运行。Flux v0.12 则适用于 Julia 1.8。目前最新的版本是 Flux v0.14，v0.13 和 v0.14 都标有 ☀️；升级到使用显式梯度的模型（v0.13.9+ 或 v0.14）会带有 + 标记。

模型 zoo 中的示例

视觉

• MNIST
  • 简单多层感知器 ☀️ v0.13 +
  • 简单 ConvNet (LeNet) ☀️ v0.14
  • 变分自编码器 ☀️ v0.13 +
  • 深度卷积生成对抗网络 ☀️ v0.13 +
  • 条件深度卷积生成对抗网络 ☀️ v0.13
  • 基于分数的生成模型（扩散模型） ☀️ v0.13
  • 空间变换网络 ☀️ v0.13 +
• CIFAR10
  • VGG 16/19 ☀️ v0.13 +
  • ConvMixer “只有 Patch 就够了吗？” ☀️ v0.13

文本

• CharRNN ☀️ v0.13 +
• NanoGPT ☀️ v0.14
• 字符级语言检测 ☀️ v0.13 +
• 基于 CMUDict 的 Seq2Seq 音素检测 ⛅️ v0.11
• IMDB 情感树库上的递归网络 ⛅️ v0.11

其他及贡献模型

• 逻辑回归 Iris ☀️ v0.13 +
• 自回归模型 ☀️ v0.13 +
• BitString 奇偶校验挑战 ⛅️ v0.11
• 住房数据 MLP（低级 API）⛅️ v0.11
• FizzBuzz ☀️ v0.13 +
• 元学习 ❄️ v0.7
• 语音识别 ❄️ v0.6

教程

• 60 分钟速成教程 ⛅️ v0.11
• 图像数据 DataLoader 示例 ⛅️ v0.11
• 迁移学习 ☀️ v0.13 +

其他地方的示例

MLJFlux 是连接 MLJ.jl 的桥梁，后者是一个主要用于非神经网络机器学习的包。他们也有一些有趣的示例，这些示例与模型 zoo 中的示例一样，都包含本地的 Project 和 Manifest 文件：

• Iris ⛅️ v0.11
• Boston ⛅️ v0.11
• MNIST ⛅️ v0.11

Flux Model Zoo 快速上手指南

Flux Model Zoo 是 Flux 机器学习库的官方示例仓库，涵盖了计算机视觉、自然语言处理、强化学习等多个领域的模型实现。本指南将帮助你快速在本地运行这些示例。

环境准备

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

• 操作系统：Linux, macOS 或 Windows。
• Julia 版本：
  • 推荐安装 Julia 1.8 或更高版本（适用于标记为 ☀️ v0.12/v0.13/v0.14 的最新模型）。
  • 部分旧模型可能需要 Julia 1.6 (LTS)。
  • 下载地址：Julia 官网
• GPU 支持（可选）：
  • 若需使用 NVIDIA GPU 加速，请预先安装适配你显卡驱动的 CUDA Toolkit。
  • 大多数模型代码中包含 gpu 调用，检测到 CUDA 后会自动启用 GPU 加速。

安装步骤

Flux Model Zoo 中的每个模型都是一个独立的 Julia 项目。你无需全局安装所有依赖，只需进入具体模型目录激活其专属环境即可。

1. 克隆仓库 打开终端，克隆 model-zoo 仓库到本地：

   git clone https://github.com/FluxML/model-zoo.git
   cd model-zoo
   

2. 选择并进入模型目录 根据你想运行的模型，进入对应的文件夹。例如，运行一个简单的 MNIST 多层感知机：

   cd vision/mlp_mnist
   

3. 激活环境并安装依赖 在该目录下启动 Julia，并执行以下命令来激活当前项目并安装精确版本的依赖包：

   using Pkg; Pkg.activate("."); Pkg.instantiate()
   

   注：首次运行时会下载并编译相关包，请耐心等待。国内用户若遇到下载慢的问题，可配置 Julia 的镜像源（如替换 DEPOT_PATH 或使用国内镜像站）。

基本使用

环境配置完成后，你可以直接运行模型脚本。

运行示例

在已激活环境的 Julia REPL 中，使用 include 命令运行主脚本：

include("train.jl")

(注意：不同模型的入口文件名可能不同，如 main.jl, model.jl 等，请查看该目录下的 README 或文件列表确认具体文件名)

或者，你也可以逐行复制脚本内容到 REPL 中执行，以便观察每一步的输出和变量状态。

在线体验 (Gitpod)

如果你不想在本地配置环境，可以使用 Gitpod 直接在浏览器中运行：

1. 访问 Gitpod Model Zoo。
2. 等待环境加载完成。
3. 在终端中按照上述“安装步骤”和“基本使用”的方法操作。

提示：Gitpod 免费额度有限，且数据存储在云端，适合快速测试而非长期开发。

模型分类参考

• 视觉 (Vision): cd vision/<model-name> (如 CNN, GAN, Diffusion)
• 文本 (Text): cd text/<model-name> (如 RNN, Transformer/NanoGPT)
• 其他 (Other): cd other/<model-name> (如回归，元学习)