Página inicial Explorar Ajuda
Entrar
cnheider
/
draugr
mirror de https://github.com/cnheider/draugr
Observar 1
Favorito 1
Fork 0
Arquivos Issues 0 Wiki
Branch: master
Branches Tags
draugr
/
docs
/
github
/
html
/
generated
/
draugr.torch_utilities.architectures.architecture.Architecture.html

draugr.torch_utilities.architectures.architecture.Architecture.html 162 KB
Link permanente Histórico Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475 
  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. <html lang="en">
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8" />
    7. 

  7.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
    8. 

  8. 

  9.     <title>draugr.torch_utilities.architectures.architecture.Architecture &#8212; Draugr 1.0.1 documentation</title>
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    11. 

  11.     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
    13. 

  13.     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    14. 

  14.     <script src="../_static/jquery.js"></script>
    15. 

  15.     <script src="../_static/underscore.js"></script>
    16. 

  16.     <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
    17. 

  17.     <script src="../_static/doctools.js"></script>
    18. 

  18.     <link rel="canonical" href="pything.github.io/draugr/generated/draugr.torch_utilities.architectures.architecture.Architecture.html" />
    19. 

  19.     <link rel="index" title="Index" href="../genindex.html" />
    20. 

  20.     <link rel="search" title="Search" href="../search.html" />
    21. 

  21.     <link rel="next" title="draugr.torch_utilities.architectures.distributional" href="draugr.torch_utilities.architectures.distributional.html" />
    22. 

  22.     <link rel="prev" title="draugr.torch_utilities.architectures.architecture" href="draugr.torch_utilities.architectures.architecture.html" />
    23. 

  23.    
    24. 

  24.   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
    25. 

  25.   
    26. 

  26.   
    27. 

  27.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    28. 

  28. 

  29.   </head><body>
    30. 

  30.   
    31. 

  31. 

  32.     <div class="document">
    33. 

  33.       <div class="documentwrapper">
    34. 

  34.         <div class="bodywrapper">
    35. 

  35.           
    36. 

  36. 

  37.           <div class="body" role="main">
    38. 

  38.             
    39. 

  39.   <section id="draugr-torch-utilities-architectures-architecture-architecture">
    40. 

  40. <h1>draugr.torch_utilities.architectures.architecture.Architecture<a class="headerlink" href="#draugr-torch-utilities-architectures-architecture-architecture" title="Permalink to this heading">¶</a></h1>
    41. 

  41. <dl class="py class">
    42. 

  42. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture">
    43. 

  43. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">draugr.torch_utilities.architectures.architecture.</span></span><span class="sig-name descname"><span class="pre">Architecture</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/torch_utilities/architectures/architecture.html#Architecture"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture" title="Permalink to this definition">¶</a></dt>
    44. 

  44. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code>, <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p>
    45. 

  45. <p>description</p>
    46. 

  46. <dl class="py method">
    47. 

  47. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.__init__">
    48. 

  48. <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">input_shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/torch_utilities/architectures/architecture.html#Architecture.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.__init__" title="Permalink to this definition">¶</a></dt>
    49. 

  49. <dd><p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p>
    50. 

  50. </dd></dl>
    51. 

  51. 

  52. <p class="rubric">Methods</p>
    53. 

  53. <table class="autosummary longtable docutils align-default">
    54. 

  54. <colgroup>
    55. 

  55. <col style="width: 10%" />
    56. 

  56. <col style="width: 90%" />
    57. 

  57. </colgroup>
    58. 

  58. <tbody>
    59. 

  59. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.__init__" title="draugr.torch_utilities.architectures.architecture.Architecture.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(input_shape, output_shape)</p></td>
    60. 

  60. <td><p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></td>
    61. 

  61. </tr>
    62. 

  62. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.add_module" title="draugr.torch_utilities.architectures.architecture.Architecture.add_module"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_module</span></code></a>(name, module)</p></td>
    63. 

  63. <td><p>Adds a child module to the current module.</p></td>
    64. 

  64. </tr>
    65. 

  65. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.apply" title="draugr.torch_utilities.architectures.architecture.Architecture.apply"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply</span></code></a>(fn)</p></td>
    66. 

  66. <td><p>Applies <code class="docutils literal notranslate"><span class="pre">fn</span></code> recursively to every submodule (as returned by <code class="docutils literal notranslate"><span class="pre">.children()</span></code>) as well as self.</p></td>
    67. 

  67. </tr>
    68. 

  68. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.bfloat16" title="draugr.torch_utilities.architectures.architecture.Architecture.bfloat16"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bfloat16</span></code></a>()</p></td>
    69. 

  69. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">bfloat16</span></code> datatype.</p></td>
    70. 

  70. </tr>
    71. 

  71. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.buffers" title="draugr.torch_utilities.architectures.architecture.Architecture.buffers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">buffers</span></code></a>([recurse])</p></td>
    72. 

  72. <td><p>Returns an iterator over module buffers.</p></td>
    73. 

  73. </tr>
    74. 

  74. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.children" title="draugr.torch_utilities.architectures.architecture.Architecture.children"><code class="xref py py-obj docutils literal notranslate"><span class="pre">children</span></code></a>()</p></td>
    75. 

  75. <td><p>Returns an iterator over immediate children modules.</p></td>
    76. 

  76. </tr>
    77. 

  77. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.cpu" title="draugr.torch_utilities.architectures.architecture.Architecture.cpu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cpu</span></code></a>()</p></td>
    78. 

  78. <td><p>Moves all model parameters and buffers to the CPU.</p></td>
    79. 

  79. </tr>
    80. 

  80. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.cuda" title="draugr.torch_utilities.architectures.architecture.Architecture.cuda"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cuda</span></code></a>([device])</p></td>
    81. 

  81. <td><p>Moves all model parameters and buffers to the GPU.</p></td>
    82. 

  82. </tr>
    83. 

  83. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.double" title="draugr.torch_utilities.architectures.architecture.Architecture.double"><code class="xref py py-obj docutils literal notranslate"><span class="pre">double</span></code></a>()</p></td>
    84. 

  84. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">double</span></code> datatype.</p></td>
    85. 

  85. </tr>
    86. 

  86. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.eval" title="draugr.torch_utilities.architectures.architecture.Architecture.eval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">eval</span></code></a>()</p></td>
    87. 

  87. <td><p>Sets the module in evaluation mode.</p></td>
    88. 

  88. </tr>
    89. 

  89. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.extra_repr" title="draugr.torch_utilities.architectures.architecture.Architecture.extra_repr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extra_repr</span></code></a>()</p></td>
    90. 

  90. <td><p>Set the extra representation of the module</p></td>
    91. 

  91. </tr>
    92. 

  92. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.float" title="draugr.torch_utilities.architectures.architecture.Architecture.float"><code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></a>()</p></td>
    93. 

  93. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">float</span></code> datatype.</p></td>
    94. 

  94. </tr>
    95. 

  95. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.forward" title="draugr.torch_utilities.architectures.architecture.Architecture.forward"><code class="xref py py-obj docutils literal notranslate"><span class="pre">forward</span></code></a>(*input)</p></td>
    96. 

  96. <td><p>Defines the computation performed at every call.</p></td>
    97. 

  97. </tr>
    98. 

  98. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_buffer" title="draugr.torch_utilities.architectures.architecture.Architecture.get_buffer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_buffer</span></code></a>(target)</p></td>
    99. 

  99. <td><p>Returns the buffer given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists, otherwise throws an error.</p></td>
    100. 

  100. </tr>
    101. 

  101. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_extra_state" title="draugr.torch_utilities.architectures.architecture.Architecture.get_extra_state"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_extra_state</span></code></a>()</p></td>
    102. 

  102. <td><p>Returns any extra state to include in the module's state_dict.</p></td>
    103. 

  103. </tr>
    104. 

  104. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_parameter" title="draugr.torch_utilities.architectures.architecture.Architecture.get_parameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_parameter</span></code></a>(target)</p></td>
    105. 

  105. <td><p>Returns the parameter given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists, otherwise throws an error.</p></td>
    106. 

  106. </tr>
    107. 

  107. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_submodule" title="draugr.torch_utilities.architectures.architecture.Architecture.get_submodule"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_submodule</span></code></a>(target)</p></td>
    108. 

  108. <td><p>Returns the submodule given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists, otherwise throws an error.</p></td>
    109. 

  109. </tr>
    110. 

  110. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.half" title="draugr.torch_utilities.architectures.architecture.Architecture.half"><code class="xref py py-obj docutils literal notranslate"><span class="pre">half</span></code></a>()</p></td>
    111. 

  111. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">half</span></code> datatype.</p></td>
    112. 

  112. </tr>
    113. 

  113. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.ipu" title="draugr.torch_utilities.architectures.architecture.Architecture.ipu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipu</span></code></a>([device])</p></td>
    114. 

  114. <td><p>Moves all model parameters and buffers to the IPU.</p></td>
    115. 

  115. </tr>
    116. 

  116. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_state_dict</span></code></a>(state_dict[, strict])</p></td>
    117. 

  117. <td><p>Copies parameters and buffers from <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a> into this module and its descendants.</p></td>
    118. 

  118. </tr>
    119. 

  119. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.modules" title="draugr.torch_utilities.architectures.architecture.Architecture.modules"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modules</span></code></a>()</p></td>
    120. 

  120. <td><p>Returns an iterator over all modules in the network.</p></td>
    121. 

  121. </tr>
    122. 

  122. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_buffers" title="draugr.torch_utilities.architectures.architecture.Architecture.named_buffers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">named_buffers</span></code></a>([prefix, recurse])</p></td>
    123. 

  123. <td><p>Returns an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.</p></td>
    124. 

  124. </tr>
    125. 

  125. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_children" title="draugr.torch_utilities.architectures.architecture.Architecture.named_children"><code class="xref py py-obj docutils literal notranslate"><span class="pre">named_children</span></code></a>()</p></td>
    126. 

  126. <td><p>Returns an iterator over immediate children modules, yielding both the name of the module as well as the module itself.</p></td>
    127. 

  127. </tr>
    128. 

  128. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_modules" title="draugr.torch_utilities.architectures.architecture.Architecture.named_modules"><code class="xref py py-obj docutils literal notranslate"><span class="pre">named_modules</span></code></a>([memo, prefix, remove_duplicate])</p></td>
    129. 

  129. <td><p>Returns an iterator over all modules in the network, yielding both the name of the module as well as the module itself.</p></td>
    130. 

  130. </tr>
    131. 

  131. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_parameters" title="draugr.torch_utilities.architectures.architecture.Architecture.named_parameters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">named_parameters</span></code></a>([prefix, recurse])</p></td>
    132. 

  132. <td><p>Returns an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.</p></td>
    133. 

  133. </tr>
    134. 

  134. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.parameters" title="draugr.torch_utilities.architectures.architecture.Architecture.parameters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parameters</span></code></a>([recurse])</p></td>
    135. 

  135. <td><p>Returns an iterator over module parameters.</p></td>
    136. 

  136. </tr>
    137. 

  137. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_backward_hook" title="draugr.torch_utilities.architectures.architecture.Architecture.register_backward_hook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_backward_hook</span></code></a>(hook)</p></td>
    138. 

  138. <td><p>Registers a backward hook on the module.</p></td>
    139. 

  139. </tr>
    140. 

  140. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_buffer" title="draugr.torch_utilities.architectures.architecture.Architecture.register_buffer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_buffer</span></code></a>(name, tensor[, persistent])</p></td>
    141. 

  141. <td><p>Adds a buffer to the module.</p></td>
    142. 

  142. </tr>
    143. 

  143. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_forward_hook" title="draugr.torch_utilities.architectures.architecture.Architecture.register_forward_hook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_forward_hook</span></code></a>(hook)</p></td>
    144. 

  144. <td><p>Registers a forward hook on the module.</p></td>
    145. 

  145. </tr>
    146. 

  146. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_forward_pre_hook" title="draugr.torch_utilities.architectures.architecture.Architecture.register_forward_pre_hook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_forward_pre_hook</span></code></a>(hook)</p></td>
    147. 

  147. <td><p>Registers a forward pre-hook on the module.</p></td>
    148. 

  148. </tr>
    149. 

  149. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_full_backward_hook" title="draugr.torch_utilities.architectures.architecture.Architecture.register_full_backward_hook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_full_backward_hook</span></code></a>(hook)</p></td>
    150. 

  150. <td><p>Registers a backward hook on the module.</p></td>
    151. 

  151. </tr>
    152. 

  152. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_load_state_dict_post_hook" title="draugr.torch_utilities.architectures.architecture.Architecture.register_load_state_dict_post_hook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_load_state_dict_post_hook</span></code></a>(hook)</p></td>
    153. 

  153. <td><p>Registers a post hook to be run after module's <code class="docutils literal notranslate"><span class="pre">load_state_dict</span></code> is called.</p></td>
    154. 

  154. </tr>
    155. 

  155. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_module" title="draugr.torch_utilities.architectures.architecture.Architecture.register_module"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_module</span></code></a>(name, module)</p></td>
    156. 

  156. <td><p>Alias for <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.add_module" title="draugr.torch_utilities.architectures.architecture.Architecture.add_module"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_module()</span></code></a>.</p></td>
    157. 

  157. </tr>
    158. 

  158. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_parameter" title="draugr.torch_utilities.architectures.architecture.Architecture.register_parameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_parameter</span></code></a>(name, param)</p></td>
    159. 

  159. <td><p>Adds a parameter to the module.</p></td>
    160. 

  160. </tr>
    161. 

  161. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.requires_grad_" title="draugr.torch_utilities.architectures.architecture.Architecture.requires_grad_"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requires_grad_</span></code></a>([requires_grad])</p></td>
    162. 

  162. <td><p>Change if autograd should record operations on parameters in this module.</p></td>
    163. 

  163. </tr>
    164. 

  164. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.sample_input" title="draugr.torch_utilities.architectures.architecture.Architecture.sample_input"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sample_input</span></code></a>()</p></td>
    165. 

  165. <td><p><dl class="field-list simple">
    166. 

  166. <dt class="field-odd">return</dt>
    167. 

  167. <dd class="field-odd"><p></p></dd>
    168. 

  168. </dl>
    169. 

  169. </p></td>
    170. 

  170. </tr>
    171. 

  171. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.set_extra_state" title="draugr.torch_utilities.architectures.architecture.Architecture.set_extra_state"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_extra_state</span></code></a>(state)</p></td>
    172. 

  172. <td><p>This function is called from <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_state_dict()</span></code></a> to handle any extra state found within the <cite>state_dict</cite>.</p></td>
    173. 

  173. </tr>
    174. 

  174. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.share_memory" title="draugr.torch_utilities.architectures.architecture.Architecture.share_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">share_memory</span></code></a>()</p></td>
    175. 

  175. <td><p>See <code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.Tensor.share_memory_()</span></code></p></td>
    176. 

  176. </tr>
    177. 

  177. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">state_dict</span></code></a>(*args[, destination, prefix, ...])</p></td>
    178. 

  178. <td><p>Returns a dictionary containing a whole state of the module.</p></td>
    179. 

  179. </tr>
    180. 

  180. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.to" title="draugr.torch_utilities.architectures.architecture.Architecture.to"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to</span></code></a>(*args, **kwargs)</p></td>
    181. 

  181. <td><p>Moves and/or casts the parameters and buffers.</p></td>
    182. 

  182. </tr>
    183. 

  183. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.to_empty" title="draugr.torch_utilities.architectures.architecture.Architecture.to_empty"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_empty</span></code></a>(*, device)</p></td>
    184. 

  184. <td><p>Moves the parameters and buffers to the specified device without copying storage.</p></td>
    185. 

  185. </tr>
    186. 

  186. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.train" title="draugr.torch_utilities.architectures.architecture.Architecture.train"><code class="xref py py-obj docutils literal notranslate"><span class="pre">train</span></code></a>([mode])</p></td>
    187. 

  187. <td><p>Sets the module in training mode.</p></td>
    188. 

  188. </tr>
    189. 

  189. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.type" title="draugr.torch_utilities.architectures.architecture.Architecture.type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span></code></a>(dst_type)</p></td>
    190. 

  190. <td><p>Casts all parameters and buffers to <code class="xref py py-attr docutils literal notranslate"><span class="pre">dst_type</span></code>.</p></td>
    191. 

  191. </tr>
    192. 

  192. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.xpu" title="draugr.torch_utilities.architectures.architecture.Architecture.xpu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">xpu</span></code></a>([device])</p></td>
    193. 

  193. <td><p>Moves all model parameters and buffers to the XPU.</p></td>
    194. 

  194. </tr>
    195. 

  195. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.zero_grad" title="draugr.torch_utilities.architectures.architecture.Architecture.zero_grad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">zero_grad</span></code></a>([set_to_none])</p></td>
    196. 

  196. <td><p>Sets gradients of all model parameters to zero.</p></td>
    197. 

  197. </tr>
    198. 

  198. </tbody>
    199. 

  199. </table>
    200. 

  200. <p class="rubric">Attributes</p>
    201. 

  201. <table class="autosummary longtable docutils align-default">
    202. 

  202. <colgroup>
    203. 

  203. <col style="width: 10%" />
    204. 

  204. <col style="width: 90%" />
    205. 

  205. </colgroup>
    206. 

  206. <tbody>
    207. 

  207. <tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">T_destination</span></code></p></td>
    208. 

  208. <td><p>alias of TypeVar('T_destination', bound=<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Any</span></code></a>])</p></td>
    209. 

  209. </tr>
    210. 

  210. <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dump_patches</span></code></p></td>
    211. 

  211. <td><p></p></td>
    212. 

  212. </tr>
    213. 

  213. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.input_shape" title="draugr.torch_utilities.architectures.architecture.Architecture.input_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">input_shape</span></code></a></p></td>
    214. 

  214. <td><p>return: :rtype:</p></td>
    215. 

  215. </tr>
    216. 

  216. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.output_shape" title="draugr.torch_utilities.architectures.architecture.Architecture.output_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">output_shape</span></code></a></p></td>
    217. 

  217. <td><p>return: :rtype:</p></td>
    218. 

  218. </tr>
    219. 

  219. </tbody>
    220. 

  220. </table>
    221. 

  221. <dl class="py method">
    222. 

  222. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.add_module">
    223. 

  223. <span class="sig-name descname"><span class="pre">add_module</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.add_module" title="Permalink to this definition">¶</a></dt>
    224. 

  224. <dd><p>Adds a child module to the current module.</p>
    225. 

  225. <p>The module can be accessed as an attribute using the given name.</p>
    226. 

  226. <dl class="field-list simple">
    227. 

  227. <dt class="field-odd">Parameters</dt>
    228. 

  228. <dd class="field-odd"><ul class="simple">
    229. 

  229. <li><p><strong>name</strong> (<em>string</em>) – name of the child module. The child module can be
    230. 

  230. accessed from this module using the given name</p></li>
    231. 

  231. <li><p><strong>module</strong> (<em>Module</em>) – child module to be added to the module.</p></li>
    232. 

  232. </ul>
    233. 

  233. </dd>
    234. 

  234. </dl>
    235. 

  235. </dd></dl>
    236. 

  236. 

  237. <dl class="py method">
    238. 

  238. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.apply">
    239. 

  239. <span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.apply" title="Permalink to this definition">¶</a></dt>
    240. 

  240. <dd><p>Applies <code class="docutils literal notranslate"><span class="pre">fn</span></code> recursively to every submodule (as returned by <code class="docutils literal notranslate"><span class="pre">.children()</span></code>)
    241. 

  241. as well as self. Typical use includes initializing the parameters of a model
    242. 

  242. (see also <span class="xref std std-ref">nn-init-doc</span>).</p>
    243. 

  243. <dl class="field-list simple">
    244. 

  244. <dt class="field-odd">Parameters</dt>
    245. 

  245. <dd class="field-odd"><p><strong>fn</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> -&gt; None) – function to be applied to each submodule</p>
    246. 

  246. </dd>
    247. 

  247. <dt class="field-even">Returns</dt>
    248. 

  248. <dd class="field-even"><p>self</p>
    249. 

  249. </dd>
    250. 

  250. <dt class="field-odd">Return type</dt>
    251. 

  251. <dd class="field-odd"><p>Module</p>
    252. 

  252. </dd>
    253. 

  253. </dl>
    254. 

  254. <p>Example:</p>
    255. 

  255. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nd">@torch</span><span class="o">.</span><span class="n">no_grad</span><span class="p">()</span>
    256. 

  256. <span class="gp">&gt;&gt;&gt; </span><span class="k">def</span> <span class="nf">init_weights</span><span class="p">(</span><span class="n">m</span><span class="p">):</span>
    257. 

  257. <span class="gp">&gt;&gt;&gt; </span>    <span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>
    258. 

  258. <span class="gp">&gt;&gt;&gt; </span>    <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">m</span><span class="p">)</span> <span class="o">==</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">:</span>
    259. 

  259. <span class="gp">&gt;&gt;&gt; </span>        <span class="n">m</span><span class="o">.</span><span class="n">weight</span><span class="o">.</span><span class="n">fill_</span><span class="p">(</span><span class="mf">1.0</span><span class="p">)</span>
    260. 

  260. <span class="gp">&gt;&gt;&gt; </span>        <span class="nb">print</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">weight</span><span class="p">)</span>
    261. 

  261. <span class="gp">&gt;&gt;&gt; </span><span class="n">net</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Sequential</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">))</span>
    262. 

  262. <span class="gp">&gt;&gt;&gt; </span><span class="n">net</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">init_weights</span><span class="p">)</span>
    263. 

  263. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
    264. 

  264. <span class="go">Parameter containing:</span>
    265. 

  265. <span class="go">tensor([[ 1.,  1.],</span>
    266. 

  266. <span class="go">        [ 1.,  1.]])</span>
    267. 

  267. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
    268. 

  268. <span class="go">Parameter containing:</span>
    269. 

  269. <span class="go">tensor([[ 1.,  1.],</span>
    270. 

  270. <span class="go">        [ 1.,  1.]])</span>
    271. 

  271. <span class="go">Sequential(</span>
    272. 

  272. <span class="go">  (0): Linear(in_features=2, out_features=2, bias=True)</span>
    273. 

  273. <span class="go">  (1): Linear(in_features=2, out_features=2, bias=True)</span>
    274. 

  274. <span class="go">)</span>
    275. 

  275. <span class="go">Sequential(</span>
    276. 

  276. <span class="go">  (0): Linear(in_features=2, out_features=2, bias=True)</span>
    277. 

  277. <span class="go">  (1): Linear(in_features=2, out_features=2, bias=True)</span>
    278. 

  278. <span class="go">)</span>
    279. 

  279. </pre></div>
    280. 

  280. </div>
    281. 

  281. </dd></dl>
    282. 

  282. 

  283. <dl class="py method">
    284. 

  284. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.bfloat16">
    285. 

  285. <span class="sig-name descname"><span class="pre">bfloat16</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.bfloat16" title="Permalink to this definition">¶</a></dt>
    286. 

  286. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">bfloat16</span></code> datatype.</p>
    287. 

  287. <div class="admonition note">
    288. 

  288. <p class="admonition-title">Note</p>
    289. 

  289. <p>This method modifies the module in-place.</p>
    290. 

  290. </div>
    291. 

  291. <dl class="field-list simple">
    292. 

  292. <dt class="field-odd">Returns</dt>
    293. 

  293. <dd class="field-odd"><p>self</p>
    294. 

  294. </dd>
    295. 

  295. <dt class="field-even">Return type</dt>
    296. 

  296. <dd class="field-even"><p>Module</p>
    297. 

  297. </dd>
    298. 

  298. </dl>
    299. 

  299. </dd></dl>
    300. 

  300. 

  301. <dl class="py method">
    302. 

  302. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.buffers">
    303. 

  303. <span class="sig-name descname"><span class="pre">buffers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recurse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.10)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.buffers" title="Permalink to this definition">¶</a></dt>
    304. 

  304. <dd><p>Returns an iterator over module buffers.</p>
    305. 

  305. <dl class="field-list simple">
    306. 

  306. <dt class="field-odd">Parameters</dt>
    307. 

  307. <dd class="field-odd"><p><strong>recurse</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – if True, then yields buffers of this module
    308. 

  308. and all submodules. Otherwise, yields only buffers that
    309. 

  309. are direct members of this module.</p>
    310. 

  310. </dd>
    311. 

  311. <dt class="field-even">Yields</dt>
    312. 

  312. <dd class="field-even"><p><em>torch.Tensor</em> – module buffer</p>
    313. 

  313. </dd>
    314. 

  314. </dl>
    315. 

  315. <p>Example:</p>
    316. 

  316. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">buf</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">buffers</span><span class="p">():</span>
    317. 

  317. <span class="gp">&gt;&gt;&gt; </span>    <span class="nb">print</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">buf</span><span class="p">),</span> <span class="n">buf</span><span class="o">.</span><span class="n">size</span><span class="p">())</span>
    318. 

  318. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L,)</span>
    319. 

  319. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L, 1L, 5L, 5L)</span>
    320. 

  320. </pre></div>
    321. 

  321. </div>
    322. 

  322. </dd></dl>
    323. 

  323. 

  324. <dl class="py method">
    325. 

  325. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.children">
    326. 

  326. <span class="sig-name descname"><span class="pre">children</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.10)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.children" title="Permalink to this definition">¶</a></dt>
    327. 

  327. <dd><p>Returns an iterator over immediate children modules.</p>
    328. 

  328. <dl class="field-list simple">
    329. 

  329. <dt class="field-odd">Yields</dt>
    330. 

  330. <dd class="field-odd"><p><em>Module</em> – a child module</p>
    331. 

  331. </dd>
    332. 

  332. </dl>
    333. 

  333. </dd></dl>
    334. 

  334. 

  335. <dl class="py method">
    336. 

  336. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.cpu">
    337. 

  337. <span class="sig-name descname"><span class="pre">cpu</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.cpu" title="Permalink to this definition">¶</a></dt>
    338. 

  338. <dd><p>Moves all model parameters and buffers to the CPU.</p>
    339. 

  339. <div class="admonition note">
    340. 

  340. <p class="admonition-title">Note</p>
    341. 

  341. <p>This method modifies the module in-place.</p>
    342. 

  342. </div>
    343. 

  343. <dl class="field-list simple">
    344. 

  344. <dt class="field-odd">Returns</dt>
    345. 

  345. <dd class="field-odd"><p>self</p>
    346. 

  346. </dd>
    347. 

  347. <dt class="field-even">Return type</dt>
    348. 

  348. <dd class="field-even"><p>Module</p>
    349. 

  349. </dd>
    350. 

  350. </dl>
    351. 

  351. </dd></dl>
    352. 

  352. 

  353. <dl class="py method">
    354. 

  354. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.cuda">
    355. 

  355. <span class="sig-name descname"><span class="pre">cuda</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">device</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.cuda" title="Permalink to this definition">¶</a></dt>
    356. 

  356. <dd><p>Moves all model parameters and buffers to the GPU.</p>
    357. 

  357. <p>This also makes associated parameters and buffers different objects. So
    358. 

  358. it should be called before constructing optimizer if the module will
    359. 

  359. live on GPU while being optimized.</p>
    360. 

  360. <div class="admonition note">
    361. 

  361. <p class="admonition-title">Note</p>
    362. 

  362. <p>This method modifies the module in-place.</p>
    363. 

  363. </div>
    364. 

  364. <dl class="field-list simple">
    365. 

  365. <dt class="field-odd">Parameters</dt>
    366. 

  366. <dd class="field-odd"><p><strong>device</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a><em>, </em><em>optional</em>) – if specified, all parameters will be
    367. 

  367. copied to that device</p>
    368. 

  368. </dd>
    369. 

  369. <dt class="field-even">Returns</dt>
    370. 

  370. <dd class="field-even"><p>self</p>
    371. 

  371. </dd>
    372. 

  372. <dt class="field-odd">Return type</dt>
    373. 

  373. <dd class="field-odd"><p>Module</p>
    374. 

  374. </dd>
    375. 

  375. </dl>
    376. 

  376. </dd></dl>
    377. 

  377. 

  378. <dl class="py method">
    379. 

  379. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.double">
    380. 

  380. <span class="sig-name descname"><span class="pre">double</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.double" title="Permalink to this definition">¶</a></dt>
    381. 

  381. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">double</span></code> datatype.</p>
    382. 

  382. <div class="admonition note">
    383. 

  383. <p class="admonition-title">Note</p>
    384. 

  384. <p>This method modifies the module in-place.</p>
    385. 

  385. </div>
    386. 

  386. <dl class="field-list simple">
    387. 

  387. <dt class="field-odd">Returns</dt>
    388. 

  388. <dd class="field-odd"><p>self</p>
    389. 

  389. </dd>
    390. 

  390. <dt class="field-even">Return type</dt>
    391. 

  391. <dd class="field-even"><p>Module</p>
    392. 

  392. </dd>
    393. 

  393. </dl>
    394. 

  394. </dd></dl>
    395. 

  395. 

  396. <dl class="py method">
    397. 

  397. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.eval">
    398. 

  398. <span class="sig-name descname"><span class="pre">eval</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.eval" title="Permalink to this definition">¶</a></dt>
    399. 

  399. <dd><p>Sets the module in evaluation mode.</p>
    400. 

  400. <p>This has any effect only on certain modules. See documentations of
    401. 

  401. particular modules for details of their behaviors in training/evaluation
    402. 

  402. mode, if they are affected, e.g. <code class="xref py py-class docutils literal notranslate"><span class="pre">Dropout</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">BatchNorm</span></code>,
    403. 

  403. etc.</p>
    404. 

  404. <p>This is equivalent with <code class="xref py py-meth docutils literal notranslate"><span class="pre">self.train(False)</span></code>.</p>
    405. 

  405. <p>See <span class="xref std std-ref">locally-disable-grad-doc</span> for a comparison between
    406. 

  406. <cite>.eval()</cite> and several similar mechanisms that may be confused with it.</p>
    407. 

  407. <dl class="field-list simple">
    408. 

  408. <dt class="field-odd">Returns</dt>
    409. 

  409. <dd class="field-odd"><p>self</p>
    410. 

  410. </dd>
    411. 

  411. <dt class="field-even">Return type</dt>
    412. 

  412. <dd class="field-even"><p>Module</p>
    413. 

  413. </dd>
    414. 

  414. </dl>
    415. 

  415. </dd></dl>
    416. 

  416. 

  417. <dl class="py method">
    418. 

  418. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.extra_repr">
    419. 

  419. <span class="sig-name descname"><span class="pre">extra_repr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.extra_repr" title="Permalink to this definition">¶</a></dt>
    420. 

  420. <dd><p>Set the extra representation of the module</p>
    421. 

  421. <p>To print customized extra information, you should re-implement
    422. 

  422. this method in your own modules. Both single-line and multi-line
    423. 

  423. strings are acceptable.</p>
    424. 

  424. </dd></dl>
    425. 

  425. 

  426. <dl class="py method">
    427. 

  427. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.float">
    428. 

  428. <span class="sig-name descname"><span class="pre">float</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.float" title="Permalink to this definition">¶</a></dt>
    429. 

  429. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">float</span></code> datatype.</p>
    430. 

  430. <div class="admonition note">
    431. 

  431. <p class="admonition-title">Note</p>
    432. 

  432. <p>This method modifies the module in-place.</p>
    433. 

  433. </div>
    434. 

  434. <dl class="field-list simple">
    435. 

  435. <dt class="field-odd">Returns</dt>
    436. 

  436. <dd class="field-odd"><p>self</p>
    437. 

  437. </dd>
    438. 

  438. <dt class="field-even">Return type</dt>
    439. 

  439. <dd class="field-even"><p>Module</p>
    440. 

  440. </dd>
    441. 

  441. </dl>
    442. 

  442. </dd></dl>
    443. 

  443. 

  444. <dl class="py method">
    445. 

  445. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.forward">
    446. 

  446. <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">input</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.10)"><span class="pre">Any</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.forward" title="Permalink to this definition">¶</a></dt>
    447. 

  447. <dd><p>Defines the computation performed at every call.</p>
    448. 

  448. <p>Should be overridden by all subclasses.</p>
    449. 

  449. <div class="admonition note">
    450. 

  450. <p class="admonition-title">Note</p>
    451. 

  451. <p>Although the recipe for forward pass needs to be defined within
    452. 

  452. this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
    453. 

  453. instead of this since the former takes care of running the
    454. 

  454. registered hooks while the latter silently ignores them.</p>
    455. 

  455. </div>
    456. 

  456. </dd></dl>
    457. 

  457. 

  458. <dl class="py method">
    459. 

  459. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.get_buffer">
    460. 

  460. <span class="sig-name descname"><span class="pre">get_buffer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tensor</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_buffer" title="Permalink to this definition">¶</a></dt>
    461. 

  461. <dd><p>Returns the buffer given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists,
    462. 

  462. otherwise throws an error.</p>
    463. 

  463. <p>See the docstring for <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for a more detailed
    464. 

  464. explanation of this method’s functionality as well as how to
    465. 

  465. correctly specify <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
    466. 

  466. <dl class="field-list simple">
    467. 

  467. <dt class="field-odd">Parameters</dt>
    468. 

  468. <dd class="field-odd"><p><strong>target</strong> – The fully-qualified string name of the buffer
    469. 

  469. to look for. (See <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for how to specify a
    470. 

  470. fully-qualified string.)</p>
    471. 

  471. </dd>
    472. 

  472. <dt class="field-even">Returns</dt>
    473. 

  473. <dd class="field-even"><p>The buffer referenced by <code class="docutils literal notranslate"><span class="pre">target</span></code></p>
    474. 

  474. </dd>
    475. 

  475. <dt class="field-odd">Return type</dt>
    476. 

  476. <dd class="field-odd"><p>torch.Tensor</p>
    477. 

  477. </dd>
    478. 

  478. <dt class="field-even">Raises</dt>
    479. 

  479. <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.10)"><strong>AttributeError</strong></a> – If the target string references an invalid
    480. 

  480.     path or resolves to something that is not a
    481. 

  481.     buffer</p>
    482. 

  482. </dd>
    483. 

  483. </dl>
    484. 

  484. </dd></dl>
    485. 

  485. 

  486. <dl class="py method">
    487. 

  487. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.get_extra_state">
    488. 

  488. <span class="sig-name descname"><span class="pre">get_extra_state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.10)"><span class="pre">Any</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_extra_state" title="Permalink to this definition">¶</a></dt>
    489. 

  489. <dd><p>Returns any extra state to include in the module’s state_dict.
    490. 

  490. Implement this and a corresponding <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.set_extra_state" title="draugr.torch_utilities.architectures.architecture.Architecture.set_extra_state"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_extra_state()</span></code></a> for your module
    491. 

  491. if you need to store extra state. This function is called when building the
    492. 

  492. module’s <cite>state_dict()</cite>.</p>
    493. 

  493. <p>Note that extra state should be pickleable to ensure working serialization
    494. 

  494. of the state_dict. We only provide provide backwards compatibility guarantees
    495. 

  495. for serializing Tensors; other objects may break backwards compatibility if
    496. 

  496. their serialized pickled form changes.</p>
    497. 

  497. <dl class="field-list simple">
    498. 

  498. <dt class="field-odd">Returns</dt>
    499. 

  499. <dd class="field-odd"><p>Any extra state to store in the module’s state_dict</p>
    500. 

  500. </dd>
    501. 

  501. <dt class="field-even">Return type</dt>
    502. 

  502. <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)">object</a></p>
    503. 

  503. </dd>
    504. 

  504. </dl>
    505. 

  505. </dd></dl>
    506. 

  506. 

  507. <dl class="py method">
    508. 

  508. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.get_parameter">
    509. 

  509. <span class="sig-name descname"><span class="pre">get_parameter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Parameter</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_parameter" title="Permalink to this definition">¶</a></dt>
    510. 

  510. <dd><p>Returns the parameter given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists,
    511. 

  511. otherwise throws an error.</p>
    512. 

  512. <p>See the docstring for <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for a more detailed
    513. 

  513. explanation of this method’s functionality as well as how to
    514. 

  514. correctly specify <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
    515. 

  515. <dl class="field-list simple">
    516. 

  516. <dt class="field-odd">Parameters</dt>
    517. 

  517. <dd class="field-odd"><p><strong>target</strong> – The fully-qualified string name of the Parameter
    518. 

  518. to look for. (See <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for how to specify a
    519. 

  519. fully-qualified string.)</p>
    520. 

  520. </dd>
    521. 

  521. <dt class="field-even">Returns</dt>
    522. 

  522. <dd class="field-even"><p>The Parameter referenced by <code class="docutils literal notranslate"><span class="pre">target</span></code></p>
    523. 

  523. </dd>
    524. 

  524. <dt class="field-odd">Return type</dt>
    525. 

  525. <dd class="field-odd"><p>torch.nn.Parameter</p>
    526. 

  526. </dd>
    527. 

  527. <dt class="field-even">Raises</dt>
    528. 

  528. <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.10)"><strong>AttributeError</strong></a> – If the target string references an invalid
    529. 

  529.     path or resolves to something that is not an
    530. 

  530.     <code class="docutils literal notranslate"><span class="pre">nn.Parameter</span></code></p>
    531. 

  531. </dd>
    532. 

  532. </dl>
    533. 

  533. </dd></dl>
    534. 

  534. 

  535. <dl class="py method">
    536. 

  536. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.get_submodule">
    537. 

  537. <span class="sig-name descname"><span class="pre">get_submodule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Module</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_submodule" title="Permalink to this definition">¶</a></dt>
    538. 

  538. <dd><p>Returns the submodule given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists,
    539. 

  539. otherwise throws an error.</p>
    540. 

  540. <p>For example, let’s say you have an <code class="docutils literal notranslate"><span class="pre">nn.Module</span></code> <code class="docutils literal notranslate"><span class="pre">A</span></code> that
    541. 

  541. looks like this:</p>
    542. 

  542. <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>A(
    543. 

  543.     (net_b): Module(
    544. 

  544.         (net_c): Module(
    545. 

  545.             (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
    546. 

  546.         )
    547. 

  547.         (linear): Linear(in_features=100, out_features=200, bias=True)
    548. 

  548.     )
    549. 

  549. )
    550. 

  550. </pre></div>
    551. 

  551. </div>
    552. 

  552. <p>(The diagram shows an <code class="docutils literal notranslate"><span class="pre">nn.Module</span></code> <code class="docutils literal notranslate"><span class="pre">A</span></code>. <code class="docutils literal notranslate"><span class="pre">A</span></code> has a nested
    553. 

  553. submodule <code class="docutils literal notranslate"><span class="pre">net_b</span></code>, which itself has two submodules <code class="docutils literal notranslate"><span class="pre">net_c</span></code>
    554. 

  554. and <code class="docutils literal notranslate"><span class="pre">linear</span></code>. <code class="docutils literal notranslate"><span class="pre">net_c</span></code> then has a submodule <code class="docutils literal notranslate"><span class="pre">conv</span></code>.)</p>
    555. 

  555. <p>To check whether or not we have the <code class="docutils literal notranslate"><span class="pre">linear</span></code> submodule, we
    556. 

  556. would call <code class="docutils literal notranslate"><span class="pre">get_submodule(&quot;net_b.linear&quot;)</span></code>. To check whether
    557. 

  557. we have the <code class="docutils literal notranslate"><span class="pre">conv</span></code> submodule, we would call
    558. 

  558. <code class="docutils literal notranslate"><span class="pre">get_submodule(&quot;net_b.net_c.conv&quot;)</span></code>.</p>
    559. 

  559. <p>The runtime of <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> is bounded by the degree
    560. 

  560. of module nesting in <code class="docutils literal notranslate"><span class="pre">target</span></code>. A query against
    561. 

  561. <code class="docutils literal notranslate"><span class="pre">named_modules</span></code> achieves the same result, but it is O(N) in
    562. 

  562. the number of transitive modules. So, for a simple check to see
    563. 

  563. if some submodule exists, <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> should always be
    564. 

  564. used.</p>
    565. 

  565. <dl class="field-list simple">
    566. 

  566. <dt class="field-odd">Parameters</dt>
    567. 

  567. <dd class="field-odd"><p><strong>target</strong> – The fully-qualified string name of the submodule
    568. 

  568. to look for. (See above example for how to specify a
    569. 

  569. fully-qualified string.)</p>
    570. 

  570. </dd>
    571. 

  571. <dt class="field-even">Returns</dt>
    572. 

  572. <dd class="field-even"><p>The submodule referenced by <code class="docutils literal notranslate"><span class="pre">target</span></code></p>
    573. 

  573. </dd>
    574. 

  574. <dt class="field-odd">Return type</dt>
    575. 

  575. <dd class="field-odd"><p>torch.nn.Module</p>
    576. 

  576. </dd>
    577. 

  577. <dt class="field-even">Raises</dt>
    578. 

  578. <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#AttributeError" title="(in Python v3.10)"><strong>AttributeError</strong></a> – If the target string references an invalid
    579. 

  579.     path or resolves to something that is not an
    580. 

  580.     <code class="docutils literal notranslate"><span class="pre">nn.Module</span></code></p>
    581. 

  581. </dd>
    582. 

  582. </dl>
    583. 

  583. </dd></dl>
    584. 

  584. 

  585. <dl class="py method">
    586. 

  586. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.half">
    587. 

  587. <span class="sig-name descname"><span class="pre">half</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.half" title="Permalink to this definition">¶</a></dt>
    588. 

  588. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">half</span></code> datatype.</p>
    589. 

  589. <div class="admonition note">
    590. 

  590. <p class="admonition-title">Note</p>
    591. 

  591. <p>This method modifies the module in-place.</p>
    592. 

  592. </div>
    593. 

  593. <dl class="field-list simple">
    594. 

  594. <dt class="field-odd">Returns</dt>
    595. 

  595. <dd class="field-odd"><p>self</p>
    596. 

  596. </dd>
    597. 

  597. <dt class="field-even">Return type</dt>
    598. 

  598. <dd class="field-even"><p>Module</p>
    599. 

  599. </dd>
    600. 

  600. </dl>
    601. 

  601. </dd></dl>
    602. 

  602. 

  603. <dl class="py property">
    604. 

  604. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.input_shape">
    605. 

  605. <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">input_shape</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.input_shape" title="Permalink to this definition">¶</a></dt>
    606. 

  606. <dd><p>return:
    607. 

  607. :rtype:</p>
    608. 

  608. </dd></dl>
    609. 

  609. 

  610. <dl class="py method">
    611. 

  611. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.ipu">
    612. 

  612. <span class="sig-name descname"><span class="pre">ipu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">device</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.ipu" title="Permalink to this definition">¶</a></dt>
    613. 

  613. <dd><p>Moves all model parameters and buffers to the IPU.</p>
    614. 

  614. <p>This also makes associated parameters and buffers different objects. So
    615. 

  615. it should be called before constructing optimizer if the module will
    616. 

  616. live on IPU while being optimized.</p>
    617. 

  617. <div class="admonition note">
    618. 

  618. <p class="admonition-title">Note</p>
    619. 

  619. <p>This method modifies the module in-place.</p>
    620. 

  620. </div>
    621. 

  621. <dl class="field-list simple">
    622. 

  622. <dt class="field-odd">Parameters</dt>
    623. 

  623. <dd class="field-odd"><p><strong>device</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a><em>, </em><em>optional</em>) – if specified, all parameters will be
    624. 

  624. copied to that device</p>
    625. 

  625. </dd>
    626. 

  626. <dt class="field-even">Returns</dt>
    627. 

  627. <dd class="field-even"><p>self</p>
    628. 

  628. </dd>
    629. 

  629. <dt class="field-odd">Return type</dt>
    630. 

  630. <dd class="field-odd"><p>Module</p>
    631. 

  631. </dd>
    632. 

  632. </dl>
    633. 

  633. </dd></dl>
    634. 

  634. 

  635. <dl class="py method">
    636. 

  636. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict">
    637. 

  637. <span class="sig-name descname"><span class="pre">load_state_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state_dict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping" title="(in Python v3.10)"><span class="pre">Mapping</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.10)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict" title="Permalink to this definition">¶</a></dt>
    638. 

  638. <dd><p>Copies parameters and buffers from <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a> into
    639. 

  639. this module and its descendants. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">strict</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, then
    640. 

  640. the keys of <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a> must exactly match the keys returned
    641. 

  641. by this module’s <code class="xref py py-meth docutils literal notranslate"><span class="pre">state_dict()</span></code> function.</p>
    642. 

  642. <dl class="field-list simple">
    643. 

  643. <dt class="field-odd">Parameters</dt>
    644. 

  644. <dd class="field-odd"><ul class="simple">
    645. 

  645. <li><p><strong>state_dict</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><em>dict</em></a>) – a dict containing parameters and
    646. 

  646. persistent buffers.</p></li>
    647. 

  647. <li><p><strong>strict</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a><em>, </em><em>optional</em>) – whether to strictly enforce that the keys
    648. 

  648. in <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a> match the keys returned by this module’s
    649. 

  649. <code class="xref py py-meth docutils literal notranslate"><span class="pre">state_dict()</span></code> function. Default: <code class="docutils literal notranslate"><span class="pre">True</span></code></p></li>
    650. 

  650. </ul>
    651. 

  651. </dd>
    652. 

  652. <dt class="field-even">Returns</dt>
    653. 

  653. <dd class="field-even"><p><ul class="simple">
    654. 

  654. <li><p><strong>missing_keys</strong> is a list of str containing the missing keys</p></li>
    655. 

  655. <li><p><strong>unexpected_keys</strong> is a list of str containing the unexpected keys</p></li>
    656. 

  656. </ul>
    657. 

  657. </p>
    658. 

  658. </dd>
    659. 

  659. <dt class="field-odd">Return type</dt>
    660. 

  660. <dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">NamedTuple</span></code> with <code class="docutils literal notranslate"><span class="pre">missing_keys</span></code> and <code class="docutils literal notranslate"><span class="pre">unexpected_keys</span></code> fields</p>
    661. 

  661. </dd>
    662. 

  662. </dl>
    663. 

  663. <div class="admonition note">
    664. 

  664. <p class="admonition-title">Note</p>
    665. 

  665. <p>If a parameter or buffer is registered as <code class="docutils literal notranslate"><span class="pre">None</span></code> and its corresponding key
    666. 

  666. exists in <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>, <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict"><code class="xref py py-meth docutils literal notranslate"><span class="pre">load_state_dict()</span></code></a> will raise a
    667. 

  667. <code class="docutils literal notranslate"><span class="pre">RuntimeError</span></code>.</p>
    668. 

  668. </div>
    669. 

  669. </dd></dl>
    670. 

  670. 

  671. <dl class="py method">
    672. 

  672. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.modules">
    673. 

  673. <span class="sig-name descname"><span class="pre">modules</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.10)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.modules" title="Permalink to this definition">¶</a></dt>
    674. 

  674. <dd><p>Returns an iterator over all modules in the network.</p>
    675. 

  675. <dl class="field-list simple">
    676. 

  676. <dt class="field-odd">Yields</dt>
    677. 

  677. <dd class="field-odd"><p><em>Module</em> – a module in the network</p>
    678. 

  678. </dd>
    679. 

  679. </dl>
    680. 

  680. <div class="admonition note">
    681. 

  681. <p class="admonition-title">Note</p>
    682. 

  682. <p>Duplicate modules are returned only once. In the following
    683. 

  683. example, <code class="docutils literal notranslate"><span class="pre">l</span></code> will be returned only once.</p>
    684. 

  684. </div>
    685. 

  685. <p>Example:</p>
    686. 

  686. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">l</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
    687. 

  687. <span class="gp">&gt;&gt;&gt; </span><span class="n">net</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Sequential</span><span class="p">(</span><span class="n">l</span><span class="p">,</span> <span class="n">l</span><span class="p">)</span>
    688. 

  688. <span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">m</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">net</span><span class="o">.</span><span class="n">modules</span><span class="p">()):</span>
    689. 

  689. <span class="go">        print(idx, &#39;-&gt;&#39;, m)</span>
    690. 

  690. 

  691. <span class="go">0 -&gt; Sequential(</span>
    692. 

  692. <span class="go">  (0): Linear(in_features=2, out_features=2, bias=True)</span>
    693. 

  693. <span class="go">  (1): Linear(in_features=2, out_features=2, bias=True)</span>
    694. 

  694. <span class="go">)</span>
    695. 

  695. <span class="go">1 -&gt; Linear(in_features=2, out_features=2, bias=True)</span>
    696. 

  696. </pre></div>
    697. 

  697. </div>
    698. 

  698. </dd></dl>
    699. 

  699. 

  700. <dl class="py method">
    701. 

  701. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.named_buffers">
    702. 

  702. <span class="sig-name descname"><span class="pre">named_buffers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recurse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.10)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_buffers" title="Permalink to this definition">¶</a></dt>
    703. 

  703. <dd><p>Returns an iterator over module buffers, yielding both the
    704. 

  704. name of the buffer as well as the buffer itself.</p>
    705. 

  705. <dl class="field-list simple">
    706. 

  706. <dt class="field-odd">Parameters</dt>
    707. 

  707. <dd class="field-odd"><ul class="simple">
    708. 

  708. <li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – prefix to prepend to all buffer names.</p></li>
    709. 

  709. <li><p><strong>recurse</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – if True, then yields buffers of this module
    710. 

  710. and all submodules. Otherwise, yields only buffers that
    711. 

  711. are direct members of this module.</p></li>
    712. 

  712. </ul>
    713. 

  713. </dd>
    714. 

  714. <dt class="field-even">Yields</dt>
    715. 

  715. <dd class="field-even"><p><em>(string, torch.Tensor)</em> – Tuple containing the name and buffer</p>
    716. 

  716. </dd>
    717. 

  717. </dl>
    718. 

  718. <p>Example:</p>
    719. 

  719. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">buf</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">named_buffers</span><span class="p">():</span>
    720. 

  720. <span class="gp">&gt;&gt;&gt; </span>   <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;running_var&#39;</span><span class="p">]:</span>
    721. 

  721. <span class="gp">&gt;&gt;&gt; </span>       <span class="nb">print</span><span class="p">(</span><span class="n">buf</span><span class="o">.</span><span class="n">size</span><span class="p">())</span>
    722. 

  722. </pre></div>
    723. 

  723. </div>
    724. 

  724. </dd></dl>
    725. 

  725. 

  726. <dl class="py method">
    727. 

  727. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.named_children">
    728. 

  728. <span class="sig-name descname"><span class="pre">named_children</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.10)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Module</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_children" title="Permalink to this definition">¶</a></dt>
    729. 

  729. <dd><p>Returns an iterator over immediate children modules, yielding both
    730. 

  730. the name of the module as well as the module itself.</p>
    731. 

  731. <dl class="field-list simple">
    732. 

  732. <dt class="field-odd">Yields</dt>
    733. 

  733. <dd class="field-odd"><p><em>(string, Module)</em> – Tuple containing a name and child module</p>
    734. 

  734. </dd>
    735. 

  735. </dl>
    736. 

  736. <p>Example:</p>
    737. 

  737. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">module</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">named_children</span><span class="p">():</span>
    738. 

  738. <span class="gp">&gt;&gt;&gt; </span>    <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;conv4&#39;</span><span class="p">,</span> <span class="s1">&#39;conv5&#39;</span><span class="p">]:</span>
    739. 

  739. <span class="gp">&gt;&gt;&gt; </span>        <span class="nb">print</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
    740. 

  740. </pre></div>
    741. 

  741. </div>
    742. 

  742. </dd></dl>
    743. 

  743. 

  744. <dl class="py method">
    745. 

  745. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.named_modules">
    746. 

  746. <span class="sig-name descname"><span class="pre">named_modules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.10)"><span class="pre">Set</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remove_duplicate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_modules" title="Permalink to this definition">¶</a></dt>
    747. 

  747. <dd><p>Returns an iterator over all modules in the network, yielding
    748. 

  748. both the name of the module as well as the module itself.</p>
    749. 

  749. <dl class="field-list simple">
    750. 

  750. <dt class="field-odd">Parameters</dt>
    751. 

  751. <dd class="field-odd"><ul class="simple">
    752. 

  752. <li><p><strong>memo</strong> – a memo to store the set of modules already added to the result</p></li>
    753. 

  753. <li><p><strong>prefix</strong> – a prefix that will be added to the name of the module</p></li>
    754. 

  754. <li><p><strong>remove_duplicate</strong> – whether to remove the duplicated module instances in the result
    755. 

  755. or not</p></li>
    756. 

  756. </ul>
    757. 

  757. </dd>
    758. 

  758. <dt class="field-even">Yields</dt>
    759. 

  759. <dd class="field-even"><p><em>(string, Module)</em> – Tuple of name and module</p>
    760. 

  760. </dd>
    761. 

  761. </dl>
    762. 

  762. <div class="admonition note">
    763. 

  763. <p class="admonition-title">Note</p>
    764. 

  764. <p>Duplicate modules are returned only once. In the following
    765. 

  765. example, <code class="docutils literal notranslate"><span class="pre">l</span></code> will be returned only once.</p>
    766. 

  766. </div>
    767. 

  767. <p>Example:</p>
    768. 

  768. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">l</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
    769. 

  769. <span class="gp">&gt;&gt;&gt; </span><span class="n">net</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Sequential</span><span class="p">(</span><span class="n">l</span><span class="p">,</span> <span class="n">l</span><span class="p">)</span>
    770. 

  770. <span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">m</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">net</span><span class="o">.</span><span class="n">named_modules</span><span class="p">()):</span>
    771. 

  771. <span class="go">        print(idx, &#39;-&gt;&#39;, m)</span>
    772. 

  772. 

  773. <span class="go">0 -&gt; (&#39;&#39;, Sequential(</span>
    774. 

  774. <span class="go">  (0): Linear(in_features=2, out_features=2, bias=True)</span>
    775. 

  775. <span class="go">  (1): Linear(in_features=2, out_features=2, bias=True)</span>
    776. 

  776. <span class="go">))</span>
    777. 

  777. <span class="go">1 -&gt; (&#39;0&#39;, Linear(in_features=2, out_features=2, bias=True))</span>
    778. 

  778. </pre></div>
    779. 

  779. </div>
    780. 

  780. </dd></dl>
    781. 

  781. 

  782. <dl class="py method">
    783. 

  783. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.named_parameters">
    784. 

  784. <span class="sig-name descname"><span class="pre">named_parameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recurse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.10)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Parameter</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.named_parameters" title="Permalink to this definition">¶</a></dt>
    785. 

  785. <dd><p>Returns an iterator over module parameters, yielding both the
    786. 

  786. name of the parameter as well as the parameter itself.</p>
    787. 

  787. <dl class="field-list simple">
    788. 

  788. <dt class="field-odd">Parameters</dt>
    789. 

  789. <dd class="field-odd"><ul class="simple">
    790. 

  790. <li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – prefix to prepend to all parameter names.</p></li>
    791. 

  791. <li><p><strong>recurse</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – if True, then yields parameters of this module
    792. 

  792. and all submodules. Otherwise, yields only parameters that
    793. 

  793. are direct members of this module.</p></li>
    794. 

  794. </ul>
    795. 

  795. </dd>
    796. 

  796. <dt class="field-even">Yields</dt>
    797. 

  797. <dd class="field-even"><p><em>(string, Parameter)</em> – Tuple containing the name and parameter</p>
    798. 

  798. </dd>
    799. 

  799. </dl>
    800. 

  800. <p>Example:</p>
    801. 

  801. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">param</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">named_parameters</span><span class="p">():</span>
    802. 

  802. <span class="gp">&gt;&gt;&gt; </span>   <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;bias&#39;</span><span class="p">]:</span>
    803. 

  803. <span class="gp">&gt;&gt;&gt; </span>       <span class="nb">print</span><span class="p">(</span><span class="n">param</span><span class="o">.</span><span class="n">size</span><span class="p">())</span>
    804. 

  804. </pre></div>
    805. 

  805. </div>
    806. 

  806. </dd></dl>
    807. 

  807. 

  808. <dl class="py property">
    809. 

  809. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.output_shape">
    810. 

  810. <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">output_shape</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.10)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.output_shape" title="Permalink to this definition">¶</a></dt>
    811. 

  811. <dd><p>return:
    812. 

  812. :rtype:</p>
    813. 

  813. </dd></dl>
    814. 

  814. 

  815. <dl class="py method">
    816. 

  816. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.parameters">
    817. 

  817. <span class="sig-name descname"><span class="pre">parameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recurse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Iterator" title="(in Python v3.10)"><span class="pre">Iterator</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Parameter</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.parameters" title="Permalink to this definition">¶</a></dt>
    818. 

  818. <dd><p>Returns an iterator over module parameters.</p>
    819. 

  819. <p>This is typically passed to an optimizer.</p>
    820. 

  820. <dl class="field-list simple">
    821. 

  821. <dt class="field-odd">Parameters</dt>
    822. 

  822. <dd class="field-odd"><p><strong>recurse</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – if True, then yields parameters of this module
    823. 

  823. and all submodules. Otherwise, yields only parameters that
    824. 

  824. are direct members of this module.</p>
    825. 

  825. </dd>
    826. 

  826. <dt class="field-even">Yields</dt>
    827. 

  827. <dd class="field-even"><p><em>Parameter</em> – module parameter</p>
    828. 

  828. </dd>
    829. 

  829. </dl>
    830. 

  830. <p>Example:</p>
    831. 

  831. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">parameters</span><span class="p">():</span>
    832. 

  832. <span class="gp">&gt;&gt;&gt; </span>    <span class="nb">print</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">param</span><span class="p">),</span> <span class="n">param</span><span class="o">.</span><span class="n">size</span><span class="p">())</span>
    833. 

  833. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L,)</span>
    834. 

  834. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L, 1L, 5L, 5L)</span>
    835. 

  835. </pre></div>
    836. 

  836. </div>
    837. 

  837. </dd></dl>
    838. 

  838. 

  839. <dl class="py method">
    840. 

  840. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_backward_hook">
    841. 

  841. <span class="sig-name descname"><span class="pre">register_backward_hook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hook</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">RemovableHandle</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_backward_hook" title="Permalink to this definition">¶</a></dt>
    842. 

  842. <dd><p>Registers a backward hook on the module.</p>
    843. 

  843. <p>This function is deprecated in favor of <code class="xref py py-meth docutils literal notranslate"><span class="pre">register_full_backward_hook()</span></code> and
    844. 

  844. the behavior of this function will change in future versions.</p>
    845. 

  845. <dl class="field-list simple">
    846. 

  846. <dt class="field-odd">Returns</dt>
    847. 

  847. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
    848. 

  848. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
    849. 

  849. </dd>
    850. 

  850. <dt class="field-even">Return type</dt>
    851. 

  851. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
    852. 

  852. </dd>
    853. 

  853. </dl>
    854. 

  854. </dd></dl>
    855. 

  855. 

  856. <dl class="py method">
    857. 

  857. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_buffer">
    858. 

  858. <span class="sig-name descname"><span class="pre">register_buffer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tensor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persistent</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_buffer" title="Permalink to this definition">¶</a></dt>
    859. 

  859. <dd><p>Adds a buffer to the module.</p>
    860. 

  860. <p>This is typically used to register a buffer that should not to be
    861. 

  861. considered a model parameter. For example, BatchNorm’s <code class="docutils literal notranslate"><span class="pre">running_mean</span></code>
    862. 

  862. is not a parameter, but is part of the module’s state. Buffers, by
    863. 

  863. default, are persistent and will be saved alongside parameters. This
    864. 

  864. behavior can be changed by setting <code class="xref py py-attr docutils literal notranslate"><span class="pre">persistent</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>. The
    865. 

  865. only difference between a persistent buffer and a non-persistent buffer
    866. 

  866. is that the latter will not be a part of this module’s
    867. 

  867. <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p>
    868. 

  868. <p>Buffers can be accessed as attributes using given names.</p>
    869. 

  869. <dl class="field-list simple">
    870. 

  870. <dt class="field-odd">Parameters</dt>
    871. 

  871. <dd class="field-odd"><ul class="simple">
    872. 

  872. <li><p><strong>name</strong> (<em>string</em>) – name of the buffer. The buffer can be accessed
    873. 

  873. from this module using the given name</p></li>
    874. 

  874. <li><p><strong>tensor</strong> (<em>Tensor</em><em> or </em><em>None</em>) – buffer to be registered. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, then operations
    875. 

  875. that run on buffers, such as <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.cuda" title="draugr.torch_utilities.architectures.architecture.Architecture.cuda"><code class="xref py py-attr docutils literal notranslate"><span class="pre">cuda</span></code></a>, are ignored. If <code class="docutils literal notranslate"><span class="pre">None</span></code>,
    876. 

  876. the buffer is <strong>not</strong> included in the module’s <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p></li>
    877. 

  877. <li><p><strong>persistent</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – whether the buffer is part of this module’s
    878. 

  878. <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p></li>
    879. 

  879. </ul>
    880. 

  880. </dd>
    881. 

  881. </dl>
    882. 

  882. <p>Example:</p>
    883. 

  883. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="bp">self</span><span class="o">.</span><span class="n">register_buffer</span><span class="p">(</span><span class="s1">&#39;running_mean&#39;</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="n">num_features</span><span class="p">))</span>
    884. 

  884. </pre></div>
    885. 

  885. </div>
    886. 

  886. </dd></dl>
    887. 

  887. 

  888. <dl class="py method">
    889. 

  889. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_forward_hook">
    890. 

  890. <span class="sig-name descname"><span class="pre">register_forward_hook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hook</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">RemovableHandle</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_forward_hook" title="Permalink to this definition">¶</a></dt>
    891. 

  891. <dd><p>Registers a forward hook on the module.</p>
    892. 

  892. <p>The hook will be called every time after <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.forward" title="draugr.torch_utilities.architectures.architecture.Architecture.forward"><code class="xref py py-func docutils literal notranslate"><span class="pre">forward()</span></code></a> has computed an output.
    893. 

  893. It should have the following signature:</p>
    894. 

  894. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">hook</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="nb">input</span><span class="p">,</span> <span class="n">output</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">modified</span> <span class="n">output</span>
    895. 

  895. </pre></div>
    896. 

  896. </div>
    897. 

  897. <p>The input contains only the positional arguments given to the module.
    898. 

  898. Keyword arguments won’t be passed to the hooks and only to the <code class="docutils literal notranslate"><span class="pre">forward</span></code>.
    899. 

  899. The hook can modify the output. It can modify the input inplace but
    900. 

  900. it will not have effect on forward since this is called after
    901. 

  901. <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.forward" title="draugr.torch_utilities.architectures.architecture.Architecture.forward"><code class="xref py py-func docutils literal notranslate"><span class="pre">forward()</span></code></a> is called.</p>
    902. 

  902. <dl class="field-list simple">
    903. 

  903. <dt class="field-odd">Returns</dt>
    904. 

  904. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
    905. 

  905. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
    906. 

  906. </dd>
    907. 

  907. <dt class="field-even">Return type</dt>
    908. 

  908. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
    909. 

  909. </dd>
    910. 

  910. </dl>
    911. 

  911. </dd></dl>
    912. 

  912. 

  913. <dl class="py method">
    914. 

  914. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_forward_pre_hook">
    915. 

  915. <span class="sig-name descname"><span class="pre">register_forward_pre_hook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hook</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">RemovableHandle</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_forward_pre_hook" title="Permalink to this definition">¶</a></dt>
    916. 

  916. <dd><p>Registers a forward pre-hook on the module.</p>
    917. 

  917. <p>The hook will be called every time before <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.forward" title="draugr.torch_utilities.architectures.architecture.Architecture.forward"><code class="xref py py-func docutils literal notranslate"><span class="pre">forward()</span></code></a> is invoked.
    918. 

  918. It should have the following signature:</p>
    919. 

  919. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">hook</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="nb">input</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">modified</span> <span class="nb">input</span>
    920. 

  920. </pre></div>
    921. 

  921. </div>
    922. 

  922. <p>The input contains only the positional arguments given to the module.
    923. 

  923. Keyword arguments won’t be passed to the hooks and only to the <code class="docutils literal notranslate"><span class="pre">forward</span></code>.
    924. 

  924. The hook can modify the input. User can either return a tuple or a
    925. 

  925. single modified value in the hook. We will wrap the value into a tuple
    926. 

  926. if a single value is returned(unless that value is already a tuple).</p>
    927. 

  927. <dl class="field-list simple">
    928. 

  928. <dt class="field-odd">Returns</dt>
    929. 

  929. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
    930. 

  930. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
    931. 

  931. </dd>
    932. 

  932. <dt class="field-even">Return type</dt>
    933. 

  933. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
    934. 

  934. </dd>
    935. 

  935. </dl>
    936. 

  936. </dd></dl>
    937. 

  937. 

  938. <dl class="py method">
    939. 

  939. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_full_backward_hook">
    940. 

  940. <span class="sig-name descname"><span class="pre">register_full_backward_hook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hook</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.10)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Tensor</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Tensor</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">RemovableHandle</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_full_backward_hook" title="Permalink to this definition">¶</a></dt>
    941. 

  941. <dd><p>Registers a backward hook on the module.</p>
    942. 

  942. <p>The hook will be called every time the gradients with respect to module
    943. 

  943. inputs are computed. The hook should have the following signature:</p>
    944. 

  944. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">hook</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">grad_input</span><span class="p">,</span> <span class="n">grad_output</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">Tensor</span><span class="p">)</span> <span class="ow">or</span> <span class="kc">None</span>
    945. 

  945. </pre></div>
    946. 

  946. </div>
    947. 

  947. <p>The <code class="xref py py-attr docutils literal notranslate"><span class="pre">grad_input</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">grad_output</span></code> are tuples that contain the gradients
    948. 

  948. with respect to the inputs and outputs respectively. The hook should
    949. 

  949. not modify its arguments, but it can optionally return a new gradient with
    950. 

  950. respect to the input that will be used in place of <code class="xref py py-attr docutils literal notranslate"><span class="pre">grad_input</span></code> in
    951. 

  951. subsequent computations. <code class="xref py py-attr docutils literal notranslate"><span class="pre">grad_input</span></code> will only correspond to the inputs given
    952. 

  952. as positional arguments and all kwarg arguments are ignored. Entries
    953. 

  953. in <code class="xref py py-attr docutils literal notranslate"><span class="pre">grad_input</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">grad_output</span></code> will be <code class="docutils literal notranslate"><span class="pre">None</span></code> for all non-Tensor
    954. 

  954. arguments.</p>
    955. 

  955. <p>For technical reasons, when this hook is applied to a Module, its forward function will
    956. 

  956. receive a view of each Tensor passed to the Module. Similarly the caller will receive a view
    957. 

  957. of each Tensor returned by the Module’s forward function.</p>
    958. 

  958. <div class="admonition warning">
    959. 

  959. <p class="admonition-title">Warning</p>
    960. 

  960. <p>Modifying inputs or outputs inplace is not allowed when using backward hooks and
    961. 

  961. will raise an error.</p>
    962. 

  962. </div>
    963. 

  963. <dl class="field-list simple">
    964. 

  964. <dt class="field-odd">Returns</dt>
    965. 

  965. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
    966. 

  966. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
    967. 

  967. </dd>
    968. 

  968. <dt class="field-even">Return type</dt>
    969. 

  969. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
    970. 

  970. </dd>
    971. 

  971. </dl>
    972. 

  972. </dd></dl>
    973. 

  973. 

  974. <dl class="py method">
    975. 

  975. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_load_state_dict_post_hook">
    976. 

  976. <span class="sig-name descname"><span class="pre">register_load_state_dict_post_hook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hook</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_load_state_dict_post_hook" title="Permalink to this definition">¶</a></dt>
    977. 

  977. <dd><p>Registers a post hook to be run after module’s <code class="docutils literal notranslate"><span class="pre">load_state_dict</span></code>
    978. 

  978. is called.</p>
    979. 

  979. <dl class="simple">
    980. 

  980. <dt>It should have the following signature::</dt><dd><p>hook(module, incompatible_keys) -&gt; None</p>
    981. 

  981. </dd>
    982. 

  982. </dl>
    983. 

  983. <p>The <code class="docutils literal notranslate"><span class="pre">module</span></code> argument is the current module that this hook is registered
    984. 

  984. on, and the <code class="docutils literal notranslate"><span class="pre">incompatible_keys</span></code> argument is a <code class="docutils literal notranslate"><span class="pre">NamedTuple</span></code> consisting
    985. 

  985. of attributes <code class="docutils literal notranslate"><span class="pre">missing_keys</span></code> and <code class="docutils literal notranslate"><span class="pre">unexpected_keys</span></code>. <code class="docutils literal notranslate"><span class="pre">missing_keys</span></code>
    986. 

  986. is a <code class="docutils literal notranslate"><span class="pre">list</span></code> of <code class="docutils literal notranslate"><span class="pre">str</span></code> containing the missing keys and
    987. 

  987. <code class="docutils literal notranslate"><span class="pre">unexpected_keys</span></code> is a <code class="docutils literal notranslate"><span class="pre">list</span></code> of <code class="docutils literal notranslate"><span class="pre">str</span></code> containing the unexpected keys.</p>
    988. 

  988. <p>The given incompatible_keys can be modified inplace if needed.</p>
    989. 

  989. <p>Note that the checks performed when calling <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_state_dict()</span></code></a> with
    990. 

  990. <code class="docutils literal notranslate"><span class="pre">strict=True</span></code> are affected by modifications the hook makes to
    991. 

  991. <code class="docutils literal notranslate"><span class="pre">missing_keys</span></code> or <code class="docutils literal notranslate"><span class="pre">unexpected_keys</span></code>, as expected. Additions to either
    992. 

  992. set of keys will result in an error being thrown when <code class="docutils literal notranslate"><span class="pre">strict=True</span></code>, and
    993. 

  993. clearning out both missing and unexpected keys will avoid an error.</p>
    994. 

  994. <dl class="field-list simple">
    995. 

  995. <dt class="field-odd">Returns</dt>
    996. 

  996. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
    997. 

  997. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
    998. 

  998. </dd>
    999. 

  999. <dt class="field-even">Return type</dt>
    1000. 

  1000. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
    1001. 

  1001. </dd>
    1002. 

  1002. </dl>
    1003. 

  1003. </dd></dl>
    1004. 

  1004. 

  1005. <dl class="py method">
    1006. 

  1006. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_module">
    1007. 

  1007. <span class="sig-name descname"><span class="pre">register_module</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Module</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_module" title="Permalink to this definition">¶</a></dt>
    1008. 

  1008. <dd><p>Alias for <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.add_module" title="draugr.torch_utilities.architectures.architecture.Architecture.add_module"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_module()</span></code></a>.</p>
    1009. 

  1009. </dd></dl>
    1010. 

  1010. 

  1011. <dl class="py method">
    1012. 

  1012. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.register_parameter">
    1013. 

  1013. <span class="sig-name descname"><span class="pre">register_parameter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Parameter</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.register_parameter" title="Permalink to this definition">¶</a></dt>
    1014. 

  1014. <dd><p>Adds a parameter to the module.</p>
    1015. 

  1015. <p>The parameter can be accessed as an attribute using given name.</p>
    1016. 

  1016. <dl class="field-list simple">
    1017. 

  1017. <dt class="field-odd">Parameters</dt>
    1018. 

  1018. <dd class="field-odd"><ul class="simple">
    1019. 

  1019. <li><p><strong>name</strong> (<em>string</em>) – name of the parameter. The parameter can be accessed
    1020. 

  1020. from this module using the given name</p></li>
    1021. 

  1021. <li><p><strong>param</strong> (<em>Parameter</em><em> or </em><em>None</em>) – parameter to be added to the module. If
    1022. 

  1022. <code class="docutils literal notranslate"><span class="pre">None</span></code>, then operations that run on parameters, such as <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.cuda" title="draugr.torch_utilities.architectures.architecture.Architecture.cuda"><code class="xref py py-attr docutils literal notranslate"><span class="pre">cuda</span></code></a>,
    1023. 

  1023. are ignored. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the parameter is <strong>not</strong> included in the
    1024. 

  1024. module’s <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p></li>
    1025. 

  1025. </ul>
    1026. 

  1026. </dd>
    1027. 

  1027. </dl>
    1028. 

  1028. </dd></dl>
    1029. 

  1029. 

  1030. <dl class="py method">
    1031. 

  1031. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.requires_grad_">
    1032. 

  1032. <span class="sig-name descname"><span class="pre">requires_grad_</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">requires_grad</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.requires_grad_" title="Permalink to this definition">¶</a></dt>
    1033. 

  1033. <dd><p>Change if autograd should record operations on parameters in this
    1034. 

  1034. module.</p>
    1035. 

  1035. <p>This method sets the parameters’ <code class="xref py py-attr docutils literal notranslate"><span class="pre">requires_grad</span></code> attributes
    1036. 

  1036. in-place.</p>
    1037. 

  1037. <p>This method is helpful for freezing part of the module for finetuning
    1038. 

  1038. or training parts of a model individually (e.g., GAN training).</p>
    1039. 

  1039. <p>See <span class="xref std std-ref">locally-disable-grad-doc</span> for a comparison between
    1040. 

  1040. <cite>.requires_grad_()</cite> and several similar mechanisms that may be confused with it.</p>
    1041. 

  1041. <dl class="field-list simple">
    1042. 

  1042. <dt class="field-odd">Parameters</dt>
    1043. 

  1043. <dd class="field-odd"><p><strong>requires_grad</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – whether autograd should record operations on
    1044. 

  1044. parameters in this module. Default: <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
    1045. 

  1045. </dd>
    1046. 

  1046. <dt class="field-even">Returns</dt>
    1047. 

  1047. <dd class="field-even"><p>self</p>
    1048. 

  1048. </dd>
    1049. 

  1049. <dt class="field-odd">Return type</dt>
    1050. 

  1050. <dd class="field-odd"><p>Module</p>
    1051. 

  1051. </dd>
    1052. 

  1052. </dl>
    1053. 

  1053. </dd></dl>
    1054. 

  1054. 

  1055. <dl class="py method">
    1056. 

  1056. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.sample_input">
    1057. 

  1057. <span class="sig-name descname"><span class="pre">sample_input</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.10)"><span class="pre">Any</span></a></span></span><a class="reference internal" href="../_modules/draugr/torch_utilities/architectures/architecture.html#Architecture.sample_input"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.sample_input" title="Permalink to this definition">¶</a></dt>
    1058. 

  1058. <dd><dl class="field-list simple">
    1059. 

  1059. <dt class="field-odd">Returns</dt>
    1060. 

  1060. <dd class="field-odd"><p></p>
    1061. 

  1061. </dd>
    1062. 

  1062. <dt class="field-even">Return type</dt>
    1063. 

  1063. <dd class="field-even"><p></p>
    1064. 

  1064. </dd>
    1065. 

  1065. </dl>
    1066. 

  1066. </dd></dl>
    1067. 

  1067. 

  1068. <dl class="py method">
    1069. 

  1069. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.set_extra_state">
    1070. 

  1070. <span class="sig-name descname"><span class="pre">set_extra_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.10)"><span class="pre">Any</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.set_extra_state" title="Permalink to this definition">¶</a></dt>
    1071. 

  1071. <dd><p>This function is called from <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict" title="draugr.torch_utilities.architectures.architecture.Architecture.load_state_dict"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_state_dict()</span></code></a> to handle any extra state
    1072. 

  1072. found within the <cite>state_dict</cite>. Implement this function and a corresponding
    1073. 

  1073. <a class="reference internal" href="#draugr.torch_utilities.architectures.architecture.Architecture.get_extra_state" title="draugr.torch_utilities.architectures.architecture.Architecture.get_extra_state"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_extra_state()</span></code></a> for your module if you need to store extra state within its
    1074. 

  1074. <cite>state_dict</cite>.</p>
    1075. 

  1075. <dl class="field-list simple">
    1076. 

  1076. <dt class="field-odd">Parameters</dt>
    1077. 

  1077. <dd class="field-odd"><p><strong>state</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><em>dict</em></a>) – Extra state from the <cite>state_dict</cite></p>
    1078. 

  1078. </dd>
    1079. 

  1079. </dl>
    1080. 

  1080. </dd></dl>
    1081. 

  1081. 

  1082. <dl class="py method">
    1083. 

  1083. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.share_memory">
    1084. 

  1084. <span class="sig-name descname"><span class="pre">share_memory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.share_memory" title="Permalink to this definition">¶</a></dt>
    1085. 

  1085. <dd><p>See <code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.Tensor.share_memory_()</span></code></p>
    1086. 

  1086. </dd></dl>
    1087. 

  1087. 

  1088. <dl class="py method">
    1089. 

  1089. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.state_dict">
    1090. 

  1090. <span class="sig-name descname"><span class="pre">state_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">destination</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_vars</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.state_dict" title="Permalink to this definition">¶</a></dt>
    1091. 

  1091. <dd><p>Returns a dictionary containing a whole state of the module.</p>
    1092. 

  1092. <p>Both parameters and persistent buffers (e.g. running averages) are
    1093. 

  1093. included. Keys are corresponding parameter and buffer names.
    1094. 

  1094. Parameters and buffers set to <code class="docutils literal notranslate"><span class="pre">None</span></code> are not included.</p>
    1095. 

  1095. <div class="admonition warning">
    1096. 

  1096. <p class="admonition-title">Warning</p>
    1097. 

  1097. <p>Currently <code class="docutils literal notranslate"><span class="pre">state_dict()</span></code> also accepts positional arguments for
    1098. 

  1098. <code class="docutils literal notranslate"><span class="pre">destination</span></code>, <code class="docutils literal notranslate"><span class="pre">prefix</span></code> and <code class="docutils literal notranslate"><span class="pre">keep_vars</span></code> in order. However,
    1099. 

  1099. this is being deprecated and keyword arguments will be enforced in
    1100. 

  1100. future releases.</p>
    1101. 

  1101. </div>
    1102. 

  1102. <div class="admonition warning">
    1103. 

  1103. <p class="admonition-title">Warning</p>
    1104. 

  1104. <p>Please avoid the use of argument <code class="docutils literal notranslate"><span class="pre">destination</span></code> as it is not
    1105. 

  1105. designed for end-users.</p>
    1106. 

  1106. </div>
    1107. 

  1107. <dl class="field-list simple">
    1108. 

  1108. <dt class="field-odd">Parameters</dt>
    1109. 

  1109. <dd class="field-odd"><ul class="simple">
    1110. 

  1110. <li><p><strong>destination</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><em>dict</em></a><em>, </em><em>optional</em>) – If provided, the state of module will
    1111. 

  1111. be updated into the dict and the same object is returned.
    1112. 

  1112. Otherwise, an <code class="docutils literal notranslate"><span class="pre">OrderedDict</span></code> will be created and returned.
    1113. 

  1113. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p></li>
    1114. 

  1114. <li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a><em>, </em><em>optional</em>) – a prefix added to parameter and buffer
    1115. 

  1115. names to compose the keys in state_dict. Default: <code class="docutils literal notranslate"><span class="pre">''</span></code>.</p></li>
    1116. 

  1116. <li><p><strong>keep_vars</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a><em>, </em><em>optional</em>) – by default the <code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code> s
    1117. 

  1117. returned in the state dict are detached from autograd. If it’s
    1118. 

  1118. set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, detaching will not be performed.
    1119. 

  1119. Default: <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
    1120. 

  1120. </ul>
    1121. 

  1121. </dd>
    1122. 

  1122. <dt class="field-even">Returns</dt>
    1123. 

  1123. <dd class="field-even"><p>a dictionary containing a whole state of the module</p>
    1124. 

  1124. </dd>
    1125. 

  1125. <dt class="field-odd">Return type</dt>
    1126. 

  1126. <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)">dict</a></p>
    1127. 

  1127. </dd>
    1128. 

  1128. </dl>
    1129. 

  1129. <p>Example:</p>
    1130. 

  1130. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">module</span><span class="o">.</span><span class="n">state_dict</span><span class="p">()</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
    1131. 

  1131. <span class="go">[&#39;bias&#39;, &#39;weight&#39;]</span>
    1132. 

  1132. </pre></div>
    1133. 

  1133. </div>
    1134. 

  1134. </dd></dl>
    1135. 

  1135. 

  1136. <dl class="py method">
    1137. 

  1137. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.to">
    1138. 

  1138. <span class="sig-name descname"><span class="pre">to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.to" title="Permalink to this definition">¶</a></dt>
    1139. 

  1139. <dd><p>Moves and/or casts the parameters and buffers.</p>
    1140. 

  1140. <p>This can be called as</p>
    1141. 

  1141. <dl class="py function">
    1142. 

  1142. <dt class="sig sig-object py">
    1143. 

  1143. <span class="sig-name descname"><span class="pre">to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">non_blocking</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
    1144. 

  1144. <dd></dd></dl>
    1145. 

  1145. 

  1146. <dl class="py function">
    1147. 

  1147. <dt class="sig sig-object py">
    1148. 

  1148. <span class="sig-name descname"><span class="pre">to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dtype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">non_blocking</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
    1149. 

  1149. <dd></dd></dl>
    1150. 

  1150. 

  1151. <dl class="py function">
    1152. 

  1152. <dt class="sig sig-object py">
    1153. 

  1153. <span class="sig-name descname"><span class="pre">to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tensor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">non_blocking</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span></dt>
    1154. 

  1154. <dd></dd></dl>
    1155. 

  1155. 

  1156. <dl class="py function">
    1157. 

  1157. <dt class="sig sig-object py">
    1158. 

  1158. <span class="sig-name descname"><span class="pre">to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">memory_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">torch.channels_last</span></span></em><span class="sig-paren">)</span></dt>
    1159. 

  1159. <dd></dd></dl>
    1160. 

  1160. 

  1161. <p>Its signature is similar to <code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.Tensor.to()</span></code>, but only accepts
    1162. 

  1162. floating point or complex <code class="xref py py-attr docutils literal notranslate"><span class="pre">dtype</span></code>s. In addition, this method will
    1163. 

  1163. only cast the floating point or complex parameters and buffers to <code class="xref py py-attr docutils literal notranslate"><span class="pre">dtype</span></code>
    1164. 

  1164. (if given). The integral parameters and buffers will be moved
    1165. 

  1165. <code class="xref py py-attr docutils literal notranslate"><span class="pre">device</span></code>, if that is given, but with dtypes unchanged. When
    1166. 

  1166. <code class="xref py py-attr docutils literal notranslate"><span class="pre">non_blocking</span></code> is set, it tries to convert/move asynchronously
    1167. 

  1167. with respect to the host if possible, e.g., moving CPU Tensors with
    1168. 

  1168. pinned memory to CUDA devices.</p>
    1169. 

  1169. <p>See below for examples.</p>
    1170. 

  1170. <div class="admonition note">
    1171. 

  1171. <p class="admonition-title">Note</p>
    1172. 

  1172. <p>This method modifies the module in-place.</p>
    1173. 

  1173. </div>
    1174. 

  1174. <dl class="field-list simple">
    1175. 

  1175. <dt class="field-odd">Parameters</dt>
    1176. 

  1176. <dd class="field-odd"><ul class="simple">
    1177. 

  1177. <li><p><strong>device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">torch.device</span></code>) – the desired device of the parameters
    1178. 

  1178. and buffers in this module</p></li>
    1179. 

  1179. <li><p><strong>dtype</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">torch.dtype</span></code>) – the desired floating point or complex dtype of
    1180. 

  1180. the parameters and buffers in this module</p></li>
    1181. 

  1181. <li><p><strong>tensor</strong> (<em>torch.Tensor</em>) – Tensor whose dtype and device are the desired
    1182. 

  1182. dtype and device for all parameters and buffers in this module</p></li>
    1183. 

  1183. <li><p><strong>memory_format</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">torch.memory_format</span></code>) – the desired memory
    1184. 

  1184. format for 4D parameters and buffers in this module (keyword
    1185. 

  1185. only argument)</p></li>
    1186. 

  1186. </ul>
    1187. 

  1187. </dd>
    1188. 

  1188. <dt class="field-even">Returns</dt>
    1189. 

  1189. <dd class="field-even"><p>self</p>
    1190. 

  1190. </dd>
    1191. 

  1191. <dt class="field-odd">Return type</dt>
    1192. 

  1192. <dd class="field-odd"><p>Module</p>
    1193. 

  1193. </dd>
    1194. 

  1194. </dl>
    1195. 

  1195. <p>Examples:</p>
    1196. 

  1196. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
    1197. 

  1197. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
    1198. 

  1198. <span class="go">Parameter containing:</span>
    1199. 

  1199. <span class="go">tensor([[ 0.1913, -0.3420],</span>
    1200. 

  1200. <span class="go">        [-0.5113, -0.2325]])</span>
    1201. 

  1201. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">double</span><span class="p">)</span>
    1202. 

  1202. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
    1203. 

  1203. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
    1204. 

  1204. <span class="go">Parameter containing:</span>
    1205. 

  1205. <span class="go">tensor([[ 0.1913, -0.3420],</span>
    1206. 

  1206. <span class="go">        [-0.5113, -0.2325]], dtype=torch.float64)</span>
    1207. 

  1207. <span class="gp">&gt;&gt;&gt; </span><span class="n">gpu1</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">device</span><span class="p">(</span><span class="s2">&quot;cuda:1&quot;</span><span class="p">)</span>
    1208. 

  1208. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">gpu1</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">half</span><span class="p">,</span> <span class="n">non_blocking</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    1209. 

  1209. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
    1210. 

  1210. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
    1211. 

  1211. <span class="go">Parameter containing:</span>
    1212. 

  1212. <span class="go">tensor([[ 0.1914, -0.3420],</span>
    1213. 

  1213. <span class="go">        [-0.5112, -0.2324]], dtype=torch.float16, device=&#39;cuda:1&#39;)</span>
    1214. 

  1214. <span class="gp">&gt;&gt;&gt; </span><span class="n">cpu</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">device</span><span class="p">(</span><span class="s2">&quot;cpu&quot;</span><span class="p">)</span>
    1215. 

  1215. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">cpu</span><span class="p">)</span>
    1216. 

  1216. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
    1217. 

  1217. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
    1218. 

  1218. <span class="go">Parameter containing:</span>
    1219. 

  1219. <span class="go">tensor([[ 0.1914, -0.3420],</span>
    1220. 

  1220. <span class="go">        [-0.5112, -0.2324]], dtype=torch.float16)</span>
    1221. 

  1221. 

  1222. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span> <span class="o">=</span> <span class="n">nn</span><span class="o">.</span><span class="n">Linear</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="n">bias</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span><span class="o">.</span><span class="n">to</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">cdouble</span><span class="p">)</span>
    1223. 

  1223. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
    1224. 

  1224. <span class="go">Parameter containing:</span>
    1225. 

  1225. <span class="go">tensor([[ 0.3741+0.j,  0.2382+0.j],</span>
    1226. 

  1226. <span class="go">        [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)</span>
    1227. 

  1227. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="p">(</span><span class="n">torch</span><span class="o">.</span><span class="n">ones</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">cdouble</span><span class="p">))</span>
    1228. 

  1228. <span class="go">tensor([[0.6122+0.j, 0.1150+0.j],</span>
    1229. 

  1229. <span class="go">        [0.6122+0.j, 0.1150+0.j],</span>
    1230. 

  1230. <span class="go">        [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)</span>
    1231. 

  1231. </pre></div>
    1232. 

  1232. </div>
    1233. 

  1233. </dd></dl>
    1234. 

  1234. 

  1235. <dl class="py method">
    1236. 

  1236. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.to_empty">
    1237. 

  1237. <span class="sig-name descname"><span class="pre">to_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">device</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.to_empty" title="Permalink to this definition">¶</a></dt>
    1238. 

  1238. <dd><p>Moves the parameters and buffers to the specified device without copying storage.</p>
    1239. 

  1239. <dl class="field-list simple">
    1240. 

  1240. <dt class="field-odd">Parameters</dt>
    1241. 

  1241. <dd class="field-odd"><p><strong>device</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">torch.device</span></code>) – The desired device of the parameters
    1242. 

  1242. and buffers in this module.</p>
    1243. 

  1243. </dd>
    1244. 

  1244. <dt class="field-even">Returns</dt>
    1245. 

  1245. <dd class="field-even"><p>self</p>
    1246. 

  1246. </dd>
    1247. 

  1247. <dt class="field-odd">Return type</dt>
    1248. 

  1248. <dd class="field-odd"><p>Module</p>
    1249. 

  1249. </dd>
    1250. 

  1250. </dl>
    1251. 

  1251. </dd></dl>
    1252. 

  1252. 

  1253. <dl class="py method">
    1254. 

  1254. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.train">
    1255. 

  1255. <span class="sig-name descname"><span class="pre">train</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.train" title="Permalink to this definition">¶</a></dt>
    1256. 

  1256. <dd><p>Sets the module in training mode.</p>
    1257. 

  1257. <p>This has any effect only on certain modules. See documentations of
    1258. 

  1258. particular modules for details of their behaviors in training/evaluation
    1259. 

  1259. mode, if they are affected, e.g. <code class="xref py py-class docutils literal notranslate"><span class="pre">Dropout</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">BatchNorm</span></code>,
    1260. 

  1260. etc.</p>
    1261. 

  1261. <dl class="field-list simple">
    1262. 

  1262. <dt class="field-odd">Parameters</dt>
    1263. 

  1263. <dd class="field-odd"><p><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – whether to set training mode (<code class="docutils literal notranslate"><span class="pre">True</span></code>) or evaluation
    1264. 

  1264. mode (<code class="docutils literal notranslate"><span class="pre">False</span></code>). Default: <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
    1265. 

  1265. </dd>
    1266. 

  1266. <dt class="field-even">Returns</dt>
    1267. 

  1267. <dd class="field-even"><p>self</p>
    1268. 

  1268. </dd>
    1269. 

  1269. <dt class="field-odd">Return type</dt>
    1270. 

  1270. <dd class="field-odd"><p>Module</p>
    1271. 

  1271. </dd>
    1272. 

  1272. </dl>
    1273. 

  1273. </dd></dl>
    1274. 

  1274. 

  1275. <dl class="py method">
    1276. 

  1276. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.type">
    1277. 

  1277. <span class="sig-name descname"><span class="pre">type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dst_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><span class="pre">dtype</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.type" title="Permalink to this definition">¶</a></dt>
    1278. 

  1278. <dd><p>Casts all parameters and buffers to <code class="xref py py-attr docutils literal notranslate"><span class="pre">dst_type</span></code>.</p>
    1279. 

  1279. <div class="admonition note">
    1280. 

  1280. <p class="admonition-title">Note</p>
    1281. 

  1281. <p>This method modifies the module in-place.</p>
    1282. 

  1282. </div>
    1283. 

  1283. <dl class="field-list simple">
    1284. 

  1284. <dt class="field-odd">Parameters</dt>
    1285. 

  1285. <dd class="field-odd"><p><strong>dst_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.10)"><em>type</em></a><em> or </em><em>string</em>) – the desired type</p>
    1286. 

  1286. </dd>
    1287. 

  1287. <dt class="field-even">Returns</dt>
    1288. 

  1288. <dd class="field-even"><p>self</p>
    1289. 

  1289. </dd>
    1290. 

  1290. <dt class="field-odd">Return type</dt>
    1291. 

  1291. <dd class="field-odd"><p>Module</p>
    1292. 

  1292. </dd>
    1293. 

  1293. </dl>
    1294. 

  1294. </dd></dl>
    1295. 

  1295. 

  1296. <dl class="py method">
    1297. 

  1297. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.xpu">
    1298. 

  1298. <span class="sig-name descname"><span class="pre">xpu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><span class="pre">Optional</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><span class="pre">Union</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">device</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T</span></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.xpu" title="Permalink to this definition">¶</a></dt>
    1299. 

  1299. <dd><p>Moves all model parameters and buffers to the XPU.</p>
    1300. 

  1300. <p>This also makes associated parameters and buffers different objects. So
    1301. 

  1301. it should be called before constructing optimizer if the module will
    1302. 

  1302. live on XPU while being optimized.</p>
    1303. 

  1303. <div class="admonition note">
    1304. 

  1304. <p class="admonition-title">Note</p>
    1305. 

  1305. <p>This method modifies the module in-place.</p>
    1306. 

  1306. </div>
    1307. 

  1307. <dl class="field-list simple">
    1308. 

  1308. <dt class="field-odd">Parameters</dt>
    1309. 

  1309. <dd class="field-odd"><p><strong>device</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a><em>, </em><em>optional</em>) – if specified, all parameters will be
    1310. 

  1310. copied to that device</p>
    1311. 

  1311. </dd>
    1312. 

  1312. <dt class="field-even">Returns</dt>
    1313. 

  1313. <dd class="field-even"><p>self</p>
    1314. 

  1314. </dd>
    1315. 

  1315. <dt class="field-odd">Return type</dt>
    1316. 

  1316. <dd class="field-odd"><p>Module</p>
    1317. 

  1317. </dd>
    1318. 

  1318. </dl>
    1319. 

  1319. </dd></dl>
    1320. 

  1320. 

  1321. <dl class="py method">
    1322. 

  1322. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.architecture.Architecture.zero_grad">
    1323. 

  1323. <span class="sig-name descname"><span class="pre">zero_grad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">set_to_none</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#draugr.torch_utilities.architectures.architecture.Architecture.zero_grad" title="Permalink to this definition">¶</a></dt>
    1324. 

  1324. <dd><p>Sets gradients of all model parameters to zero. See similar function
    1325. 

  1325. under <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.optim.Optimizer</span></code> for more context.</p>
    1326. 

  1326. <dl class="field-list simple">
    1327. 

  1327. <dt class="field-odd">Parameters</dt>
    1328. 

  1328. <dd class="field-odd"><p><strong>set_to_none</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><em>bool</em></a>) – instead of setting to zero, set the grads to None.
    1329. 

  1329. See <code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.optim.Optimizer.zero_grad()</span></code> for details.</p>
    1330. 

  1330. </dd>
    1331. 

  1331. </dl>
    1332. 

  1332. </dd></dl>
    1333. 

  1333. 

  1334. </dd></dl>
    1335. 

  1335. 

  1336. </section>
    1337. 

  1337. 

  1338. 

  1339.           </div>
    1340. 

  1340.           
    1341. 

  1341.         </div>
    1342. 

  1342.       </div>
    1343. 

  1343.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    1344. 

  1344.         <div class="sphinxsidebarwrapper">
    1345. 

  1345.             <p class="logo"><a href="../index.html">
    1346. 

  1346.               <img class="logo" src="../_static/valknut.svg" alt="Logo"/>
    1347. 

  1347.             </a></p>
    1348. 

  1348. <h1 class="logo"><a href="../index.html">Draugr</a></h1>
    1349. 

  1349. 

  1350. 

  1351. 

  1352. 

  1353. 

  1354. 

  1355. 

  1356. 

  1357. <h3>Navigation</h3>
    1358. 

  1358. <ul class="current">
    1359. 

  1359. <li class="toctree-l1 current"><a class="reference internal" href="draugr.html">draugr</a><ul class="current">
    1360. 

  1360. <li class="toctree-l2"><a class="reference internal" href="draugr.dist_is_editable.html">draugr.dist_is_editable</a></li>
    1361. 

  1361. <li class="toctree-l2"><a class="reference internal" href="draugr.get_version.html">draugr.get_version</a></li>
    1362. 

  1362. <li class="toctree-l2"><a class="reference internal" href="draugr.dlib_utilities.html">draugr.dlib_utilities</a></li>
    1363. 

  1363. <li class="toctree-l2"><a class="reference internal" href="draugr.drawers.html">draugr.drawers</a></li>
    1364. 

  1364. <li class="toctree-l2"><a class="reference internal" href="draugr.entry_points.html">draugr.entry_points</a></li>
    1365. 

  1365. <li class="toctree-l2"><a class="reference internal" href="draugr.extensions.html">draugr.extensions</a></li>
    1366. 

  1366. <li class="toctree-l2"><a class="reference internal" href="draugr.ffmpeg_utilities.html">draugr.ffmpeg_utilities</a></li>
    1367. 

  1367. <li class="toctree-l2"><a class="reference internal" href="draugr.jax_utilities.html">draugr.jax_utilities</a></li>
    1368. 

  1368. <li class="toctree-l2"><a class="reference internal" href="draugr.metrics.html">draugr.metrics</a></li>
    1369. 

  1369. <li class="toctree-l2"><a class="reference internal" href="draugr.multiprocessing_utilities.html">draugr.multiprocessing_utilities</a></li>
    1370. 

  1370. <li class="toctree-l2"><a class="reference internal" href="draugr.numpy_utilities.html">draugr.numpy_utilities</a></li>
    1371. 

  1371. <li class="toctree-l2"><a class="reference internal" href="draugr.opencv_utilities.html">draugr.opencv_utilities</a></li>
    1372. 

  1372. <li class="toctree-l2"><a class="reference internal" href="draugr.os_utilities.html">draugr.os_utilities</a></li>
    1373. 

  1373. <li class="toctree-l2"><a class="reference internal" href="draugr.pandas_utilities.html">draugr.pandas_utilities</a></li>
    1374. 

  1374. <li class="toctree-l2"><a class="reference internal" href="draugr.pygame_utilities.html">draugr.pygame_utilities</a></li>
    1375. 

  1375. <li class="toctree-l2"><a class="reference internal" href="draugr.python_utilities.html">draugr.python_utilities</a></li>
    1376. 

  1376. <li class="toctree-l2"><a class="reference internal" href="draugr.random_utilities.html">draugr.random_utilities</a></li>
    1377. 

  1377. <li class="toctree-l2"><a class="reference internal" href="draugr.scipy_utilities.html">draugr.scipy_utilities</a></li>
    1378. 

  1378. <li class="toctree-l2"><a class="reference internal" href="draugr.stopping.html">draugr.stopping</a></li>
    1379. 

  1379. <li class="toctree-l2"><a class="reference internal" href="draugr.tensorboard_utilities.html">draugr.tensorboard_utilities</a></li>
    1380. 

  1380. <li class="toctree-l2"><a class="reference internal" href="draugr.threading_utilities.html">draugr.threading_utilities</a></li>
    1381. 

  1381. <li class="toctree-l2 current"><a class="reference internal" href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul class="current">
    1382. 

  1382. <li class="toctree-l3 current"><a class="reference internal" href="draugr.torch_utilities.architectures.html">draugr.torch_utilities.architectures</a><ul class="current">
    1383. 

  1383. <li class="toctree-l4 current"><a class="reference internal" href="draugr.torch_utilities.architectures.architecture.html">draugr.torch_utilities.architectures.architecture</a><ul class="current">
    1384. 

  1384. <li class="toctree-l5 current"><a class="current reference internal" href="#">draugr.torch_utilities.architectures.architecture.Architecture</a></li>
    1385. 

  1385. </ul>
    1386. 

  1386. </li>
    1387. 

  1387. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.distributional.html">draugr.torch_utilities.architectures.distributional</a></li>
    1388. 

  1388. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.experimental.html">draugr.torch_utilities.architectures.experimental</a></li>
    1389. 

  1389. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.mlp.html">draugr.torch_utilities.architectures.mlp</a></li>
    1390. 

  1390. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.mlp_variants.html">draugr.torch_utilities.architectures.mlp_variants</a></li>
    1391. 

  1391. </ul>
    1392. 

  1392. </li>
    1393. 

  1393. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.datasets.html">draugr.torch_utilities.datasets</a></li>
    1394. 

  1394. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.distributions.html">draugr.torch_utilities.distributions</a></li>
    1395. 

  1395. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.evaluation.html">draugr.torch_utilities.evaluation</a></li>
    1396. 

  1396. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.exporting.html">draugr.torch_utilities.exporting</a></li>
    1397. 

  1397. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.generators.html">draugr.torch_utilities.generators</a></li>
    1398. 

  1398. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.images.html">draugr.torch_utilities.images</a></li>
    1399. 

  1399. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.opencv.html">draugr.torch_utilities.opencv</a></li>
    1400. 

  1400. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.operations.html">draugr.torch_utilities.operations</a></li>
    1401. 

  1401. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.optimisation.html">draugr.torch_utilities.optimisation</a></li>
    1402. 

  1402. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.persistence.html">draugr.torch_utilities.persistence</a></li>
    1403. 

  1403. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.sessions.html">draugr.torch_utilities.sessions</a></li>
    1404. 

  1404. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.system.html">draugr.torch_utilities.system</a></li>
    1405. 

  1405. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.tensors.html">draugr.torch_utilities.tensors</a></li>
    1406. 

  1406. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.writers.html">draugr.torch_utilities.writers</a></li>
    1407. 

  1407. </ul>
    1408. 

  1408. </li>
    1409. 

  1409. <li class="toctree-l2"><a class="reference internal" href="draugr.tqdm_utilities.html">draugr.tqdm_utilities</a></li>
    1410. 

  1410. <li class="toctree-l2"><a class="reference internal" href="draugr.visualisation.html">draugr.visualisation</a></li>
    1411. 

  1411. <li class="toctree-l2"><a class="reference internal" href="draugr.writers.html">draugr.writers</a></li>
    1412. 

  1412. </ul>
    1413. 

  1413. </li>
    1414. 

  1414. </ul>
    1415. 

  1415. <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
    1416. 

  1416. <ul>
    1417. 

  1417. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
    1418. 

  1418. </ul>
    1419. 

  1419. 

  1420. <div class="relations">
    1421. 

  1421. <h3>Related Topics</h3>
    1422. 

  1422. <ul>
    1423. 

  1423.   <li><a href="../index.html">Documentation overview</a><ul>
    1424. 

  1424.   <li><a href="draugr.html">draugr</a><ul>
    1425. 

  1425.   <li><a href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul>
    1426. 

  1426.   <li><a href="draugr.torch_utilities.architectures.html">draugr.torch_utilities.architectures</a><ul>
    1427. 

  1427.   <li><a href="draugr.torch_utilities.architectures.architecture.html">draugr.torch_utilities.architectures.architecture</a><ul>
    1428. 

  1428.       <li>Previous: <a href="draugr.torch_utilities.architectures.architecture.html" title="previous chapter">draugr.torch_utilities.architectures.architecture</a></li>
    1429. 

  1429.       <li>Next: <a href="draugr.torch_utilities.architectures.distributional.html" title="next chapter">draugr.torch_utilities.architectures.distributional</a></li>
    1430. 

  1430.   </ul></li>
    1431. 

  1431.   </ul></li>
    1432. 

  1432.   </ul></li>
    1433. 

  1433.   </ul></li>
    1434. 

  1434.   </ul></li>
    1435. 

  1435. </ul>
    1436. 

  1436. </div>
    1437. 

  1437. <div id="searchbox" style="display: none" role="search">
    1438. 

  1438.   <h3 id="searchlabel">Quick search</h3>
    1439. 

  1439.     <div class="searchformwrapper">
    1440. 

  1440.     <form class="search" action="../search.html" method="get">
    1441. 

  1441.       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    1442. 

  1442.       <input type="submit" value="Go" />
    1443. 

  1443.     </form>
    1444. 

  1444.     </div>
    1445. 

  1445. </div>
    1446. 

  1446. <script>document.getElementById('searchbox').style.display = "block"</script>
    1447. 

  1447. 

  1448. 

  1449. 

  1450. 

  1451. 

  1452. 

  1453. 

  1454. 

  1455.         </div>
    1456. 

  1456.       </div>
    1457. 

  1457.       <div class="clearer"></div>
    1458. 

  1458.     </div>
    1459. 

  1459.     <div class="footer">
    1460. 

  1460.       &copy;.
    1461. 

  1461.       
    1462. 

  1462.       |
    1463. 

  1463.       Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
    1464. 

  1464.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
    1465. 

  1465.       
    1466. 

  1466.       |
    1467. 

  1467.       <a href="../_sources/generated/draugr.torch_utilities.architectures.architecture.Architecture.rst.txt"
    1468. 

  1468.           rel="nofollow">Page source</a>
    1469. 

  1469.     </div>
    1470. 

  1470. 

  1471.     
    1472. 

  1472. 

  1473.     
    1474. 

  1474.   </body>
    1475. 

  1475. </html>
    1476.