Android build document in English #5029

wangkuiyi · 2017-10-24T01:00:26Z

No description provided.

Xreki

Thanks for your good translation. The English version seems much concise than the Chinese version. Maybe I need to refine and simplify the Chinese document.

Xreki · 2017-10-24T09:17:56Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+There are two approaches to build PaddlePaddle for Android:
+
+1. Use a Docker container, or
+2. cross-compiling on Linux.


In the Chinese version, the two items are the same as the two sub-titles. Do we need to keep the same here?

Got it. Done

Xreki · 2017-10-24T09:46:22Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+The ARM-64 architecture (`arm64-v8a`) requires at least level 21 of Android API.
+
+The default entry-point of the Docker image,[`paddle/scripts/docker/build_android.sh`](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/scripts/docker/build_android.sh) generates the [Android cross-compiling standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain.html) according to the value of `ANDROID_ABI` and `ANDROID_API`.  For information about other configuration parameters, please go on reading.


Need a space before [paddle/scripts/docker/build_android.sh]

Xreki · 2017-10-24T09:58:18Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+### Setup the Environment
+
+To install Android's C/C++ cross-compiling standalone toolchain, we need [Android NDK](https://developer.android.com/ndk/downloads/index.html?hl=zh-cn):


https://developer.android.com/ndk/downloads/index.html?hl=zh-cn -> https://developer.android.com/ndk/downloads/index.html

Xreki · 2017-10-24T10:30:19Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+unzip -q android-ndk-r14b-linux-x86_64.zip
+```
+
+Android NDK includes everything we need to build the cross-compiling toolchain.


In fact, some codes can directly use Android NDK to cross-compile, no need to generate the standalone toolchain. But for Paddle, some external libraries failed in my previous try. So standalone toolchain is needed for the current version, and I will fix the problem in the future. So I'd like to say:
Android NDK includes everything to cross-compile for Android, but standalone toolchain is needed for PaddlePaddle.

Xreki · 2017-10-24T10:32:53Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+Android NDK includes everything we need to build the cross-compiling toolchain.
+
+- To build the toolchain for `armeabi-v7a` and Android API level 21:


Android NDK is the toolchain, so I think it is better to use To build the standalone toolchain here.

Got it. Done.

Xreki · 2017-10-24T11:07:51Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+### Cross-Compiling Arguments
+
+CMake supports to [choose the toolchain](https://cmake.org/cmake/help/v3.0/manual/cmake-toolchains.7.html#cross-compiling).  PaddlePaddle provides [`android.cmake`](https://github.com/PaddlePaddle/Paddle/blob/develop/cmake/cross_compiling/android.cmake), which configures the Android cross-compiling toolchain for CMake.  `android.cmake` is not required for CMake >= 3.7, which starts supporting Android cross-compiling.  。PaddlePaddle detects CMake version, for those newer than 3.7, it uses [the official version](https://cmake.org/cmake/help/v3.7/manual/cmake-toolchains.7.html#cross-compiling).


I am a little confused about the meaning of choose the toolchain. I'd like to change it to CMake supports to cross-compile.
There is a extra 。

Xreki · 2017-10-24T11:10:01Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+CMake supports to [choose the toolchain](https://cmake.org/cmake/help/v3.0/manual/cmake-toolchains.7.html#cross-compiling).  PaddlePaddle provides [`android.cmake`](https://github.com/PaddlePaddle/Paddle/blob/develop/cmake/cross_compiling/android.cmake), which configures the Android cross-compiling toolchain for CMake.  `android.cmake` is not required for CMake >= 3.7, which starts supporting Android cross-compiling.  。PaddlePaddle detects CMake version, for those newer than 3.7, it uses [the official version](https://cmake.org/cmake/help/v3.7/manual/cmake-toolchains.7.html#cross-compiling).
+
+Some other CMake parameters you might want to know:


parameters -> arguments?
Some other CMake parameters you might want to know -> Some CMake arguments you have to know

Xreki · 2017-10-24T11:19:19Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+Some other CMake parameters you might want to know:
+
+- `CMAKE_SYSTEM_NAME` must be `Android`.  This tells PaddlePaddle's CMake system to cross-compile dependencies including protobuf library and the protoc executable, and ARM-enabled OpenBLAS.  This also changes some other CMake parameters like `WITH_GPU=OFF`, `WITH_AVX=OFF`, `WITH_PYTHON=OFF`, and `WITH_RDMA=OFF`.


protobuf library and the protoc executable, and ARM-enabled OpenBLAS, maybe detail is not needed here. Most people don't need to know the compiling process.

Xreki · 2017-10-24T11:26:37Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+### Build and Install
+
+After running `cmake`, we can run `make install` to build and install.


make install -> make; make install

Done. But usually, projects can be built using a single command make install.

Xreki · 2017-10-24T11:27:24Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+After running `cmake`, we can run `make install` to build and install.
+
+Before building, you might want to remove the `third_party` and `build` directories including pre-built libraries for other ARM architectures.


for other ARM architectures -> for other architectures

kavyasrinet

Thanks so much for doing this. I have added a bunch of Nits.

kavyasrinet · 2017-10-25T17:09:52Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+### Build the Docker Image
+
+The following steps pack tools we need to build PaddlePaddle into a Docker image.


Rephrase: The following steps pack all the tools that we need to build PaddlePaddle, into a Docker image.

kavyasrinet · 2017-10-25T17:11:22Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+### Build the Inference Library
+
+We can run this Docker image to build PaddlePaddle's inference library for Android:


Rephrase: We can run the Docker image we just created to build the inference library for PaddlePaddle for Android using the command below:

kavyasrinet · 2017-10-25T17:13:55Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+The ARM-64 architecture (`arm64-v8a`) requires at least level 21 of Android API.
+
+The default entry-point of the Docker image,[`paddle/scripts/docker/build_android.sh`](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/scripts/docker/build_android.sh) generates the [Android cross-compiling standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain.html) according to the value of `ANDROID_ABI` and `ANDROID_API`.  For information about other configuration parameters, please go on reading.


Rephrase : The default entry-point of the Docker image paddle/scripts/docker/build_android.sh generates the Android cross-compiling standalone toolchain based on the argument : ANDROID_ABI or ANDROID_API. For more information about other configuration parameters, please continue reading.

kavyasrinet · 2017-10-25T17:14:28Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+The default entry-point of the Docker image,[`paddle/scripts/docker/build_android.sh`](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/scripts/docker/build_android.sh) generates the [Android cross-compiling standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain.html) according to the value of `ANDROID_ABI` and `ANDROID_API`.  For information about other configuration parameters, please go on reading.
+
+Above command line generates and outputs the inference library in `$PWD/install_android` and puts third-party libraries in `$PWD/install_android/third_party`.


Rephrase: The above command generates and outputs the inference library in $PWD/install_android and puts third-party libraries in $PWD/install_android/third_party.

kavyasrinet · 2017-10-25T17:16:10Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+## Linux-based Cross-Compiling
+
+The Linux-base approach is to run steps in `Dockerfile.android` manually on a Linux x64 computer.


Rephrase: The Linux-based approach to cross-compile is to run steps in Dockerfile.android manually on a Linux x64 computer.

kavyasrinet · 2017-10-25T17:18:54Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+### Cross-Compiling Arguments
+
+CMake supports to [choose the toolchain](https://cmake.org/cmake/help/v3.0/manual/cmake-toolchains.7.html#cross-compiling).  PaddlePaddle provides [`android.cmake`](https://github.com/PaddlePaddle/Paddle/blob/develop/cmake/cross_compiling/android.cmake), which configures the Android cross-compiling toolchain for CMake.  `android.cmake` is not required for CMake >= 3.7, which starts supporting Android cross-compiling.  。PaddlePaddle detects CMake version, for those newer than 3.7, it uses [the official version](https://cmake.org/cmake/help/v3.7/manual/cmake-toolchains.7.html#cross-compiling).


Rephrase: CMake supports choosing the toolchain. PaddlePaddle provides android.cmake, which configures the Android cross-compiling toolchain for CMake. android.cmake is not required for CMake versions >= 3.7, which support Android cross-compiling. PaddlePaddle detects the CMake version, for those newer than 3.7, it uses the official version.

kavyasrinet · 2017-10-25T17:22:03Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+Some Android-specific parameters:
+
+- `ANDROID_STANDALONE_TOOLCHAIN` the absolute path of the Android standalone toolchain, or the path relative to the CMake build directory.  PaddlePaddle's CMake extensions would derive the cross-compiler, sysroot and Android API level from this parameter.


ANDROID_STANDALONE_TOOLCHAIN => ANDROID_STANDALONE_TOOLCHAIN:

kavyasrinet · 2017-10-25T17:22:57Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+
+Other useful parameters:
+
+- `USE_EIGEN_FOR_BLAS` indicates if using Eigen.  Could be `ON` or `OFF`, defaults to `OFF`.


USE_EIGEN_FOR_BLAS => USE_EIGEN_FOR_BLAS:

kavyasrinet · 2017-10-25T17:23:18Z

doc/howto/cross_compiling/cross_compiling_for_android.md

+Other useful parameters:
+
+- `USE_EIGEN_FOR_BLAS` indicates if using Eigen.  Could be `ON` or `OFF`, defaults to `OFF`.
+- `HOST_C/CXX_COMPILER` specifies the host compiler, which is used to build the host-specific protoc and target-specific OpenBLAS.  It defaults to the value of the environment variable `CC`, or `cc`.


HOST_C/CXX_COMPILER => HOST_C/CXX_COMPILER:

… android_build

kavyasrinet

LGTM. Thanks for updating.

Xreki

LGTM, except that we need to name the English documentation file to cross_compiling_for_android_en.md. We will add the documentation to index.rst, and it cannot be correctly generated if not with _cn or _en suffix.

Xreki · 2017-11-03T03:10:58Z

I merge this PR and will give a PR to rename to file.

Yi Wang added 2 commits October 23, 2017 17:58

Add English version of Android cross-compiling document

cd26f13

Add English version of Android cross-compiling document

e1078a4

wangkuiyi requested review from Xreki and kavyasrinet October 24, 2017 01:00

Xreki reviewed Oct 24, 2017

View reviewed changes

kavyasrinet reviewed Oct 25, 2017

View reviewed changes

wangkuiyi added 2 commits October 26, 2017 17:26

Follow comments from Yi-qun and Kavya

52119aa

Merge branch 'develop' of https://github.com/paddlepaddle/paddle into…

4da5508

… android_build

kavyasrinet approved these changes Oct 29, 2017

View reviewed changes

Xreki approved these changes Oct 30, 2017

View reviewed changes

Xreki added the Android label Oct 30, 2017

Xreki added this to Design & Doc in Embedded and Mobile Deployment Oct 30, 2017

Xreki merged commit 1796a2a into PaddlePaddle:develop Nov 3, 2017


		The ARM-64 architecture (`arm64-v8a`) requires at least level 21 of Android API.

		The default entry-point of the Docker image,[`paddle/scripts/docker/build_android.sh`](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/scripts/docker/build_android.sh) generates the [Android cross-compiling standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain.html) according to the value of `ANDROID_ABI` and `ANDROID_API`. For information about other configuration parameters, please go on reading.


		### Setup the Environment

		To install Android's C/C++ cross-compiling standalone toolchain, we need [Android NDK](https://developer.android.com/ndk/downloads/index.html?hl=zh-cn):


		Android NDK includes everything we need to build the cross-compiling toolchain.

		- To build the toolchain for `armeabi-v7a` and Android API level 21:


		### Cross-Compiling Arguments

		CMake supports to [choose the toolchain](https://cmake.org/cmake/help/v3.0/manual/cmake-toolchains.7.html#cross-compiling). PaddlePaddle provides [`android.cmake`](https://github.com/PaddlePaddle/Paddle/blob/develop/cmake/cross_compiling/android.cmake), which configures the Android cross-compiling toolchain for CMake. `android.cmake` is not required for CMake >= 3.7, which starts supporting Android cross-compiling. 。PaddlePaddle detects CMake version, for those newer than 3.7, it uses [the official version](https://cmake.org/cmake/help/v3.7/manual/cmake-toolchains.7.html#cross-compiling).


		CMake supports to [choose the toolchain](https://cmake.org/cmake/help/v3.0/manual/cmake-toolchains.7.html#cross-compiling). PaddlePaddle provides [`android.cmake`](https://github.com/PaddlePaddle/Paddle/blob/develop/cmake/cross_compiling/android.cmake), which configures the Android cross-compiling toolchain for CMake. `android.cmake` is not required for CMake >= 3.7, which starts supporting Android cross-compiling. 。PaddlePaddle detects CMake version, for those newer than 3.7, it uses [the official version](https://cmake.org/cmake/help/v3.7/manual/cmake-toolchains.7.html#cross-compiling).

		Some other CMake parameters you might want to know:


		Some other CMake parameters you might want to know:

		- `CMAKE_SYSTEM_NAME` must be `Android`. This tells PaddlePaddle's CMake system to cross-compile dependencies including protobuf library and the protoc executable, and ARM-enabled OpenBLAS. This also changes some other CMake parameters like `WITH_GPU=OFF`, `WITH_AVX=OFF`, `WITH_PYTHON=OFF`, and `WITH_RDMA=OFF`.


		### Build and Install

		After running `cmake`, we can run `make install` to build and install.


		After running `cmake`, we can run `make install` to build and install.

		Before building, you might want to remove the `third_party` and `build` directories including pre-built libraries for other ARM architectures.


		### Build the Docker Image

		The following steps pack tools we need to build PaddlePaddle into a Docker image.


		### Build the Inference Library

		We can run this Docker image to build PaddlePaddle's inference library for Android:


		The default entry-point of the Docker image,[`paddle/scripts/docker/build_android.sh`](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/scripts/docker/build_android.sh) generates the [Android cross-compiling standalone toolchain](https://developer.android.com/ndk/guides/standalone_toolchain.html) according to the value of `ANDROID_ABI` and `ANDROID_API`. For information about other configuration parameters, please go on reading.

		Above command line generates and outputs the inference library in `$PWD/install_android` and puts third-party libraries in `$PWD/install_android/third_party`.


		## Linux-based Cross-Compiling

		The Linux-base approach is to run steps in `Dockerfile.android` manually on a Linux x64 computer.


		Some Android-specific parameters:

		- `ANDROID_STANDALONE_TOOLCHAIN` the absolute path of the Android standalone toolchain, or the path relative to the CMake build directory. PaddlePaddle's CMake extensions would derive the cross-compiler, sysroot and Android API level from this parameter.


		Other useful parameters:

		- `USE_EIGEN_FOR_BLAS` indicates if using Eigen. Could be `ON` or `OFF`, defaults to `OFF`.

Android build document in English #5029

Android build document in English #5029

Conversation

wangkuiyi commented Oct 24, 2017

Xreki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kavyasrinet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kavyasrinet left a comment • edited

Choose a reason for hiding this comment

Xreki left a comment • edited

Choose a reason for hiding this comment

Xreki commented Nov 3, 2017

kavyasrinet left a comment •

edited

Xreki left a comment •

edited