Modified: incubator/singa/site/trunk/en/docs/installation.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/installation.html?rev=1831195&r1=1831194&r2=1831195&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/installation.html (original) +++ incubator/singa/site/trunk/en/docs/installation.html Tue May 8 15:05:16 2018 @@ -14,30 +14,24 @@ - - - - - <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="incubator-singa 1.1.0 documentation" href="../index.html"/> - <link rel="up" title="Documentation" href="index.html"/> - <link rel="next" title="Software Stack" href="software_stack.html"/> - <link rel="prev" title="Documentation" href="index.html"/> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Software Stack" href="software_stack.html" /> + <link rel="prev" title="Documentation" href="index.html" /> <link href="../_static/style.css" rel="stylesheet" type="text/css"> @@ -46,8 +40,9 @@ </head> -<body class="wy-body-for-nav" role="document"> +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> @@ -62,7 +57,7 @@ - <img src="../_static/singa.png" class="logo" /> + <img src="../_static/singa.png" class="logo" alt="Logo"/> </a> @@ -91,7 +86,10 @@ - <ul class="current"> + + + + <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../downloads.html">Download SINGA</a></li> <li class="toctree-l1 current"><a class="reference internal" href="index.html">Documentation</a><ul class="current"> <li class="toctree-l2 current"><a class="current reference internal" href="#">Installation</a><ul> @@ -153,34 +151,54 @@ <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.html">incubator-singa</a> + <nav class="wy-nav-top" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">incubator-singa</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.html">Docs</a> »</li> - + + <li><a href="../index.html">Docs</a> »</li> + <li><a href="index.html">Documentation</a> »</li> - - <li>Installation</li> + + <li>Installation</li> + + <li class="wy-breadcrumbs-aside"> - + </li> + </ul> + + <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> @@ -196,15 +214,15 @@ Currently, SINGA has conda packages (Pyt <span id="linux"></span><h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3> <ol> <li><p class="first">CPU only</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span> </pre></div> </div> </li> <li><p class="first">GPU via CUDA+cuDNN</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span><span class="o">-</span><span class="n">cudax</span><span class="o">.</span><span class="n">y</span><span class="o">-</span><span class="n">cudnnz</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span><span class="o">-</span><span class="n">cudax</span><span class="o">.</span><span class="n">y</span><span class="o">-</span><span class="n">cudnnz</span> </pre></div> </div> -<p>where <code class="docutils literal"><span class="pre">x.y,z</span></code> is one of <8.0, 5>, <7.5, 5> and <7.5, 4>. +<p>where <code class="docutils literal notranslate"><span class="pre">x.y,z</span></code> is one of <8.0, 5>, <7.5, 5> and <7.5, 4>. Users need to install CUDA and cuDNN before installing SINGA. If cuDNN is not in system folders (e.g., /usr/local), export the folder of libcudnn.so to LD_LIBRARY_PATH</p> </li> @@ -213,12 +231,12 @@ If cuDNN is not in system folders (e.g., <div class="section" id="mac-osx"> <span id="mac-osx"></span><h3>Mac OSX<a class="headerlink" href="#mac-osx" title="Permalink to this headline">¶</a></h3> <p>Only the CPU version is available,</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">config</span> <span class="o">--</span><span class="n">add</span> <span class="n">channels</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">config</span> <span class="o">--</span><span class="n">add</span> <span class="n">channels</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">nusdbsystem</span> <span class="n">singa</span> </pre></div> </div> <p>If there is no error message from</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"from singa import tensor"</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"from singa import tensor"</span> </pre></div> </div> <p>then SINGA is installed successfully.</p> @@ -259,15 +277,15 @@ If cuDNN is not in system folders (e.g., <td>-</td> </tr> </table><p>Download the deb file and install it via</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="o"><</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">deb</span> <span class="n">file</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span><span class="p">,</span> <span class="o">./</span><span class="n">python</span><span class="o">-</span><span class="n">singa</span><span class="o">.</span><span class="n">deb</span><span class="o">></span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="o"><</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">deb</span> <span class="n">file</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span><span class="p">,</span> <span class="o">./</span><span class="n">python</span><span class="o">-</span><span class="n">singa</span><span class="o">.</span><span class="n">deb</span><span class="o">></span> </pre></div> </div> -<p>Note that the path must include <code class="docutils literal"><span class="pre">./</span></code> if the file in inside the current folder.</p> +<p>Note that the path must include <code class="docutils literal notranslate"><span class="pre">./</span></code> if the file in inside the current folder.</p> </div> <div class="section" id="from-source"> <span id="from-source"></span><h2>From source<a class="headerlink" href="#from-source" title="Permalink to this headline">¶</a></h2> <p>The source files could be downloaded either as a <a class="reference external" href="https://dist.apache.org/repos/dist/dev/incubator/singa/";>tar.gz file</a>, or as a git repo</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ git clone https://github.com/apache/incubator-singa.git +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/apache/incubator-singa.git $ cd incubator-singa/ </pre></div> </div> @@ -292,21 +310,21 @@ $ cd incubator-singa/ <div class="section" id="instructions"> <span id="instructions"></span><h3>Instructions<a class="headerlink" href="#instructions" title="Permalink to this headline">¶</a></h3> <ol class="simple"> -<li>create a <code class="docutils literal"><span class="pre">build</span></code> folder inside incubator-singa and go into that folder</li> -<li>run <code class="docutils literal"><span class="pre">cmake</span> <span class="pre">[options]</span> <span class="pre">..</span></code> -by default all options are OFF except <code class="docutils literal"><span class="pre">USE_PYTHON</span></code><ul> -<li><code class="docutils literal"><span class="pre">USE_MODULES=ON</span></code>, used if protobuf and blas are not installed a prior</li> -<li><code class="docutils literal"><span class="pre">USE_CUDA=ON</span></code>, used if CUDA and cuDNN is available</li> -<li><code class="docutils literal"><span class="pre">USE_PYTHON=ON</span></code>, used for compiling PySINGA</li> -<li><code class="docutils literal"><span class="pre">USE_OPENCL=ON</span></code>, used for compiling with OpenCL support</li> -<li><code class="docutils literal"><span class="pre">PYTHON3=ON</span></code>, used for compiling with Python 3 support. (The default is Python 2)</li> -<li><code class="docutils literal"><span class="pre">PACKAGE=ON</span></code>, used for building the Debian package</li> +<li>create a <code class="docutils literal notranslate"><span class="pre">build</span></code> folder inside incubator-singa and go into that folder</li> +<li>run <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">[options]</span> <span class="pre">..</span></code> +by default all options are OFF except <code class="docutils literal notranslate"><span class="pre">USE_PYTHON</span></code><ul> +<li><code class="docutils literal notranslate"><span class="pre">USE_MODULES=ON</span></code>, used if protobuf and blas are not installed a prior</li> +<li><code class="docutils literal notranslate"><span class="pre">USE_CUDA=ON</span></code>, used if CUDA and cuDNN is available</li> +<li><code class="docutils literal notranslate"><span class="pre">USE_PYTHON=ON</span></code>, used for compiling PySINGA</li> +<li><code class="docutils literal notranslate"><span class="pre">USE_OPENCL=ON</span></code>, used for compiling with OpenCL support</li> +<li><code class="docutils literal notranslate"><span class="pre">USE_PYTHON3=ON</span></code>, used for compiling with Python 3 support. (The default is Python 2)</li> +<li><code class="docutils literal notranslate"><span class="pre">PACKAGE=ON</span></code>, used for building the Debian package</li> </ul> </li> -<li>compile the code, e.g., <code class="docutils literal"><span class="pre">make</span></code></li> +<li>compile the code, e.g., <code class="docutils literal notranslate"><span class="pre">make</span></code></li> <li>goto python folder</li> -<li>run <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">.</span></code></li> -<li>[optional] run <code class="docutils literal"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">bdist_wheel</span></code> to generate the wheel file</li> +<li>run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">.</span></code></li> +<li>[optional] run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">bdist_wheel</span></code> to generate the wheel file</li> </ol> <p>Step 4 and 5 are to install PySINGA. Details on the installation of dependent libraries and the instructions for each OS are given in the following sections.</p> @@ -316,7 +334,7 @@ Details on the installation of dependent <p>Most of the dependent libraries could be installed from source or via package mangers like apt-get, yum, and homebrew. Please refer to FAQ for problems caused by the path setting of the dependent libraries.</p> <p>The following instructions are tested on Ubuntu 14.04 and 16.04for installing dependent libraries.</p> -<div class="highlight-default"><div class="highlight"><pre><span></span># required libraries +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># required libraries $ sudo apt-get install libprotobuf-dev libopenblas-dev protobuf-compiler # optional libraries. @@ -326,8 +344,8 @@ $ sudo apt-get install python3-dev pytho $ sudo apt-get install libopencv-dev libgoogle-glog-dev liblmdb-dev </pre></div> </div> -<p>The following instructions are tested on Mac OS X Yosemite (10.11 and 10.12) for installing dependent libraries.</p> -<div class="highlight-default"><div class="highlight"><pre><span></span># required libraries +<p>The following instructions are tested on Mac OS X Yosemite (10.11 and 10.12) for installing dependent libraries. Instructions for installing on macOS 10.13 (High Sierra) can be found <a class="reference external" href="install_macos1013.html">here</a>.</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># required libraries $ brew tap homebrew/science $ brew install openblas $ brew install protobuf260 @@ -341,18 +359,18 @@ $ brew install -vd glog lmdb </div> <p>By default, openblas is installed into /usr/local/opt/openblas. To let the compiler (and cmake) know the openblas path,</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ export CMAKE_INCLUDE_PATH=/usr/local/opt/openblas/include:$CMAKE_INCLUDE_PATH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ export CMAKE_INCLUDE_PATH=/usr/local/opt/openblas/include:$CMAKE_INCLUDE_PATH $ export CMAKE_LIBRARY_PATH=/usr/local/opt/openblas/lib:$CMAKE_LIBRARY_PATH </pre></div> </div> <p>To let the runtime know the openblas path,</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ export LD_LIBRARY_PATH=/usr/local/opt/openblas/library:$LD_LIBRARY_PATH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ export LD_LIBRARY_PATH=/usr/local/opt/openblas/library:$LD_LIBRARY_PATH </pre></div> </div> <div class="section" id="compile-with-use-modules-on"> <span id="compile-with-use-modules-on"></span><h4>Compile with USE_MODULES=ON<a class="headerlink" href="#compile-with-use-modules-on" title="Permalink to this headline">¶</a></h4> <p>If protobuf and openblas are not installed, you can compile SINGA together with them</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ In SINGA ROOT folder +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ In SINGA ROOT folder $ mkdir build $ cd build $ cmake -DUSE_MODULES=ON .. @@ -362,15 +380,15 @@ $ make <p>cmake would download OpenBlas and Protobuf (2.6.1) and compile them together with SINGA.</p> <p>After compiling SINGA, you can run the unit tests by</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ ./bin/test_singa +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./bin/test_singa </pre></div> </div> <p>You can see all the testing cases with testing results. If SINGA passes all tests, then you have successfully installed SINGA.</p> -<p>You can use <code class="docutils literal"><span class="pre">ccmake</span> <span class="pre">..</span></code> to configure the compilation options. +<p>You can use <code class="docutils literal notranslate"><span class="pre">ccmake</span> <span class="pre">..</span></code> to configure the compilation options. If some dependent libraries are not in the system default paths, you need to export the following environment variables</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CMAKE_INCLUDE_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">header</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">CMAKE_INCLUDE_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">header</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span> <span class="n">export</span> <span class="n">CMAKE_LIBRARY_PATH</span><span class="o">=<</span><span class="n">path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">lib</span> <span class="n">file</span> <span class="n">folder</span><span class="o">></span> </pre></div> </div> @@ -378,7 +396,7 @@ the following environment variables</p> <div class="section" id="compile-with-use-python-on"> <span id="compile-with-use-python-on"></span><h4>Compile with USE_PYTHON=ON<a class="headerlink" href="#compile-with-use-python-on" title="Permalink to this headline">¶</a></h4> <p>swig and numpy can be install by</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ Ubuntu 14.04 and 16.04 +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ Ubuntu 14.04 and 16.04 $ sudo apt-get install python-numpy # Ubuntu 16.04 $ sudo apt-get install swig @@ -386,22 +404,22 @@ $ sudo apt-get install swig </div> <p>Note that swig has to be installed from source on Ubuntu 14.04. After installing numpy, export the header path of numpy.i as</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH </pre></div> </div> <p>Similar to compile CPP code, PySINGA is compiled by</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ cmake -DUSE_PYTHON=ON .. +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -DUSE_PYTHON=ON .. $ make $ cd python $ pip install . </pre></div> </div> <p>Developers can build the wheel file via</p> -<div class="highlight-default"><div class="highlight"><pre><span></span># under the build directory +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># under the build directory $ cd python </pre></div> </div> -<p>The generated wheel file is under “dist” directory.</p> +<p>The generated wheel file is under âdistâ directory.</p> </div> <div class="section" id="compile-singa-with-use-cuda-on"> <span id="compile-singa-with-use-cuda-on"></span><h4>Compile SINGA with USE_CUDA=ON<a class="headerlink" href="#compile-singa-with-use-cuda-on" title="Permalink to this headline">¶</a></h4> @@ -411,13 +429,13 @@ get better performance.</p> <p>SINGA has been tested over CUDA (7, 7.5, 8), and cuDNN (4 and 5). If cuDNN is decompressed into non-system folder, e.g. /home/bob/local/cudnn/, the following commands should be executed for cmake and the runtime to find it</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ export CMAKE_INCLUDE_PATH=/home/bob/local/cudnn/include:$CMAKE_INCLUDE_PATH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ export CMAKE_INCLUDE_PATH=/home/bob/local/cudnn/include:$CMAKE_INCLUDE_PATH $ export CMAKE_LIBRARY_PATH=/home/bob/local/cudnn/lib64:$CMAKE_LIBRARY_PATH $ export LD_LIBRARY_PATH=/home/bob/local/cudnn/lib64:$LD_LIBRARY_PATH </pre></div> </div> <p>The cmake options for CUDA and cuDNN should be switched on</p> -<div class="highlight-default"><div class="highlight"><pre><span></span># Dependent libs are install already +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># Dependent libs are install already $ cmake -DUSE_CUDA=ON .. </pre></div> </div> @@ -426,7 +444,7 @@ $ cmake -DUSE_CUDA=ON .. <span id="compile-singa-with-use-opencl-on"></span><h4>Compile SINGA with USE_OPENCL=ON<a class="headerlink" href="#compile-singa-with-use-opencl-on" title="Permalink to this headline">¶</a></h4> <p>SINGA uses opencl-headers and viennacl (version 1.7.1 or newer) for OpenCL support, which can be installed using via</p> -<div class="highlight-default"><div class="highlight"><pre><span></span># On Ubuntu 16.04 +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># On Ubuntu 16.04 $ sudo apt-get install opencl-headers, libviennacl-dev # On Fedora $ sudo yum install opencl-headers, viennacl @@ -436,15 +454,15 @@ $ sudo yum install opencl-headers, vienn <ul class="simple"> <li>For AMD and nVidia GPUs, the driver package should also install the correct OpenCL ICD.</li> <li>For Intel CPUs and/or GPUs, get the driver from the <a class="reference external" href="https://software.intel.com/en-us/articles/opencl-drivers";>Intel website.</a> Note that the drivers provided on that website only supports recent CPUs and Iris GPUs.</li> -<li>For older Intel CPUs, you can use the <code class="docutils literal"><span class="pre">beignet-opencl-icd</span></code> package.</li> +<li>For older Intel CPUs, you can use the <code class="docutils literal notranslate"><span class="pre">beignet-opencl-icd</span></code> package.</li> </ul> -<p>Note that running OpenCL on CPUs is not currently recommended because it is slow. Memory transfer is on the order of whole seconds (1000’s of ms on CPUs as compared to 1’s of ms on GPUs).</p> +<p>Note that running OpenCL on CPUs is not currently recommended because it is slow. Memory transfer is on the order of whole seconds (1000âs of ms on CPUs as compared to 1âs of ms on GPUs).</p> <p>More information on setting up a working OpenCL environment may be found <a class="reference external" href="https://wiki.tiker.net/OpenCLHowTo";>here</a>.</p> <p>If the package version of ViennaCL is not at least 1.7.1, you will need to build it from source:</p> -<p>Clone <a class="reference external" href="https://github.com/viennacl/viennacl-dev";>the repository from here</a>, checkout the <code class="docutils literal"><span class="pre">release-1.7.1</span></code> tag and build it. -Remember to add its directory to <code class="docutils literal"><span class="pre">PATH</span></code> and the built libraries to <code class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></code>.</p> +<p>Clone <a class="reference external" href="https://github.com/viennacl/viennacl-dev";>the repository from here</a>, checkout the <code class="docutils literal notranslate"><span class="pre">release-1.7.1</span></code> tag and build it. +Remember to add its directory to <code class="docutils literal notranslate"><span class="pre">PATH</span></code> and the built libraries to <code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code>.</p> <p>To build SINGA with OpenCL support, you need to pass the flag during cmake:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">DUSE_OPENCL</span><span class="o">=</span><span class="n">ON</span> <span class="o">..</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">DUSE_OPENCL</span><span class="o">=</span><span class="n">ON</span> <span class="o">..</span> </pre></div> </div> </div> @@ -455,7 +473,7 @@ Remember to add its directory to <code c <div class="section" id="compile-singa-with-package-on"> <span id="compile-singa-with-package-on"></span><h4>Compile SINGA with PACKAGE=ON<a class="headerlink" href="#compile-singa-with-package-on" title="Permalink to this headline">¶</a></h4> <p>This setting is used to build the Debian package. Set PACKAGE=ON and build the package with make command like this:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ cmake -DPACKAGE=ON +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -DPACKAGE=ON $ make package </pre></div> </div> @@ -466,34 +484,34 @@ $ make package <p>For the dependent library installation, please refer to <a class="reference external" href="dependencies.md">Dependencies</a>. After all the dependencies are successfully installed, just run the following commands to generate the VS solution in cmd under singa folder:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ md build && cd build +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ md build && cd build $ cmake -G "Visual Studio 14" -DUSE_CUDA=OFF -DUSE_PYTHON=OFF .. </pre></div> </div> <p>The default project generated by the command is 32-bit version. You can also specify a 64-bit version project by:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ md build && cd build +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ md build && cd build $ cmake -G "Visual Studio 14 Win64" -DUSE_CUDA=OFF -DUSE_PYTHON=OFF .. </pre></div> </div> -<p>If you get error outputs like “Could NOT find xxxxx” indicating a dependent +<p>If you get error outputs like âCould NOT find xxxxxâ indicating a dependent library missing, configure your library file and include path for cmake or the system. -For example, you get an error “Could NOT find CBLAS” and suppose you installed -openblas header files at “d:\include” and openblas library at “d:\lib”. You should run the +For example, you get an error âCould NOT find CBLASâ and suppose you installed +openblas header files at âd:\includeâ and openblas library at âd:\libâ. You should run the following command to specify your cblas parameters in cmake:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ cmake -G "Visual Studio 14" -DUSE_CUDA=OFF -DUSE_PYTHON=OFF -DCBLAS_INCLUDE_DIR="d:\include" -DCBLAS_LIBRARIES="d:\lib\libopenblas.lib" -DProtobuf_INCLUDE_DIR=<include dir of protobuf> -DProtobuf_LIBRARIES=<path to libprotobuf.lib> -DProtobuf_PROTOC_EXECUTABLE=<path to protoc.exe> -DGLOG_INCLUDE_DIR=<include dir of glog> -DGLOG_LIBRARIES=<path to libglog.lib> .. +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -G "Visual Studio 14" -DUSE_CUDA=OFF -DUSE_PYTHON=OFF -DCBLAS_INCLUDE_DIR="d:\include" -DCBLAS_LIBRARIES="d:\lib\libopenblas.lib" -DProtobuf_INCLUDE_DIR=<include dir of protobuf> -DProtobuf_LIBRARIES=<path to libprotobuf.lib> -DProtobuf_PROTOC_EXECUTABLE=<path to protoc.exe> -DGLOG_INCLUDE_DIR=<include dir of glog> -DGLOG_LIBRARIES=<path to libglog.lib> .. </pre></div> </div> <p>To find out the parameters you need to specify for some special libraries, you can run the following command:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ cmake -LAH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cmake -LAH </pre></div> </div> <p>If you use cmake GUI tool in windows, make sure you configure the right -parameters for the singa solution by select “Advanced” box. After generating the VS project, -open the “singa.sln” project file under -the “build” folder and compile it as a normal VS solution. You will find the -unit tests file named “test_singa” in the project binary folder. +parameters for the singa solution by select âAdvancedâ box. After generating the VS project, +open the âsinga.slnâ project file under +the âbuildâ folder and compile it as a normal VS solution. You will find the +unit tests file named âtest_singaâ in the project binary folder. If you get errors when running test_singa.exe due to libglog.dll/libopenblas.dll missing, just copy the dll files into the same folder as test_singa.exe</p> </div> @@ -501,21 +519,21 @@ just copy the dll files into the same fo <div class="section" id="faq"> <span id="faq"></span><h2>FAQ<a class="headerlink" href="#faq" title="Permalink to this headline">¶</a></h2> <ul> -<li><p class="first">Q: Error from ‘import singa’ using PySINGA installed from wheel.</p> -<p>A: Please check the detailed error from <code class="docutils literal"><span class="pre">python</span> <span class="pre">-c</span> <span class="pre">"from</span> <span class="pre">singa</span> <span class="pre">import</span> <span class="pre">_singa_wrap"</span></code>. Sometimes it is +<li><p class="first">Q: Error from âimport singaâ using PySINGA installed from wheel.</p> +<p>A: Please check the detailed error from <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-c</span> <span class="pre">"from</span> <span class="pre">singa</span> <span class="pre">import</span> <span class="pre">_singa_wrap"</span></code>. Sometimes it is caused by the dependent libraries, e.g. there are multiple versions of protobuf, missing of cudnn, numpy version mismatch. Following steps show the solutions for different cases</p> <ol> <li><p class="first">Check the cudnn and cuda and gcc versions, cudnn5 and cuda7.5 and gcc4.8/4.9 are preferred. if gcc is 5.0, then downgrade it. If cudnn is missing or not match with the wheel version, you can download the correct version of cudnn into ~/local/cudnn/ and</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ echo "export LD_LIBRARY_PATH=/home/<yourname>/local/cudnn/lib64:$LD_LIBRARY_PATH" >> ~/.bashrc +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ echo "export LD_LIBRARY_PATH=/home/<yourname>/local/cudnn/lib64:$LD_LIBRARY_PATH" >> ~/.bashrc </pre></div> </div> </li> <li><p class="first">If it is the problem related to protobuf, then download the newest whl files which have <a class="reference external" href="https://issues.apache.org/jira/browse/SINGA-255";>compiled protobuf and openblas into the whl</a> file of PySINGA. Or you can install protobuf from source into a local folder, say ~/local/; Decompress the tar file, and then</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ ./configure --prefix=/home/<yourname>local +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ ./configure --prefix=/home/<yourname>local $ make && make install $ echo "export LD_LIBRARY_PATH=/home/<yourname>/local/lib:$LD_LIBRARY_PATH" >> ~/.bashrc $ source ~/.bashrc @@ -524,15 +542,15 @@ Decompress the tar file, and then</p> </li> <li><p class="first">If it cannot find other libs including python, then create virtual env using pip or conda;</p> </li> -<li><p class="first">If it is not caused by the above reasons, go to the folder of <code class="docutils literal"><span class="pre">_singa_wrap.so</span></code>,</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ python +<li><p class="first">If it is not caused by the above reasons, go to the folder of <code class="docutils literal notranslate"><span class="pre">_singa_wrap.so</span></code>,</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ python >> import importlib >> importlib.import_module('_singa_wrap') </pre></div> </div> </li> </ol> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Check</span> <span class="n">the</span> <span class="n">error</span> <span class="n">message</span><span class="o">.</span> <span class="n">For</span> <span class="n">example</span><span class="p">,</span> <span class="k">if</span> <span class="n">the</span> <span class="n">numpy</span> <span class="n">version</span> <span class="n">mismatches</span><span class="p">,</span> <span class="n">the</span> <span class="n">error</span> <span class="n">message</span> <span class="n">would</span> <span class="n">be</span><span class="p">,</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Check</span> <span class="n">the</span> <span class="n">error</span> <span class="n">message</span><span class="o">.</span> <span class="n">For</span> <span class="n">example</span><span class="p">,</span> <span class="k">if</span> <span class="n">the</span> <span class="n">numpy</span> <span class="n">version</span> <span class="n">mismatches</span><span class="p">,</span> <span class="n">the</span> <span class="n">error</span> <span class="n">message</span> <span class="n">would</span> <span class="n">be</span><span class="p">,</span> <span class="ne">RuntimeError</span><span class="p">:</span> <span class="n">module</span> <span class="n">compiled</span> <span class="n">against</span> <span class="n">API</span> <span class="n">version</span> <span class="mh">0xb</span> <span class="n">but</span> <span class="n">this</span> <span class="n">version</span> <span class="n">of</span> <span class="n">numpy</span> <span class="ow">is</span> <span class="mh">0xa</span> @@ -542,47 +560,47 @@ Decompress the tar file, and then</p> </li> </ul> <ul> -<li><p class="first">Q: Error from running <code class="docutils literal"><span class="pre">cmake</span> <span class="pre">..</span></code>, which cannot find the dependent libraries.</p> -<p>A: If you haven’t installed the libraries, install them. If you installed +<li><p class="first">Q: Error from running <code class="docutils literal notranslate"><span class="pre">cmake</span> <span class="pre">..</span></code>, which cannot find the dependent libraries.</p> +<p>A: If you havenât installed the libraries, install them. If you installed the libraries in a folder that is outside of the system folder, e.g. /usr/local, you need to export the following variables</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ export CMAKE_INCLUDE_PATH=<path to your header file folder> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CMAKE_INCLUDE_PATH=<path to your header file folder> $ export CMAKE_LIBRARY_PATH=<path to your lib file folder> </pre></div> </div> </li> </ul> <ul> -<li><p class="first">Q: Error from <code class="docutils literal"><span class="pre">make</span></code>, e.g. the linking phase</p> +<li><p class="first">Q: Error from <code class="docutils literal notranslate"><span class="pre">make</span></code>, e.g. the linking phase</p> <p>A: If your libraries are in other folders than system default paths, you need to export the following varaibles</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ export LIBRARY_PATH=<path to your lib file folder> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export LIBRARY_PATH=<path to your lib file folder> $ export LD_LIBRARY_PATH=<path to your lib file folder> </pre></div> </div> </li> </ul> <ul> -<li><p class="first">Q: Error from header files, e.g. ‘cblas.h no such file or directory exists’</p> +<li><p class="first">Q: Error from header files, e.g. âcblas.h no such file or directory existsâ</p> <p>A: You need to include the folder of the cblas.h into CPLUS_INCLUDE_PATH, e.g.,</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=/opt/OpenBLAS/include:$CPLUS_INCLUDE_PATH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=/opt/OpenBLAS/include:$CPLUS_INCLUDE_PATH </pre></div> </div> </li> -<li><p class="first">Q:While compiling SINGA, I get error <code class="docutils literal"><span class="pre">SSE2</span> <span class="pre">instruction</span> <span class="pre">set</span> <span class="pre">not</span> <span class="pre">enabled</span></code></p> +<li><p class="first">Q:While compiling SINGA, I get error <code class="docutils literal notranslate"><span class="pre">SSE2</span> <span class="pre">instruction</span> <span class="pre">set</span> <span class="pre">not</span> <span class="pre">enabled</span></code></p> <p>A:You can try following command:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ make CFLAGS='-msse2' CXXFLAGS='-msse2' +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ make CFLAGS='-msse2' CXXFLAGS='-msse2' </pre></div> </div> </li> -<li><p class="first">Q:I get <code class="docutils literal"><span class="pre">ImportError:</span> <span class="pre">cannot</span> <span class="pre">import</span> <span class="pre">name</span> <span class="pre">enum_type_wrapper</span></code> from google.protobuf.internal when I try to import .py files.</p> +<li><p class="first">Q:I get <code class="docutils literal notranslate"><span class="pre">ImportError:</span> <span class="pre">cannot</span> <span class="pre">import</span> <span class="pre">name</span> <span class="pre">enum_type_wrapper</span></code> from google.protobuf.internal when I try to import .py files.</p> <p>A: You need to install the python binding of protobuf, which could be installed via</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ sudo apt-get install protobuf +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ sudo apt-get install protobuf </pre></div> </div> <p>or from source</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ cd /PROTOBUF/SOURCE/FOLDER +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ cd /PROTOBUF/SOURCE/FOLDER $ cd python $ python setup.py build $ python setup.py install @@ -591,11 +609,11 @@ e.g.,</p> </li> <li><p class="first">Q: When I build OpenBLAS from source, I am told that I need a Fortran compiler.</p> <p>A: You can compile OpenBLAS by</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ make ONLY_CBLAS=1 +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ make ONLY_CBLAS=1 </pre></div> </div> <p>or install it using</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ sudo apt-get install libopenblas-dev +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ sudo apt-get install libopenblas-dev </pre></div> </div> </li> @@ -608,41 +626,41 @@ must be told how to find the newer libst The simplest way to fix this is to find the correct libstdc++ and export it to LD_LIBRARY_PATH. For example, if GLIBC++_3.4.20 is listed in the output of the following command,</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ strings /usr/local/lib64/libstdc++.so.6|grep GLIBC++ +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ strings /usr/local/lib64/libstdc++.so.6|grep GLIBC++ </pre></div> </div> <p>then you just set your environment variable as</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ export LD_LIBRARY_PATH=/usr/local/lib64:$LD_LIBRARY_PATH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export LD_LIBRARY_PATH=/usr/local/lib64:$LD_LIBRARY_PATH </pre></div> </div> </li> -<li><p class="first">Q: When I build glog, it reports that “src/logging_unittest.cc:83:20: error: âgflagsâ is not a namespace-name”</p> -<p>A: It maybe that you have installed gflags with a different namespace such as “google”. so glog can’t find ‘gflags’ namespace. +<li><p class="first">Q: When I build glog, it reports that âsrc/logging_unittest.cc:83:20: error: âgflagsâ is not a namespace-nameâ</p> +<p>A: It maybe that you have installed gflags with a different namespace such as âgoogleâ. so glog canât find âgflagsâ namespace. Because it is not necessary to have gflags to build glog. So you can change the configure.ac file to ignore gflags.</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="mf">1.</span> <span class="n">cd</span> <span class="n">to</span> <span class="n">glog</span> <span class="n">src</span> <span class="n">directory</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="mf">1.</span> <span class="n">cd</span> <span class="n">to</span> <span class="n">glog</span> <span class="n">src</span> <span class="n">directory</span> <span class="mf">2.</span> <span class="n">change</span> <span class="n">line</span> <span class="mi">125</span> <span class="n">of</span> <span class="n">configure</span><span class="o">.</span><span class="n">ac</span> <span class="n">to</span> <span class="s2">"AC_CHECK_LIB(gflags, main, ac_cv_have_libgflags=0, ac_cv_have_libgflags=0)"</span> <span class="mf">3.</span> <span class="n">autoreconf</span> </pre></div> </div> <p>After this, you can build glog again.</p> </li> -<li><p class="first">Q: When using virtual environment, everytime I run pip install, it would reinstall numpy. However, the numpy would not be used when I <code class="docutils literal"><span class="pre">import</span> <span class="pre">numpy</span></code></p> -<p>A: It could be caused by the <code class="docutils literal"><span class="pre">PYTHONPATH</span></code> which should be set to empty when you are using virtual environment to avoid the conflicts with the path of +<li><p class="first">Q: When using virtual environment, everytime I run pip install, it would reinstall numpy. However, the numpy would not be used when I <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">numpy</span></code></p> +<p>A: It could be caused by the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> which should be set to empty when you are using virtual environment to avoid the conflicts with the path of the virtual environment.</p> </li> <li><p class="first">Q: When compiling PySINGA from source, there is a compilation error due to the missing of <numpy/objectarray.h></p> <p>A: Please install numpy and export the path of numpy header files as</p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ export CPLUS_INCLUDE_PATH=`python -c "import numpy; print numpy.get_include()"`:$CPLUS_INCLUDE_PATH </pre></div> </div> </li> -<li><p class="first">Q: When I run PySINGA in Mac OS X, I got the error “Fatal Python error: PyThreadState_Get: no current thread Abort trap: 6”</p> +<li><p class="first">Q: When I run PySINGA in Mac OS X, I got the error âFatal Python error: PyThreadState_Get: no current thread Abort trap: 6â</p> <p>A: This error happens typically when you have multiple version of Python on your system and you installed SINGA via pip (this problem is resolved for installation via conda), e.g, the one comes with the OS and the one installed by Homebrew. The Python linked by PySINGA must be the same as the Python interpreter. -You can check your interpreter by <code class="docutils literal"><span class="pre">which</span> <span class="pre">python</span></code> and check the Python linked by PySINGA via <code class="docutils literal"><span class="pre">otool</span> <span class="pre">-L</span> <span class="pre"><path</span> <span class="pre">to</span> <span class="pre">_singa_wrap.so></span></code>. +You can check your interpreter by <code class="docutils literal notranslate"><span class="pre">which</span> <span class="pre">python</span></code> and check the Python linked by PySINGA via <code class="docutils literal notranslate"><span class="pre">otool</span> <span class="pre">-L</span> <span class="pre"><path</span> <span class="pre">to</span> <span class="pre">_singa_wrap.so></span></code>. To fix this error, compile SINGA with the correct version of Python. In particular, if you build PySINGA from source, you need to specify the paths when invoking <a class="reference external" href="http://stackoverflow.com/questions/15291500/i-have-2-versions-of-python-installed-but-cmake-is-using-older-version-how-do";>cmake</a></p> -<div class="highlight-default"><div class="highlight"><pre><span></span> $ cmake -DPYTHON_LIBRARY=`python-config --prefix`/lib/libpython2.7.dylib -DPYTHON_INCLUDE_DIR=`python-config --prefix`/include/python2.7/ .. +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> $ cmake -DPYTHON_LIBRARY=`python-config --prefix`/lib/libpython2.7.dylib -DPYTHON_INCLUDE_DIR=`python-config --prefix`/include/python2.7/ .. </pre></div> </div> <p>If installed PySINGA from binary packages, e.g. debian or wheel, then you need to change the python interpreter, e.g., reset the $PATH to put the correct path of Python at the front position.</p> @@ -653,15 +671,16 @@ In particular, if you build PySINGA from </div> + </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="software_stack.html" class="btn btn-neutral float-right" title="Software Stack" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="software_stack.html" class="btn btn-neutral float-right" title="Software Stack" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="index.html" class="btn btn-neutral" title="Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="index.html" class="btn btn-neutral" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -670,11 +689,11 @@ In particular, if you build PySINGA from <div role="contentinfo"> <p> - © Copyright 2017 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. + © Copyright 2018 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. </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>. + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. </footer> @@ -693,9 +712,11 @@ In particular, if you build PySINGA from var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'1.1.0', + LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> @@ -709,14 +730,13 @@ In particular, if you build PySINGA from <script type="text/javascript" src="../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); + + SphinxRtdTheme.Navigation.enableSticky(); + }); </script> - <div class="rst-versions shift-up" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version">
