MegEngine

文档 | 中文文档

MegEngine 是一个快速、可扩展且用户友好的深度学习框架，具有三大核心特性。

• 训练与推理一体化框架
  • 量化、动态形状/图像预处理，甚至只需一个模型即可完成自动微分。
  • 训练完成后，将所有内容整合到您的模型中，即可在任何平台上以速度和精度进行推理。请参阅此处获取快速指南。
• 最低的硬件需求
  • 启用DTR算法后，GPU内存占用可降低至原来的三分之一。
  • 通过我们的Pushdown内存规划器，实现内存占用最低的推理模型。
• 高效跨平台推理
  • 在x86、Arm、CUDA和RoCM等平台上实现高速、高精度推理。
  • 支持Linux、Windows、iOS、Android、TEE等多种平台。
  • 利用我们的高级功能，优化性能和内存使用。

---

安装

注意： MegEngine 现已支持在 Linux-64位、Windows-64位、macOS（仅CPU）10.14及以上版本以及 Android 7及以上版本（仅CPU）上通过 Python 3.6 至 3.9 进行安装。在 Windows 10 上，您可以通过Windows Subsystem for Linux (WSL) 安装 Linux 发行版，也可以直接安装 Windows 版本。此外，还支持许多其他平台的推理。

二进制包

通过 pip 轮子安装预编译的二进制文件：

python3 -m pip install --upgrade pip
python3 -m pip install megengine -f https://megengine.org.cn/whl/mge.html

从源码构建

• CMake 构建详情，请参阅 BUILD_README.md
• Python 绑定构建详情，请参阅 BUILD_PYTHON_WHL_README.md

如何贡献

• MegEngine 采用 Contributor Covenant 作为社区运行准则。请阅读 行为准则。
• 所有贡献者都必须签署 贡献者许可协议 (CLA)，以明确贡献所授予的知识产权许可。
• 您可以通过多种方式帮助改进 MegEngine：
  • 编写代码。
  • 改进文档。
  • 在MegEngine 论坛或 Stack Overflow 上解答问题。
  • 在MegEngine Model Hub中贡献新模型。
  • 在MegStudio上尝试新想法。
  • 报告或调查漏洞和问题。
  • 审核拉取请求。
  • 为 MegEngine 仓库点赞。
  • 在您的论文和文章中引用 MegEngine。
  • 向朋友推荐 MegEngine。
  • 欢迎任何形式的贡献。

我们致力于打造开放友好的社区，旨在用人工智能赋能人类。

如何联系我们

• 问题：github.com/MegEngine/MegEngine/issues
• 邮箱：megengine-support@megvii.com
• 论坛：discuss.megengine.org.cn
• QQ 群：1029741705

资源

• MegEngine
• MegStudio
• 镜像仓库
  • OPENI：openi.org.cn/MegEngine
  • Gitee：gitee.com/MegEngine/MegEngine

许可证

MegEngine 采用 Apache License, Version 2.0 许可证。

引用

如果您在出版物中使用 MegEngine，请使用以下 BibTeX 条目进行引用。

@Misc{MegEngine,
  institution = {megvii},
  title =  {MegEngine：一个快速、可扩展且易于使用的深度学习框架},
  howpublished = {\url{https://github.com/MegEngine/MegEngine}},
  year = {2020}
}

版权所有 © 2014-2021 巨量科技有限公司。保留所有权利。

MegEngine 快速上手指南

MegEngine（天枢）是一款由旷视科技开源的快速、可扩展且易用的深度学习框架。其核心优势在于训练推理一体化、极低的硬件资源占用以及全平台高效推理。

1. 环境准备

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

• 操作系统：
  • Linux (64-bit)
  • Windows 10 (64-bit，支持直接安装或通过 WSL)
  • macOS 10.14+ (仅支持 CPU)
  • Android 7+ (仅支持 CPU，主要用于推理)
• Python 版本：3.6 - 3.9
• 硬件加速（可选）：
  • NVIDIA GPU (需安装对应版本的 CUDA)
  • AMD GPU (需安装 RoCM)
  • 若无独立显卡，框架可自动使用 CPU 运行。

2. 安装步骤

推荐使用官方提供的国内镜像源进行安装，以获得更快的下载速度。

方式一：通过 pip 安装预编译包（推荐）

打开终端或命令行工具，执行以下命令：

# 升级 pip 工具
python3 -m pip install --upgrade pip

# 安装 MegEngine（自动匹配国内镜像源）
python3 -m pip install megengine -f https://megengine.org.cn/whl/mge.html

注意：Windows 用户若遇到权限问题，可在命令后添加 --user 参数，或使用管理员身份运行命令行。

方式二：源码编译（高级用户）

如需自定义编译选项或使用最新开发版代码，请参考官方构建文档：

• CMake 构建详情：BUILD_README.md
• Python 绑定构建详情：BUILD_PYTHON_WHL_README.md

3. 基本使用

MegEngine 提供了类似 PyTorch 的动态图接口，易于上手。以下是一个最简单的线性回归训练示例：

import megengine as mge
import megengine.module as M
import megengine.functional as F
from megengine import autodiff as ad

# 1. 定义模型
class LinearRegression(M.Module):
    def __init__(self):
        super().__init__()
        self.fc = M.Linear(1, 1)

    def forward(self, x):
        return self.fc(x)

model = LinearRegression()

# 2. 准备数据 (简单示例数据)
data = mge.tensor([[1.0], [2.0], [3.0], [4.0]])
label = mge.tensor([[2.0], [4.0], [6.0], [8.0]])

# 3. 定义优化器
optimizer = ad.SGD(model.parameters(), lr=0.01)

# 4. 定义训练过程
def train_step(x, y):
    with ad.enable_grad():
        pred = model(x)
        loss = F.mean((pred - y) ** 2)
    
    grads = ad.grad(loss, model.parameters())
    optimizer.step(grads)
    return loss

# 5. 执行训练
for epoch in range(100):
    loss = train_step(data, label)
    if epoch % 10 == 0:
        print(f"Epoch {epoch}, Loss: {loss.numpy()}")

print("Training finished!")

核心特性提示

• 训练推理一体：训练完成后，可直接使用 TracedModule 将模型转换为推理模式，无需重新编写代码即可部署。
• 显存优化：若在显存受限的设备上运行大模型，可启用 DTR 算法大幅降低显存占用。