@@ -12,57 +12,56 @@ MegEngine is a fast, scalable and easy-to-use deep learning framework, with auto
...
@@ -12,57 +12,56 @@ MegEngine is a fast, scalable and easy-to-use deep learning framework, with auto
## Installation
## Installation
**NOTE:** MegEngine now supports Linux-64bit/Windows-64bit/MacOS-10.14+ (CPU-Only) Platforms with Python from 3.5 to 3.8. On Windows 10 you can either install the Linux distribution through [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl) or install the Windows distribution directly.
**NOTE:** MegEngine now supports Python installation on Linux-64bit/Windows-64bit/MacOS(CPU-Only)-10.14+ platforms with Python from 3.5 to 3.8. On Windows 10 you can either install the Linux distribution through [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl) or install the Windows distribution directly. Many other platforms are supported for inference.
### Binaries
### Binaries
Commands to install from binaries via pip wheels are as follows:
Most of the dependencies of MegEngine are located in `third_party` directory, which can be prepared by executing:
Most of the dependencies of MegEngine are located in [third_party](third_party) directory, which can be prepared by executing:
```bash
```bash
./third_party/prepare.sh
./third_party/prepare.sh
./third_party/install-mkl.sh
./third_party/install-mkl.sh
```
```
But some dependencies need to be Installed manually:
But some dependencies need to be installed manually:
*[CUDA](https://developer.nvidia.com/cuda-toolkit-archive)(>=10.1), [cuDNN](https://developer.nvidia.com/cudnn)(>=7.6)are required when building MegEngine with CUDA support.
*[CUDA](https://developer.nvidia.com/cuda-toolkit-archive)(>=10.1), [cuDNN](https://developer.nvidia.com/cudnn)(>=7.6)are required when building MegEngine with CUDA support.
*[TensorRT](https://docs.nvidia.com/deeplearning/sdk/tensorrt-archived/index.html)(>=5.1.5) is required when building with TensorRT support.
*[TensorRT](https://docs.nvidia.com/deeplearning/sdk/tensorrt-archived/index.html)(>=5.1.5) is required when building with TensorRT support.
* LLVM/Clang(>=6.0) is required when building with Halide JIT support.
* LLVM/Clang(>=6.0) is required when building with Halide JIT support.
* Python(>=3.5), Numpy, are required to build Python modules.
* Python(>=3.5) and numpy are required to build Python modules.
### Build
### Build
MegEngine uses CMake as the build tool.
MegEngine uses CMake as the build tool.
We provide the following scripts to facilitate building.
We provide the following scripts to facilitate building.
*[host_build.sh](scripts/cmake-build/host_build.sh)is to build MegEngine targeted to run on the same host machine.
*[host_build.sh](scripts/cmake-build/host_build.sh)builds MegEngine that runs on the same host machine (i.e., no cross compiling).
Please run the following command to get help information:
The following command displays the usage:
```
```
scripts/cmake-build/host_build.sh -h
scripts/cmake-build/host_build.sh -h
```
```
*[cross_build_android_arm_inference.sh](scripts/cmake-build/cross_build_android_arm_inference.sh)is to build MegEngine targeted to run at Android-ARM platforms.
*[cross_build_android_arm_inference.sh](scripts/cmake-build/cross_build_android_arm_inference.sh)builds MegEngine for DNN inference on Android-ARM platforms.
Please run the following command to get help information:
*[cross_build_linux_arm_inference.sh](scripts/cmake-build/cross_build_linux_arm_inference.sh)is to build MegEngine targeted to run at Linux-ARM platforms.
*[cross_build_linux_arm_inference.sh](scripts/cmake-build/cross_build_linux_arm_inference.sh)builds MegEngine for DNN inference on Linux-ARM platforms.
Please run the following command to get help information:
*[cross_build_ios_arm_inference.sh](scripts/cmake-build/cross_build_ios_arm_inference.sh)is to build MegEngine targeted to run iphone/iPad platforms.
*[cross_build_ios_arm_inference.sh](scripts/cmake-build/cross_build_ios_arm_inference.sh)builds MegEngine for DNN inference on iOS (iPhone/iPad) platforms.
Please run the following command to get help information:
@@ -70,9 +69,9 @@ Please refer to [BUILD_README.md](scripts/cmake-build/BUILD_README.md) for more
...
@@ -70,9 +69,9 @@ Please refer to [BUILD_README.md](scripts/cmake-build/BUILD_README.md) for more
## How to Contribute
## How to Contribute
* MegEngine adopts [Contributor Covenant](https://contributor-covenant.org)to maintain our community. Please read the [Code of Conduct](CODE_OF_CONDUCT.md) to get more information.
* MegEngine adopts [Contributor Covenant](https://contributor-covenant.org)as a guideline to run our community. Please read the [Code of Conduct](CODE_OF_CONDUCT.md).
* Every contributor of MegEngine must sign a Contributor License Agreement (CLA) to clarify the intellectual property license granted with the contributions. For more details, please refer [Contributor License Agreement](CONTRIBUTOR_LICENSE_AGREEMENT.md)
* Every contributor of MegEngine must sign a [Contributor License Agreement (CLA)](CONTRIBUTOR_LICENSE_AGREEMENT.md) to clarify the intellectual property license granted with the contributions.