README_CN.md

MegEngine

MegEngine 是一个快速、可拓展、易于使用的深度学习框架，拥有以下三大关键特点：

• 训练推理一体：训练推理同一内核，模型结构、量化、前后处理、动态 shape 甚至求导均可 放入模型 进行推理，训练推理轻松对齐精度
• 超低硬件门槛：依靠算法优化各类关键资源占用，DTR 让训练显存占用量一键下降3倍，pushdown 内存分配算法让推理内存占用下降至极低水平
• 全平台高效推理：在 x86/Arm/CUDA/RoCM 各平台上均可体验到高性能且精度对齐的推理体验，更有 丰富的高阶用法可以优化性能、节省内存

---

开始使用

• 如果想本地使用：安装、编译
• 如果想在线体验：MegStudio
• 更多技术细节解读及问题反馈：知乎、论坛

训练

• 学习 MegEngine 使用文档：文档
• 得到 MegEngine 模型：BaseCls、Models、Hub
• 从 PyTorch 迁移而来：torch2mge、guide、文档-迁移指南
• paper 合集：MEGVII-Research

推理

• 查看部署指南：文档
• 转换至其它推理框架：MgeConvert
• 串联多模型、视频流处理：MegFlow

安装说明

注意: MegEngine 现在支持在 Linux-64bit/Windows-64bit/macos-10.14/Android 7+ 及其以上 (MacOS/Android只支持cpu) 等平台上安装 Python 包，支持Python3.6 到 Python3.9。对于 Windows 10 用户，可以通过安装 Windows Subsystem for Linux (WSL) 进行体验，同时我们也原生支持Windows。MegEngine 也支持在很多其它平台上进行推理运算。

通过包管理器安装

通过 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）来管理开源社区。请阅读 行为准则 了解更多信息。
• 每一名 MegEngine 的贡献者都需要签署贡献者许可协议（Contributor License Agreement，CLA）来明确贡献内容相关的知识产权许可。更多细节请参考 协议内容。
• 我们欢迎你通过以下方式来帮助 MegEngine 变得更好：
  • 贡献代码；
  • 完善文档；
  • 在 MegEngine 论坛 和 Stack Overflow 回答问题；
  • 在 MegEngine Model Hub 贡献新模型；
  • 在 MegStudio 平台尝试新想法；
  • 报告使用中的 Bugs 和 Issues；
  • 审查 Pull Requests；
  • 给 MegEngine 点亮小星星；
  • 在你的论文和文章中引用 MegEngine；
  • 向你的好友推荐 MegEngine；
  • ...

我们相信我们能够搭建一个开放友善的开源社区环境，用人工智能造福人类。

联系我们

• 问题: github.com/MegEngine/MegEngine/issues
• 邮箱: [email protected]
• 论坛: 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

如果在您的研究中使用了 MegEngine ，建议您使用如下 BibTeX 格式引用文案。

@Misc{MegEngine,
  institution = {megvii},
  title =  {MegEngine:A fast, scalable and easy-to-use deep learning framework},
  howpublished = {\url{https://github.com/MegEngine/MegEngine}},
  year = {2020}
}

Copyright (c) 2014-2021 Megvii Inc. All rights reserved.