draugr.torch_utilities.system.device.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
  6. <title>draugr.torch_utilities.system.device &#8212; Draugr 1.0.1 documentation</title>
  7. <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  8. <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
  9. <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
  10. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  11. <script src="../_static/jquery.js"></script>
  12. <script src="../_static/underscore.js"></script>
  13. <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
  14. <script src="../_static/doctools.js"></script>
  15. <link rel="canonical" href="pything.github.io/draugr/generated/draugr.torch_utilities.system.device.html" />
  16. <link rel="index" title="Index" href="../genindex.html" />
  17. <link rel="search" title="Search" href="../search.html" />
  18. <link rel="next" title="draugr.torch_utilities.system.device.global_torch_device" href="draugr.torch_utilities.system.device.global_torch_device.html" />
  19. <link rel="prev" title="draugr.torch_utilities.system.data_type.set_global_torch_dtype" href="draugr.torch_utilities.system.data_type.set_global_torch_dtype.html" />
  20. <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  21. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  22. </head><body>
  23. <div class="document">
  24. <div class="documentwrapper">
  25. <div class="bodywrapper">
  26. <div class="body" role="main">
  27. <section id="module-draugr.torch_utilities.system.device">
  28. <span id="draugr-torch-utilities-system-device"></span><h1>draugr.torch_utilities.system.device<a class="headerlink" href="#module-draugr.torch_utilities.system.device" title="Permalink to this heading">¶</a></h1>
  29. <p>Created on 15/11/2019</p>
  30. <p class="rubric">Functions</p>
  31. <table class="autosummary longtable docutils align-default">
  32. <colgroup>
  33. <col style="width: 10%" />
  34. <col style="width: 90%" />
  35. </colgroup>
  36. <tbody>
  37. <tr class="row-odd"><td><p><a class="reference internal" href="draugr.torch_utilities.system.device.global_torch_device.html#draugr.torch_utilities.system.device.global_torch_device" title="draugr.torch_utilities.system.device.global_torch_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">global_torch_device</span></code></a>([device_preference, ...])</p></td>
  38. <td><p>first time call stores to device for global reference, later call must explicitly manually override!</p></td>
  39. </tr>
  40. <tr class="row-even"><td><p><a class="reference internal" href="draugr.torch_utilities.system.device.select_cuda_device.html#draugr.torch_utilities.system.device.select_cuda_device" title="draugr.torch_utilities.system.device.select_cuda_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">select_cuda_device</span></code></a>(cuda_device_idx)</p></td>
  41. <td><p><dl class="field-list simple">
  42. <dt class="field-odd">param cuda_device_idx</dt>
  43. <dd class="field-odd"><p></p></dd>
  44. </dl>
  45. </p></td>
  46. </tr>
  47. <tr class="row-odd"><td><p><a class="reference internal" href="draugr.torch_utilities.system.device.get_gpu_usage_mb.html#draugr.torch_utilities.system.device.get_gpu_usage_mb" title="draugr.torch_utilities.system.device.get_gpu_usage_mb"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_gpu_usage_mb</span></code></a>()</p></td>
  48. <td><p><dl class="field-list simple">
  49. <dt class="field-odd">return</dt>
  50. <dd class="field-odd"><p></p></dd>
  51. </dl>
  52. </p></td>
  53. </tr>
  54. <tr class="row-even"><td><p><a class="reference internal" href="draugr.torch_utilities.system.device.auto_select_available_cuda_device.html#draugr.torch_utilities.system.device.auto_select_available_cuda_device" title="draugr.torch_utilities.system.device.auto_select_available_cuda_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">auto_select_available_cuda_device</span></code></a>([...])</p></td>
  55. <td><p>Auto selects the device with highest compute capability and with the requested memory available</p></td>
  56. </tr>
  57. <tr class="row-odd"><td><p><a class="reference internal" href="draugr.torch_utilities.system.device.set_global_torch_device.html#draugr.torch_utilities.system.device.set_global_torch_device" title="draugr.torch_utilities.system.device.set_global_torch_device"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_global_torch_device</span></code></a>(device)</p></td>
  58. <td><p><dl class="field-list simple">
  59. <dt class="field-odd">param device</dt>
  60. <dd class="field-odd"><p></p></dd>
  61. </dl>
  62. </p></td>
  63. </tr>
  64. <tr class="row-even"><td><p><a class="reference internal" href="draugr.torch_utilities.system.device.torch_clean_up.html#draugr.torch_utilities.system.device.torch_clean_up" title="draugr.torch_utilities.system.device.torch_clean_up"><code class="xref py py-obj docutils literal notranslate"><span class="pre">torch_clean_up</span></code></a>()</p></td>
  65. <td><p><strong>Destroy cuda state by emptying cache and collecting IPC.</strong></p></td>
  66. </tr>
  67. </tbody>
  68. </table>
  69. <p class="rubric">Classes</p>
  70. <table class="autosummary longtable docutils align-default">
  71. <colgroup>
  72. <col style="width: 10%" />
  73. <col style="width: 90%" />
  74. </colgroup>
  75. <tbody>
  76. <tr class="row-odd"><td><p><a class="reference internal" href="draugr.torch_utilities.system.device.TorchDeviceEnum.html#draugr.torch_utilities.system.device.TorchDeviceEnum" title="draugr.torch_utilities.system.device.TorchDeviceEnum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TorchDeviceEnum</span></code></a>(value)</p></td>
  77. <td><p>An enumeration.</p></td>
  78. </tr>
  79. </tbody>
  80. </table>
  81. </section>
  82. </div>
  83. </div>
  84. </div>
  85. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  86. <div class="sphinxsidebarwrapper">
  87. <p class="logo"><a href="../index.html">
  88. <img class="logo" src="../_static/valknut.svg" alt="Logo"/>
  89. </a></p>
  90. <h1 class="logo"><a href="../index.html">Draugr</a></h1>
  91. <h3>Navigation</h3>
  92. <ul class="current">
  93. <li class="toctree-l1 current"><a class="reference internal" href="draugr.html">draugr</a><ul class="current">
  94. <li class="toctree-l2"><a class="reference internal" href="draugr.dist_is_editable.html">draugr.dist_is_editable</a></li>
  95. <li class="toctree-l2"><a class="reference internal" href="draugr.get_version.html">draugr.get_version</a></li>
  96. <li class="toctree-l2"><a class="reference internal" href="draugr.dlib_utilities.html">draugr.dlib_utilities</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="draugr.drawers.html">draugr.drawers</a></li>
  98. <li class="toctree-l2"><a class="reference internal" href="draugr.entry_points.html">draugr.entry_points</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="draugr.extensions.html">draugr.extensions</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="draugr.ffmpeg_utilities.html">draugr.ffmpeg_utilities</a></li>
  101. <li class="toctree-l2"><a class="reference internal" href="draugr.jax_utilities.html">draugr.jax_utilities</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="draugr.metrics.html">draugr.metrics</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="draugr.multiprocessing_utilities.html">draugr.multiprocessing_utilities</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="draugr.numpy_utilities.html">draugr.numpy_utilities</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="draugr.opencv_utilities.html">draugr.opencv_utilities</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="draugr.os_utilities.html">draugr.os_utilities</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="draugr.pandas_utilities.html">draugr.pandas_utilities</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="draugr.pygame_utilities.html">draugr.pygame_utilities</a></li>
  109. <li class="toctree-l2"><a class="reference internal" href="draugr.python_utilities.html">draugr.python_utilities</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="draugr.random_utilities.html">draugr.random_utilities</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="draugr.scipy_utilities.html">draugr.scipy_utilities</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="draugr.stopping.html">draugr.stopping</a></li>
  113. <li class="toctree-l2"><a class="reference internal" href="draugr.tensorboard_utilities.html">draugr.tensorboard_utilities</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="draugr.threading_utilities.html">draugr.threading_utilities</a></li>
  115. <li class="toctree-l2 current"><a class="reference internal" href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul class="current">
  116. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.architectures.html">draugr.torch_utilities.architectures</a></li>
  117. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.datasets.html">draugr.torch_utilities.datasets</a></li>
  118. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.distributions.html">draugr.torch_utilities.distributions</a></li>
  119. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.evaluation.html">draugr.torch_utilities.evaluation</a></li>
  120. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.exporting.html">draugr.torch_utilities.exporting</a></li>
  121. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.generators.html">draugr.torch_utilities.generators</a></li>
  122. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.images.html">draugr.torch_utilities.images</a></li>
  123. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.opencv.html">draugr.torch_utilities.opencv</a></li>
  124. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.operations.html">draugr.torch_utilities.operations</a></li>
  125. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.optimisation.html">draugr.torch_utilities.optimisation</a></li>
  126. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.persistence.html">draugr.torch_utilities.persistence</a></li>
  127. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.sessions.html">draugr.torch_utilities.sessions</a></li>
  128. <li class="toctree-l3 current"><a class="reference internal" href="draugr.torch_utilities.system.html">draugr.torch_utilities.system</a><ul class="current">
  129. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.system.constants.html">draugr.torch_utilities.system.constants</a></li>
  130. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.system.data_type.html">draugr.torch_utilities.system.data_type</a></li>
  131. <li class="toctree-l4 current"><a class="current reference internal" href="#">draugr.torch_utilities.system.device</a><ul>
  132. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.system.device.global_torch_device.html">draugr.torch_utilities.system.device.global_torch_device</a></li>
  133. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.system.device.select_cuda_device.html">draugr.torch_utilities.system.device.select_cuda_device</a></li>
  134. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.system.device.get_gpu_usage_mb.html">draugr.torch_utilities.system.device.get_gpu_usage_mb</a></li>
  135. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.system.device.auto_select_available_cuda_device.html">draugr.torch_utilities.system.device.auto_select_available_cuda_device</a></li>
  136. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.system.device.set_global_torch_device.html">draugr.torch_utilities.system.device.set_global_torch_device</a></li>
  137. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.system.device.torch_clean_up.html">draugr.torch_utilities.system.device.torch_clean_up</a></li>
  138. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.system.device.TorchDeviceEnum.html">draugr.torch_utilities.system.device.TorchDeviceEnum</a></li>
  139. </ul>
  140. </li>
  141. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.system.info.html">draugr.torch_utilities.system.info</a></li>
  142. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.system.loading.html">draugr.torch_utilities.system.loading</a></li>
  143. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.system.seeding.html">draugr.torch_utilities.system.seeding</a></li>
  144. </ul>
  145. </li>
  146. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.tensors.html">draugr.torch_utilities.tensors</a></li>
  147. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.writers.html">draugr.torch_utilities.writers</a></li>
  148. </ul>
  149. </li>
  150. <li class="toctree-l2"><a class="reference internal" href="draugr.tqdm_utilities.html">draugr.tqdm_utilities</a></li>
  151. <li class="toctree-l2"><a class="reference internal" href="draugr.visualisation.html">draugr.visualisation</a></li>
  152. <li class="toctree-l2"><a class="reference internal" href="draugr.writers.html">draugr.writers</a></li>
  153. </ul>
  154. </li>
  155. </ul>
  156. <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
  157. <ul>
  158. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
  159. </ul>
  160. <div class="relations">
  161. <h3>Related Topics</h3>
  162. <ul>
  163. <li><a href="../index.html">Documentation overview</a><ul>
  164. <li><a href="draugr.html">draugr</a><ul>
  165. <li><a href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul>
  166. <li><a href="draugr.torch_utilities.system.html">draugr.torch_utilities.system</a><ul>
  167. <li>Previous: <a href="draugr.torch_utilities.system.data_type.set_global_torch_dtype.html" title="previous chapter">draugr.torch_utilities.system.data_type.set_global_torch_dtype</a></li>
  168. <li>Next: <a href="draugr.torch_utilities.system.device.global_torch_device.html" title="next chapter">draugr.torch_utilities.system.device.global_torch_device</a></li>
  169. </ul></li>
  170. </ul></li>
  171. </ul></li>
  172. </ul></li>
  173. </ul>
  174. </div>
  175. <div id="searchbox" style="display: none" role="search">
  176. <h3 id="searchlabel">Quick search</h3>
  177. <div class="searchformwrapper">
  178. <form class="search" action="../search.html" method="get">
  179. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  180. <input type="submit" value="Go" />
  181. </form>
  182. </div>
  183. </div>
  184. <script>document.getElementById('searchbox').style.display = "block"</script>
  185. </div>
  186. </div>
  187. <div class="clearer"></div>
  188. </div>
  189. <div class="footer">
  190. &copy;.
  191. |
  192. Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
  193. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
  194. |
  195. <a href="../_sources/generated/draugr.torch_utilities.system.device.rst.txt"
  196. rel="nofollow">Page source</a>
  197. </div>
  198. </body>
  199. </html>