| |
| |
| |
| <!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>Device — incubator-singa 1.1.0 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <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="Tensor" href="tensor.html"/> |
| <link rel="prev" title="Software Stack" href="software_stack.html"/> |
| <link href="../_static/style.css" rel="stylesheet" type="text/css"> |
| |
| |
| |
| <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.html" class="icon icon-home"> incubator-singa |
| |
| |
| |
| |
| <img src="../_static/singa.png" class="logo" /> |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| latest |
| </div> |
| |
| |
| |
| |
| <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 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"><a class="reference internal" href="installation.html">Installation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="software_stack.html">Software Stack</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="">Device</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#specific-devices">Specific devices</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#module-singa.device">Python API</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#cpp-api">CPP API</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="tensor.html">Tensor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="layer.html">Layer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="net.html">FeedForward Net</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="initializer.html">Initializer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="loss.html">Loss</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="metric.html">Metric</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="optimizer.html">Optimizer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="data.html">Data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="image_tool.html">Image Tool</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="snapshot.html">Snapshot</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="converter.html">Caffe Converter</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="model_zoo/index.html">Model Zoo</a></li> |
| </ul> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Development</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../develop/schedule.html">Development Schedule</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../develop/how-contribute.html">How to Contribute to SINGA</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../develop/contribute-code.html">How to Contribute Code</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../develop/contribute-docs.html">How to Contribute to Documentation</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Community</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../community/source-repository.html">Source Repository</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../community/mail-lists.html">Project Mailing Lists</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../community/issue-tracking.html">Issue Tracking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../community/team-list.html">The SINGA Team</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.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">Documentation</a> »</li> |
| |
| <li>Device</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="device"> |
| <h1>Device<a class="headerlink" href="#device" title="Permalink to this headline">¶</a></h1> |
| <p>The Device abstract represents any hardware device with memory and compuation units. |
| All [Tensor operations](tensor.html) are scheduled by the resident device for execution. |
| Tensor memory is also managed by the device’s memory manager. Therefore, optimization |
| of memory and execution are implemented in the Device class.</p> |
| <div class="section" id="specific-devices"> |
| <h2>Specific devices<a class="headerlink" href="#specific-devices" title="Permalink to this headline">¶</a></h2> |
| <p>Currently, SINGA has three Device implmentations,</p> |
| <ol class="arabic simple"> |
| <li>CudaGPU for an Nvidia GPU card which runs Cuda code</li> |
| <li>CppCPU for a CPU which runs Cpp code</li> |
| <li>OpenclGPU for a GPU card which runs OpenCL code</li> |
| </ol> |
| </div> |
| <div class="section" id="module-singa.device"> |
| <span id="python-api"></span><h2>Python API<a class="headerlink" href="#module-singa.device" title="Permalink to this headline">¶</a></h2> |
| <p>This script includes Device class and its subclasses for python users |
| to call singa::Device and its methods.</p> |
| <p>TODO(wangwei) implement py CudaGPU class.</p> |
| <dl class="function"> |
| <dt id="singa.device.create_cuda_gpus"> |
| <code class="descclassname">singa.device.</code><code class="descname">create_cuda_gpus</code><span class="sig-paren">(</span><em>num</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.device.create_cuda_gpus" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Create a list of CudaGPU devices.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>num</strong> (<em>int</em>) – number of device to create.</td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of swig converted CudaGPU devices.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="singa.device.create_cuda_gpus_on"> |
| <code class="descclassname">singa.device.</code><code class="descname">create_cuda_gpus_on</code><span class="sig-paren">(</span><em>device_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.device.create_cuda_gpus_on" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Create a list of CudaGPU devices.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>device_ids</strong> (<em>list</em>) – a list of GPU card IDs.</td> |
| </tr> |
| <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of swig converted CudaGPU devices.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="singa.device.get_default_device"> |
| <code class="descclassname">singa.device.</code><code class="descname">get_default_device</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.device.get_default_device" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get the default host device which is a CppCPU device</p> |
| </dd></dl> |
| |
| <p>The following code provides examples of creating devices:</p> |
| <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">singa</span> <span class="kn">import</span> <span class="n">device</span> |
| <span class="n">cuda</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">create_cuda_gpu_on</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># use GPU card of ID 0</span> |
| <span class="n">host</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">get_default_device</span><span class="p">()</span> <span class="c1"># get the default host device (a CppCPU)</span> |
| <span class="n">ary1</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">create_cuda_gpus</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># create 2 devices, starting from ID 0</span> |
| <span class="n">ary2</span> <span class="o">=</span> <span class="n">device</span><span class="o">.</span><span class="n">create_cuda_gpus</span><span class="p">([</span><span class="mi">0</span><span class="p">,</span><span class="mi">2</span><span class="p">])</span> <span class="c1"># create 2 devices on ID 0 and 2</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="cpp-api"> |
| <h2>CPP API<a class="headerlink" href="#cpp-api" title="Permalink to this headline">¶</a></h2> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="tensor.html" class="btn btn-neutral float-right" title="Tensor" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="software_stack.html" class="btn btn-neutral" title="Software Stack" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <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.. |
| |
| </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:'1.1.0', |
| 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="../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </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"> |
| <span class="fa fa-book"> incubator-singa </span> |
| v: latest |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Languages</dt> |
| <dd><a href="../../en/index.html">English</a></dd> |
| <dd><a href="../../zh/index.html">中文</a></dd> |
| </dl> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="http://singa.apache.org/v0.3.0/">0.3</a></dd> |
| <dd><a href="http://singa.apache.org/v1.1.0/">1.1</a></dd> |
| </dl> |
| |
| </div> |
| <a href="http://incubator.apache.org/"> <img src= "../_static/apache.jpg"> </a> |
| </div> |
| |
| <a href="https://github.com/apache/incubator-singa"> |
| <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;" |
| src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" |
| alt="Fork me on GitHub"> |
| </a> |
| |
| |
| |
| |
| </body> |
| </html> |
