cross_compiling_for_ios_en.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Build PaddlePaddle for iOS &mdash; PaddlePaddle  documentation</title>
  

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="Index"
              href="../genindex.html"/>
        <link rel="search" title="Search" href="../search.html"/>
    <link rel="top" title="PaddlePaddle  documentation" href="../index.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

            <a href="../index_en.html" class="icon icon-home"> PaddlePaddle
          

          </a>

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
                <ul>
<li class="toctree-l1"><a class="reference internal" href="../getstarted/index_en.html">GET STARTED</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_and_install/index_en.html">Install and Build</a></li>
<li class="toctree-l1"><a class="reference internal" href="../howto/index_en.html">HOW TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev/index_en.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq/index_en.html">FAQ</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index_en.html">PaddlePaddle</a>
      </nav>


      <div class="wy-nav-content">
        <div class="rst-content">
          

<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index_en.html">Docs</a> &raquo;</li>
      
    <li>Build PaddlePaddle for iOS</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/mobile/cross_compiling_for_ios_en.md.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="build-paddlepaddle-for-ios">
<span id="build-paddlepaddle-for-ios"></span><h1>Build PaddlePaddle for iOS<a class="headerlink" href="#build-paddlepaddle-for-ios" title="Permalink to this headline">¶</a></h1>
<p>This tutorial will walk you through cross compiling the PaddlePaddle library for iOS from the source in MacOS.</p>
<div class="section" id="preparation">
<span id="preparation"></span><h2>Preparation<a class="headerlink" href="#preparation" title="Permalink to this headline">¶</a></h2>
<p>Apple provides Xcode for cross-compiling and IDE for iOS development. Download from App store or <a class="reference external" href="https://developer.apple.com/cn/xcode/">here</a>. To verify your installation, run command as follows</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$ xcodebuild -version
Xcode <span class="m">9</span>.0
Build version 9A235
</pre></div>
</div>
</div>
<div class="section" id="cross-compiling-configurations">
<span id="cross-compiling-configurations"></span><h2>Cross-compiling configurations<a class="headerlink" href="#cross-compiling-configurations" title="Permalink to this headline">¶</a></h2>
<p>PaddlePaddle provides cross-compiling toolchain configuration documentation <a class="reference external" href="https://github.com/PaddlePaddle/Paddle/blob/develop/cmake/cross_compiling/ios.cmake">cmake/cross_compiling/ios.cmake</a>, which has some default settings for frequently used compilers.</p>
<p>There are some mandatory environment variables need to be set before cross compiling PaddlePaddle for iOS:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">CMAKE_SYSTEM_NAME</span></code>, CMake compiling target platform name, has to be <code class="docutils literal"><span class="pre">iOS</span></code>. PaddlePaddle CMake will compile all the third party dependencies and enforce some parameters (<code class="docutils literal"><span class="pre">WITH_C_API=ON</span></code>, <code class="docutils literal"><span class="pre">WITH_GPU=OFF</span></code>, <code class="docutils literal"><span class="pre">WITH_AVX=OFF</span></code>, <code class="docutils literal"><span class="pre">WITH_PYTHON=OFF</span></code>,<code class="docutils literal"><span class="pre">WITH_RDMA=OFF</span></code>) when this variable is set with value <code class="docutils literal"><span class="pre">iOS</span></code>.</li>
<li><code class="docutils literal"><span class="pre">WITH_C_API</span></code>, Whether to compile inference C-API library, has to be <code class="docutils literal"><span class="pre">ON</span></code>, since C-API is the only supported interface for inferencing in iOS.</li>
<li><code class="docutils literal"><span class="pre">WITH_SWIG_PY</span></code>, has to be <code class="docutils literal"><span class="pre">OFF</span></code>. It&#8217;s not supported to inference or train via swig in iOS.</li>
</ul>
<p>Optional environment variables for iOS are:</p>
<ul>
<li><p class="first"><code class="docutils literal"><span class="pre">IOS_PLATFORM</span></code>, either <code class="docutils literal"><span class="pre">OS</span></code> (default) or <code class="docutils literal"><span class="pre">SIMULATOR</span></code>.</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">OS</span></code>, build targets ARM-based physical devices like iPhone or iPad.</li>
<li><code class="docutils literal"><span class="pre">SIMULATOR</span></code>, build targets x86 architecture simulators.</li>
</ul>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">IOS_ARCH</span></code>, target architecture. By default, all architecture types will be compiled. If you need to specify the architecture to compile for, please find valid values for different <code class="docutils literal"><span class="pre">IOS_PLATFORM</span></code> settings from the table below:</p>
  <table class="docutils">
  <colgroup>
    <col width="35%" />
    <col width="65%" />
  </colgroup>
  <thead valign="bottom">
    <tr class="row-odd">
    <th class="head">IOS_PLATFORM</th>
    <th class="head">IOS_ARCH</th>
  </tr>
  </thead>
  <tbody valign="top">
    <tr class="row-even">
    <td>OS</td>
    <td>armv7, armv7s, arm64 </td>
  </tr>
  <tr class="row-odd">
    <td>SIMULATOR</td>
    <td>i386, x86_64 </td>
  </tr>
  </tbody>
  </table></li>
<li><p class="first"><code class="docutils literal"><span class="pre">IOS_DEPLOYMENT_TARGET</span></code>, minimum iOS version to deployment, <code class="docutils literal"><span class="pre">7.0</span></code> by default.</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">IOS_ENABLE_BITCODE</span></code>, whether to enable <a class="reference external" href="https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/AppThinning/AppThinning.html#//apple_ref/doc/uid/TP40012582-CH35-SW3">Bitcode</a>, values can be <code class="docutils literal"><span class="pre">ON/OFF</span></code>, <code class="docutils literal"><span class="pre">ON</span></code> by default.</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">IOS_USE_VECLIB_FOR_BLAS</span></code>, whether to use <a class="reference external" href="https://developer.apple.com/documentation/accelerate/veclib">vecLib</a> framework for BLAS computing. values can be <code class="docutils literal"><span class="pre">ON/OFF</span></code>, <code class="docutils literal"><span class="pre">OFF</span></code> by default.</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">IOS_DEVELOPMENT_ROOT</span></code>, the path to <code class="docutils literal"><span class="pre">Developer</span></code> directory, can be explicitly set with your <code class="docutils literal"><span class="pre">/path/to/platform/Developer</span></code>. If left blank, PaddlePaddle will automatically pick the Xcode corresponding <code class="docutils literal"><span class="pre">platform</span></code>&#8216;s <code class="docutils literal"><span class="pre">Developer</span></code> directory based on your <code class="docutils literal"><span class="pre">IOS_PLATFORM</span></code> value.</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">IOS_SDK_ROOT</span></code>, the path to <code class="docutils literal"><span class="pre">SDK</span></code> root, can be explicitly set with your  <code class="docutils literal"><span class="pre">/path/to/platform/Developer/SDKs/SDK</span></code>. if left black, PaddlePaddle will pick the latest SDK in the directory of <code class="docutils literal"><span class="pre">IOS_DEVELOPMENT_ROOT</span></code>.</p>
</li>
</ul>
<p>other settings：</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">USE_EIGEN_FOR_BLAS</span></code>, whether to use Eigen for matrix computing. effective when <code class="docutils literal"><span class="pre">IOS_USE_VECLIB_FOR_BLAS=OFF</span></code>. Values can be <code class="docutils literal"><span class="pre">ON/OFF</span></code>, <code class="docutils literal"><span class="pre">OFF</span></code> by default.</li>
<li><code class="docutils literal"><span class="pre">HOST_C/CXX_COMPILER</span></code>, host C/C++ compiler. Uses value from environment variable <code class="docutils literal"><span class="pre">CC/CXX</span></code> by default or <code class="docutils literal"><span class="pre">cc/c++</span></code> if <code class="docutils literal"><span class="pre">CC/CXX</span></code> doesn&#8217;t exist.</li>
</ul>
<p>some typical cmake configurations:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>cmake -DCMAKE_SYSTEM_NAME<span class="o">=</span>iOS <span class="se">\</span>
      -DIOS_PLATFORM<span class="o">=</span>OS <span class="se">\</span>
      -DIOS_ARCH<span class="o">=</span><span class="s2">&quot;armv7;arm64&quot;</span> <span class="se">\</span>
      -DIOS_ENABLE_BITCODE<span class="o">=</span>ON <span class="se">\</span>
      -DIOS_USE_VECLIB_FOR_BLAS<span class="o">=</span>ON <span class="se">\</span>
      -DCMAKE_INSTALL_PREFIX<span class="o">=</span>your/path/to/install <span class="se">\</span>
      -DWITH_C_API<span class="o">=</span>ON <span class="se">\</span>
      -DWITH_TESTING<span class="o">=</span>OFF <span class="se">\</span>
      -DWITH_SWIG_PY<span class="o">=</span>OFF <span class="se">\</span>
      ..
</pre></div>
</div>
<div class="highlight-bash"><div class="highlight"><pre><span></span>cmake -DCMAKE_SYSTEM_NAME<span class="o">=</span>iOS <span class="se">\</span>
      -DIOS_PLATFORM<span class="o">=</span>SIMULATOR <span class="se">\</span>
      -DIOS_ARCH<span class="o">=</span><span class="s2">&quot;x86_64&quot;</span> <span class="se">\</span>
      -DIOS_USE_VECLIB_FOR_BLAS<span class="o">=</span>ON <span class="se">\</span>
      -DCMAKE_INSTALL_PREFIX<span class="o">=</span>your/path/to/install <span class="se">\</span>
      -DWITH_C_API<span class="o">=</span>ON <span class="se">\</span>
      -DWITH_TESTING<span class="o">=</span>OFF <span class="se">\</span>
      -DWITH_SWIG_PY<span class="o">=</span>OFF <span class="se">\</span>
      ..
</pre></div>
</div>
<p>You can set other compiling parameters for your own need. I.E. if you are trying to minimize the library size, set <code class="docutils literal"><span class="pre">CMAKE_BUILD_TYPE</span></code> with <code class="docutils literal"><span class="pre">MinSizeRel</span></code>; or if the performance is your concern, set <code class="docutils literal"><span class="pre">CMAKE_BUILD_TYPE</span></code> with <code class="docutils literal"><span class="pre">Release</span></code>. You can even manipulate the PaddlePaddle compiling procedure by manually set <code class="docutils literal"><span class="pre">CMAKE_C/CXX_FLAGS</span></code> values.</p>
<p><strong>TIPS for a better performance</strong>:</p>
<ul class="simple">
<li>set <code class="docutils literal"><span class="pre">CMAKE_BUILD_TYPE</span></code> with <code class="docutils literal"><span class="pre">Release</span></code></li>
<li>set <code class="docutils literal"><span class="pre">IOS_USE_VECLIB_FOR_BLAS</span></code> with <code class="docutils literal"><span class="pre">ON</span></code></li>
</ul>
</div>
<div class="section" id="build-and-install">
<span id="build-and-install"></span><h2>Build and install<a class="headerlink" href="#build-and-install" title="Permalink to this headline">¶</a></h2>
<p>After CMake, run following commands, PaddlePaddle will download the compile 3rd party dependencies, compile and install PaddlePaddle inference library.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ make
$ make install
</pre></div>
</div>
<p>Please Note: if you compiled PaddlePaddle in the source directory for other platforms, do remove <code class="docutils literal"><span class="pre">third_party</span></code> and <code class="docutils literal"><span class="pre">build</span></code> directory within the source with <code class="docutils literal"><span class="pre">rm</span> <span class="pre">-rf</span></code> to ensure that all the 3rd party libraries dependencies and PaddlePaddle is newly compiled with current CMake configuration.</p>
<p><code class="docutils literal"><span class="pre">your/path/to/install</span></code> directory will have following directories after <code class="docutils literal"><span class="pre">make</span> <span class="pre">install</span></code>:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">include</span></code>, contains all the C-API header files.</li>
<li><code class="docutils literal"><span class="pre">lib</span></code>, contains PaddlePaddle C-API static library.</li>
<li><code class="docutils literal"><span class="pre">third_party</span></code> contains all the 3rd party libraries.</li>
</ul>
<p>Please note: if PaddlePaddle library need to support both physical devices and simulators, you will need to compile correspondingly, then merge fat library with <code class="docutils literal"><span class="pre">lipo</span></code>.</p>
<p>Now you will have PaddlePaddle library compiled and installed, the fat library can be used in deep learning related iOS APPs. Please refer to C-API documentation for usage guides.</p>
</div>
</div>


           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, PaddlePaddle developers.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>