1 Star 2 Fork 1

AX0424 / MegEngine

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

MegEngine

MegEngine Logo

English | 中文

MegEngine 是一个快速、可拓展、易于使用且支持自动求导的深度学习框架。


安装说明

注意: MegEngine 现在仅支持 Linux 平台安装,以及 Python3.5 及以上的版本(不支持 Python2 )。对于 Windows 10 用户,可以通过安装 WSL(Windows Subsystem for Linux) 进行体验。

通过包管理器安装

通过 pip 安装的命令如下:

pip3 install megengine -f https://megengine.org.cn/whl/mge.html

通过源码编译安装

环境依赖

大多数编译 MegEngine 的依赖位于 third_party 目录,可以通过以下命令自动安装:

$ ./third_party/prepare.sh
$ ./third_party/install-mkl.sh

但是有一些依赖需要手动安装:

  • CUDA(>=10.1), cuDNN(>=7.6) ,如果需要编译支持 CUDA 的版本(默认开启)
  • TensorRT(>=5.1.5) ,如果需要编译支持 TensorRT 的版本(默认开启)
  • LLVM/Clang(>=6.0) ,如果需要编译支持 Halide JIT 的版本(默认开启)
  • Python(>=3.5), Numpy, SWIG(>=3.0) ,如果需要编译生成 Python 模块(默认开启)

开始编译

MegEngine 遵循“源外构建”(Out-of-Source Build)原则,并且使用静态编译方式。编译的具体流程如下:

  1. 创建用于编译的目录:

    mkdir -p build
    cd build
  2. 使用 CMake 生成编译配置:

    生成支持 CUDA 环境的配置:

    cmake .. -DMGE_WITH_TEST=ON

    生成仅支持 CPU 环境的配置,使用 -DMGE_WITH_CUDA=OFF 选项:

    cmake .. -DMGE_WITH_CUDA=OFF -DMGE_WITH_TEST=ON

    生成仅用于 C++ 环境部署的配置,使用 -DMGE_INFERENCE_ONLY=ON ,并可用 -DMGE_WITH_TEST=OFF 关闭测试:

    cmake .. -DMGE_INFERENCE_ONLY=ON -DMGE_WITH_TEST=OFF

    可以使用 -DCMAKE_INSTALL_PREFIX=YOUR_PATH 指定具体安装目录。

  3. 开始编译:

    make -j$(nproc)
  4. [可选] 如果需要用于部署,可以安装 MegEngine 的 C++ 库:

    make install

以下是其它常用编译选项:

  • MGE_ARCH 指定编译的目标平台(默认自动检测当前平台)
  • MGE_WITH_DISTRIBUTED 是否开启多机分布式支持(默认开启)
  • MGE_WITH_PYTHON_MODULE 是否编译生成 Python 模块(默认开启)
  • MGE_BLAS 选择 BLAS 的后端实现,可以是 MKLOpenBLAS (默认 MKL
  • MGE_CUDA_GENCODE 指定提供给 nvcc-gencode 选项(默认不指定)
  • MGE_DISABLE_FLOAT16 是否不提供 float16 类型支持(默认关闭)
  • MGE_ENABLE_EXCEPTIONS 是否开启 C++ 报错支持(默认开启)
  • MGE_ENABLE_LOGGING 是否开启 MegEngine 日志信息(默认自动检测)

更多选项可以通过以下命令查看:

cd build
cmake -LAH .. 2>/dev/null| grep -B 1 'MGE_' | less

如何参与贡献

  • MegEngine 依据 贡献者公约(Contributor Covenant)来管理开源社区。请阅读 行为准则 了解更多信息。
  • 每一名 MegEngine 的贡献者都需要签署贡献者许可协议(Contributor License Agreement,CLA)来明确贡献内容相关的知识产权许可。更多细节请参考 协议内容
  • 我们欢迎你通过以下方式来帮助 MegEngine 变得更好:

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

联系我们

资源

开源许可

MegEngine 使用 Apache License, Version 2.0

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

MegEngine is Licensed under the Apache License, Version 2.0 (the "License") Copyright (c) 2014-2020 Megvii Inc. All rights reserved. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT ARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS

简介

MegEngine 是一个快速、可拓展、易于使用且支持自动求导的深度学习框架 展开 收起
C++
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/arthurxu424/MegEngine.git
git@gitee.com:arthurxu424/MegEngine.git
arthurxu424
MegEngine
MegEngine
master

搜索帮助