draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.html 179 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
  6. <title>draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP &#8212; Draugr 1.0.1 documentation</title>
  7. <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  8. <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
  9. <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
  10. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  11. <script src="../_static/jquery.js"></script>
  12. <script src="../_static/underscore.js"></script>
  13. <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
  14. <script src="../_static/doctools.js"></script>
  15. <link rel="canonical" href="pything.github.io/draugr/generated/draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.html" />
  16. <link rel="index" title="Index" href="../genindex.html" />
  17. <link rel="search" title="Search" href="../search.html" />
  18. <link rel="next" title="draugr.torch_utilities.architectures.distributional.normal.MultipleNormalMLP" href="draugr.torch_utilities.architectures.distributional.normal.MultipleNormalMLP.html" />
  19. <link rel="prev" title="draugr.torch_utilities.architectures.distributional.normal.MultiDimensionalNormalMLP" href="draugr.torch_utilities.architectures.distributional.normal.MultiDimensionalNormalMLP.html" />
  20. <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  21. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  22. </head><body>
  23. <div class="document">
  24. <div class="documentwrapper">
  25. <div class="bodywrapper">
  26. <div class="body" role="main">
  27. <section id="draugr-torch-utilities-architectures-distributional-normal-multivariatenormalmlp">
  28. <h1>draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP<a class="headerlink" href="#draugr-torch-utilities-architectures-distributional-normal-multivariatenormalmlp" title="Permalink to this heading">¶</a></h1>
  29. <dl class="py class">
  30. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP">
  31. <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.distributional.normal.</span></span><span class="sig-name descname"><span class="pre">MultiVariateNormalMLP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_shape:</span> <span class="pre">~typing.Sequence</span> <span class="pre">=</span> <span class="pre">(2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean_head_activation:</span> <span class="pre">~typing.Optional[callable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_shape:</span> <span class="pre">~typing.Sequence[int]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hidden_layers:</span> <span class="pre">~typing.Sequence[int]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hidden_layer_activation:</span> <span class="pre">~torch.nn.modules.module.Module</span> <span class="pre">=</span> <span class="pre">ReLU()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_activation:</span> <span class="pre">~torch.nn.modules.module.Module</span> <span class="pre">=</span> <span class="pre">Identity()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_bias:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_dropout:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dropout_prob:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_build_hidden_layers_if_none=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_multiplier:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_layer_width=1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_multiplier:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_init:</span> <span class="pre">callable</span> <span class="pre">=</span> <span class="pre">&lt;function</span> <span class="pre">fan_in_init&gt;</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/torch_utilities/architectures/distributional/normal.html#MultiVariateNormalMLP"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP" title="Permalink to this definition">¶</a></dt>
  32. <dd><p>Bases: <a class="reference internal" href="draugr.torch_utilities.architectures.mlp.MLP.html#draugr.torch_utilities.architectures.mlp.MLP" title="draugr.torch_utilities.architectures.mlp.MLP"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLP</span></code></a></p>
  33. <p>description</p>
  34. <dl class="py method">
  35. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.__init__">
  36. <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">output_shape:</span> <span class="pre">~typing.Sequence</span> <span class="pre">=</span> <span class="pre">(2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean_head_activation:</span> <span class="pre">~typing.Optional[callable]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_shape:</span> <span class="pre">~typing.Sequence[int]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hidden_layers:</span> <span class="pre">~typing.Sequence[int]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hidden_layer_activation:</span> <span class="pre">~torch.nn.modules.module.Module</span> <span class="pre">=</span> <span class="pre">ReLU()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_activation:</span> <span class="pre">~torch.nn.modules.module.Module</span> <span class="pre">=</span> <span class="pre">Identity()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_bias:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_dropout:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dropout_prob:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0.2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_build_hidden_layers_if_none=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_multiplier:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_layer_width=1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_multiplier:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_init:</span> <span class="pre">callable</span> <span class="pre">=</span> <span class="pre">&lt;function</span> <span class="pre">fan_in_init&gt;</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/torch_utilities/architectures/distributional/normal.html#MultiVariateNormalMLP.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.__init__" title="Permalink to this definition">¶</a></dt>
  37. <dd><p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p>
  38. </dd></dl>
  39. <p class="rubric">Methods</p>
  40. <table class="autosummary longtable docutils align-default">
  41. <colgroup>
  42. <col style="width: 10%" />
  43. <col style="width: 90%" />
  44. </colgroup>
  45. <tbody>
  46. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.__init__" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>([output_shape, ...])</p></td>
  47. <td><p>Initializes internal Module state, shared by both nn.Module and ScriptModule.</p></td>
  48. </tr>
  49. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.add_module" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.add_module"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_module</span></code></a>(name, module)</p></td>
  50. <td><p>Adds a child module to the current module.</p></td>
  51. </tr>
  52. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.apply" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.apply"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply</span></code></a>(fn)</p></td>
  53. <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>
  54. </tr>
  55. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.bfloat16" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.bfloat16"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bfloat16</span></code></a>()</p></td>
  56. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">bfloat16</span></code> datatype.</p></td>
  57. </tr>
  58. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.buffers" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.buffers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">buffers</span></code></a>([recurse])</p></td>
  59. <td><p>Returns an iterator over module buffers.</p></td>
  60. </tr>
  61. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.children" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.children"><code class="xref py py-obj docutils literal notranslate"><span class="pre">children</span></code></a>()</p></td>
  62. <td><p>Returns an iterator over immediate children modules.</p></td>
  63. </tr>
  64. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.construct_progressive_hidden_layers" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.construct_progressive_hidden_layers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">construct_progressive_hidden_layers</span></code></a>(...[, ...])</p></td>
  65. <td><p><dl class="field-list simple">
  66. <dt class="field-odd">param _input_shape</dt>
  67. <dd class="field-odd"><p></p></dd>
  68. </dl>
  69. </p></td>
  70. </tr>
  71. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cpu" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cpu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cpu</span></code></a>()</p></td>
  72. <td><p>Moves all model parameters and buffers to the CPU.</p></td>
  73. </tr>
  74. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cuda" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cuda"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cuda</span></code></a>([device])</p></td>
  75. <td><p>Moves all model parameters and buffers to the GPU.</p></td>
  76. </tr>
  77. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.double" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.double"><code class="xref py py-obj docutils literal notranslate"><span class="pre">double</span></code></a>()</p></td>
  78. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">double</span></code> datatype.</p></td>
  79. </tr>
  80. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.eval" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.eval"><code class="xref py py-obj docutils literal notranslate"><span class="pre">eval</span></code></a>()</p></td>
  81. <td><p>Sets the module in evaluation mode.</p></td>
  82. </tr>
  83. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.extra_repr" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.extra_repr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">extra_repr</span></code></a>()</p></td>
  84. <td><p>Set the extra representation of the module</p></td>
  85. </tr>
  86. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.float" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.float"><code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></a>()</p></td>
  87. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">float</span></code> datatype.</p></td>
  88. </tr>
  89. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward"><code class="xref py py-obj docutils literal notranslate"><span class="pre">forward</span></code></a>(*x[, min_std, max_std])</p></td>
  90. <td><p><dl class="field-list simple">
  91. <dt class="field-odd">param x</dt>
  92. <dd class="field-odd"><p></p></dd>
  93. </dl>
  94. </p></td>
  95. </tr>
  96. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_buffer" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_buffer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_buffer</span></code></a>(target)</p></td>
  97. <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>
  98. </tr>
  99. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_extra_state" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_extra_state"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_extra_state</span></code></a>()</p></td>
  100. <td><p>Returns any extra state to include in the module's state_dict.</p></td>
  101. </tr>
  102. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_parameter" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_parameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_parameter</span></code></a>(target)</p></td>
  103. <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>
  104. </tr>
  105. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_submodule" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_submodule"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_submodule</span></code></a>(target)</p></td>
  106. <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>
  107. </tr>
  108. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.half" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.half"><code class="xref py py-obj docutils literal notranslate"><span class="pre">half</span></code></a>()</p></td>
  109. <td><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">half</span></code> datatype.</p></td>
  110. </tr>
  111. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_input_shape" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_input_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">infer_input_shape</span></code></a>(input_shape)</p></td>
  112. <td><p><dl class="field-list simple">
  113. <dt class="field-odd">return</dt>
  114. <dd class="field-odd"><p></p></dd>
  115. </dl>
  116. </p></td>
  117. </tr>
  118. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_output_shape" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_output_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">infer_output_shape</span></code></a>(output_shape)</p></td>
  119. <td><p><dl class="field-list simple">
  120. <dt class="field-odd">return</dt>
  121. <dd class="field-odd"><p></p></dd>
  122. </dl>
  123. </p></td>
  124. </tr>
  125. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.ipu" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.ipu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipu</span></code></a>([device])</p></td>
  126. <td><p>Moves all model parameters and buffers to the IPU.</p></td>
  127. </tr>
  128. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.load_state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>
  129. <td><p>Copies parameters and buffers from <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>
  130. </tr>
  131. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.modules" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.modules"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modules</span></code></a>()</p></td>
  132. <td><p>Returns an iterator over all modules in the network.</p></td>
  133. </tr>
  134. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_buffers" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_buffers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">named_buffers</span></code></a>([prefix, recurse])</p></td>
  135. <td><p>Returns an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.</p></td>
  136. </tr>
  137. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_children" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_children"><code class="xref py py-obj docutils literal notranslate"><span class="pre">named_children</span></code></a>()</p></td>
  138. <td><p>Returns an iterator over immediate children modules, yielding both the name of the module as well as the module itself.</p></td>
  139. </tr>
  140. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_modules" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>
  141. <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>
  142. </tr>
  143. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_parameters" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_parameters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">named_parameters</span></code></a>([prefix, recurse])</p></td>
  144. <td><p>Returns an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.</p></td>
  145. </tr>
  146. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.parameters" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.parameters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">parameters</span></code></a>([recurse])</p></td>
  147. <td><p>Returns an iterator over module parameters.</p></td>
  148. </tr>
  149. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_backward_hook" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_backward_hook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_backward_hook</span></code></a>(hook)</p></td>
  150. <td><p>Registers a backward hook on the module.</p></td>
  151. </tr>
  152. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_buffer" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_buffer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_buffer</span></code></a>(name, tensor[, persistent])</p></td>
  153. <td><p>Adds a buffer to the module.</p></td>
  154. </tr>
  155. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_forward_hook" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_forward_hook"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_forward_hook</span></code></a>(hook)</p></td>
  156. <td><p>Registers a forward hook on the module.</p></td>
  157. </tr>
  158. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_forward_pre_hook" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>
  159. <td><p>Registers a forward pre-hook on the module.</p></td>
  160. </tr>
  161. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_full_backward_hook" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>
  162. <td><p>Registers a backward hook on the module.</p></td>
  163. </tr>
  164. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_load_state_dict_post_hook" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>
  165. <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>
  166. </tr>
  167. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_module" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_module"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_module</span></code></a>(name, module)</p></td>
  168. <td><p>Alias for <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.add_module" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.add_module"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_module()</span></code></a>.</p></td>
  169. </tr>
  170. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_parameter" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_parameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_parameter</span></code></a>(name, param)</p></td>
  171. <td><p>Adds a parameter to the module.</p></td>
  172. </tr>
  173. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.requires_grad_" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.requires_grad_"><code class="xref py py-obj docutils literal notranslate"><span class="pre">requires_grad_</span></code></a>([requires_grad])</p></td>
  174. <td><p>Change if autograd should record operations on parameters in this module.</p></td>
  175. </tr>
  176. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.sample_input" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.sample_input"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sample_input</span></code></a>()</p></td>
  177. <td><p><dl class="field-list simple">
  178. <dt class="field-odd">return</dt>
  179. <dd class="field-odd"><p></p></dd>
  180. </dl>
  181. </p></td>
  182. </tr>
  183. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.set_extra_state" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.set_extra_state"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_extra_state</span></code></a>(state)</p></td>
  184. <td><p>This function is called from <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.load_state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>
  185. </tr>
  186. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.share_memory" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.share_memory"><code class="xref py py-obj docutils literal notranslate"><span class="pre">share_memory</span></code></a>()</p></td>
  187. <td><p>See <code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.Tensor.share_memory_()</span></code></p></td>
  188. </tr>
  189. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">state_dict</span></code></a>(*args[, destination, prefix, ...])</p></td>
  190. <td><p>Returns a dictionary containing a whole state of the module.</p></td>
  191. </tr>
  192. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.to" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.to"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to</span></code></a>(*args, **kwargs)</p></td>
  193. <td><p>Moves and/or casts the parameters and buffers.</p></td>
  194. </tr>
  195. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.to_empty" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.to_empty"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_empty</span></code></a>(*, device)</p></td>
  196. <td><p>Moves the parameters and buffers to the specified device without copying storage.</p></td>
  197. </tr>
  198. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.train" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.train"><code class="xref py py-obj docutils literal notranslate"><span class="pre">train</span></code></a>([mode])</p></td>
  199. <td><p>Sets the module in training mode.</p></td>
  200. </tr>
  201. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.type" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span></code></a>(dst_type)</p></td>
  202. <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>
  203. </tr>
  204. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.xpu" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.xpu"><code class="xref py py-obj docutils literal notranslate"><span class="pre">xpu</span></code></a>([device])</p></td>
  205. <td><p>Moves all model parameters and buffers to the XPU.</p></td>
  206. </tr>
  207. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.zero_grad" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.zero_grad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">zero_grad</span></code></a>([set_to_none])</p></td>
  208. <td><p>Sets gradients of all model parameters to zero.</p></td>
  209. </tr>
  210. </tbody>
  211. </table>
  212. <p class="rubric">Attributes</p>
  213. <table class="autosummary longtable docutils align-default">
  214. <colgroup>
  215. <col style="width: 10%" />
  216. <col style="width: 90%" />
  217. </colgroup>
  218. <tbody>
  219. <tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">T_destination</span></code></p></td>
  220. <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>
  221. </tr>
  222. <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dump_patches</span></code></p></td>
  223. <td><p></p></td>
  224. </tr>
  225. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.input_shape" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.input_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">input_shape</span></code></a></p></td>
  226. <td><p>return: :rtype:</p></td>
  227. </tr>
  228. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.output_shape" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.output_shape"><code class="xref py py-obj docutils literal notranslate"><span class="pre">output_shape</span></code></a></p></td>
  229. <td><p>return: :rtype:</p></td>
  230. </tr>
  231. </tbody>
  232. </table>
  233. <dl class="py method">
  234. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.add_module">
  235. <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.distributional.normal.MultiVariateNormalMLP.add_module" title="Permalink to this definition">¶</a></dt>
  236. <dd><p>Adds a child module to the current module.</p>
  237. <p>The module can be accessed as an attribute using the given name.</p>
  238. <dl class="field-list simple">
  239. <dt class="field-odd">Parameters</dt>
  240. <dd class="field-odd"><ul class="simple">
  241. <li><p><strong>name</strong> (<em>string</em>) – name of the child module. The child module can be
  242. accessed from this module using the given name</p></li>
  243. <li><p><strong>module</strong> (<em>Module</em>) – child module to be added to the module.</p></li>
  244. </ul>
  245. </dd>
  246. </dl>
  247. </dd></dl>
  248. <dl class="py method">
  249. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.apply">
  250. <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.distributional.normal.MultiVariateNormalMLP.apply" title="Permalink to this definition">¶</a></dt>
  251. <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>)
  252. as well as self. Typical use includes initializing the parameters of a model
  253. (see also <span class="xref std std-ref">nn-init-doc</span>).</p>
  254. <dl class="field-list simple">
  255. <dt class="field-odd">Parameters</dt>
  256. <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>
  257. </dd>
  258. <dt class="field-even">Returns</dt>
  259. <dd class="field-even"><p>self</p>
  260. </dd>
  261. <dt class="field-odd">Return type</dt>
  262. <dd class="field-odd"><p>Module</p>
  263. </dd>
  264. </dl>
  265. <p>Example:</p>
  266. <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>
  267. <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>
  268. <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>
  269. <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>
  270. <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>
  271. <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>
  272. <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>
  273. <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>
  274. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
  275. <span class="go">Parameter containing:</span>
  276. <span class="go">tensor([[ 1., 1.],</span>
  277. <span class="go"> [ 1., 1.]])</span>
  278. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
  279. <span class="go">Parameter containing:</span>
  280. <span class="go">tensor([[ 1., 1.],</span>
  281. <span class="go"> [ 1., 1.]])</span>
  282. <span class="go">Sequential(</span>
  283. <span class="go"> (0): Linear(in_features=2, out_features=2, bias=True)</span>
  284. <span class="go"> (1): Linear(in_features=2, out_features=2, bias=True)</span>
  285. <span class="go">)</span>
  286. <span class="go">Sequential(</span>
  287. <span class="go"> (0): Linear(in_features=2, out_features=2, bias=True)</span>
  288. <span class="go"> (1): Linear(in_features=2, out_features=2, bias=True)</span>
  289. <span class="go">)</span>
  290. </pre></div>
  291. </div>
  292. </dd></dl>
  293. <dl class="py method">
  294. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.bfloat16">
  295. <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.distributional.normal.MultiVariateNormalMLP.bfloat16" title="Permalink to this definition">¶</a></dt>
  296. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">bfloat16</span></code> datatype.</p>
  297. <div class="admonition note">
  298. <p class="admonition-title">Note</p>
  299. <p>This method modifies the module in-place.</p>
  300. </div>
  301. <dl class="field-list simple">
  302. <dt class="field-odd">Returns</dt>
  303. <dd class="field-odd"><p>self</p>
  304. </dd>
  305. <dt class="field-even">Return type</dt>
  306. <dd class="field-even"><p>Module</p>
  307. </dd>
  308. </dl>
  309. </dd></dl>
  310. <dl class="py method">
  311. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.buffers">
  312. <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.distributional.normal.MultiVariateNormalMLP.buffers" title="Permalink to this definition">¶</a></dt>
  313. <dd><p>Returns an iterator over module buffers.</p>
  314. <dl class="field-list simple">
  315. <dt class="field-odd">Parameters</dt>
  316. <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
  317. and all submodules. Otherwise, yields only buffers that
  318. are direct members of this module.</p>
  319. </dd>
  320. <dt class="field-even">Yields</dt>
  321. <dd class="field-even"><p><em>torch.Tensor</em> – module buffer</p>
  322. </dd>
  323. </dl>
  324. <p>Example:</p>
  325. <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>
  326. <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>
  327. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L,)</span>
  328. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L, 1L, 5L, 5L)</span>
  329. </pre></div>
  330. </div>
  331. </dd></dl>
  332. <dl class="py method">
  333. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.children">
  334. <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.distributional.normal.MultiVariateNormalMLP.children" title="Permalink to this definition">¶</a></dt>
  335. <dd><p>Returns an iterator over immediate children modules.</p>
  336. <dl class="field-list simple">
  337. <dt class="field-odd">Yields</dt>
  338. <dd class="field-odd"><p><em>Module</em> – a child module</p>
  339. </dd>
  340. </dl>
  341. </dd></dl>
  342. <dl class="py method">
  343. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.construct_progressive_hidden_layers">
  344. <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">construct_progressive_hidden_layers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_input_shape</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_output_shape</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_multiplier</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#float" title="(in Python v3.10)"><span class="pre">float</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">32</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_multiplier</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#float" title="(in Python v3.10)"><span class="pre">float</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">16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_layer_width</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#int" title="(in Python v3.10)"><span class="pre">int</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">1000</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.Sequence" title="(in Python v3.10)"><span class="pre">Sequence</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.distributional.normal.MultiVariateNormalMLP.construct_progressive_hidden_layers" title="Permalink to this definition">¶</a></dt>
  345. <dd><dl class="field-list simple">
  346. <dt class="field-odd">Parameters</dt>
  347. <dd class="field-odd"><ul class="simple">
  348. <li><p><strong>_input_shape</strong> – </p></li>
  349. <li><p><strong>_output_shape</strong> – </p></li>
  350. <li><p><strong>input_multiplier</strong> – </p></li>
  351. <li><p><strong>output_multiplier</strong> – </p></li>
  352. <li><p><strong>max_layer_width</strong> – </p></li>
  353. </ul>
  354. </dd>
  355. <dt class="field-even">Returns</dt>
  356. <dd class="field-even"><p></p>
  357. </dd>
  358. <dt class="field-odd">Return type</dt>
  359. <dd class="field-odd"><p></p>
  360. </dd>
  361. </dl>
  362. </dd></dl>
  363. <dl class="py method">
  364. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cpu">
  365. <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.distributional.normal.MultiVariateNormalMLP.cpu" title="Permalink to this definition">¶</a></dt>
  366. <dd><p>Moves all model parameters and buffers to the CPU.</p>
  367. <div class="admonition note">
  368. <p class="admonition-title">Note</p>
  369. <p>This method modifies the module in-place.</p>
  370. </div>
  371. <dl class="field-list simple">
  372. <dt class="field-odd">Returns</dt>
  373. <dd class="field-odd"><p>self</p>
  374. </dd>
  375. <dt class="field-even">Return type</dt>
  376. <dd class="field-even"><p>Module</p>
  377. </dd>
  378. </dl>
  379. </dd></dl>
  380. <dl class="py method">
  381. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cuda">
  382. <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.distributional.normal.MultiVariateNormalMLP.cuda" title="Permalink to this definition">¶</a></dt>
  383. <dd><p>Moves all model parameters and buffers to the GPU.</p>
  384. <p>This also makes associated parameters and buffers different objects. So
  385. it should be called before constructing optimizer if the module will
  386. live on GPU while being optimized.</p>
  387. <div class="admonition note">
  388. <p class="admonition-title">Note</p>
  389. <p>This method modifies the module in-place.</p>
  390. </div>
  391. <dl class="field-list simple">
  392. <dt class="field-odd">Parameters</dt>
  393. <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
  394. copied to that device</p>
  395. </dd>
  396. <dt class="field-even">Returns</dt>
  397. <dd class="field-even"><p>self</p>
  398. </dd>
  399. <dt class="field-odd">Return type</dt>
  400. <dd class="field-odd"><p>Module</p>
  401. </dd>
  402. </dl>
  403. </dd></dl>
  404. <dl class="py method">
  405. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.double">
  406. <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.distributional.normal.MultiVariateNormalMLP.double" title="Permalink to this definition">¶</a></dt>
  407. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">double</span></code> datatype.</p>
  408. <div class="admonition note">
  409. <p class="admonition-title">Note</p>
  410. <p>This method modifies the module in-place.</p>
  411. </div>
  412. <dl class="field-list simple">
  413. <dt class="field-odd">Returns</dt>
  414. <dd class="field-odd"><p>self</p>
  415. </dd>
  416. <dt class="field-even">Return type</dt>
  417. <dd class="field-even"><p>Module</p>
  418. </dd>
  419. </dl>
  420. </dd></dl>
  421. <dl class="py method">
  422. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.eval">
  423. <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.distributional.normal.MultiVariateNormalMLP.eval" title="Permalink to this definition">¶</a></dt>
  424. <dd><p>Sets the module in evaluation mode.</p>
  425. <p>This has any effect only on certain modules. See documentations of
  426. particular modules for details of their behaviors in training/evaluation
  427. 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>,
  428. etc.</p>
  429. <p>This is equivalent with <code class="xref py py-meth docutils literal notranslate"><span class="pre">self.train(False)</span></code>.</p>
  430. <p>See <span class="xref std std-ref">locally-disable-grad-doc</span> for a comparison between
  431. <cite>.eval()</cite> and several similar mechanisms that may be confused with it.</p>
  432. <dl class="field-list simple">
  433. <dt class="field-odd">Returns</dt>
  434. <dd class="field-odd"><p>self</p>
  435. </dd>
  436. <dt class="field-even">Return type</dt>
  437. <dd class="field-even"><p>Module</p>
  438. </dd>
  439. </dl>
  440. </dd></dl>
  441. <dl class="py method">
  442. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.extra_repr">
  443. <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.distributional.normal.MultiVariateNormalMLP.extra_repr" title="Permalink to this definition">¶</a></dt>
  444. <dd><p>Set the extra representation of the module</p>
  445. <p>To print customized extra information, you should re-implement
  446. this method in your own modules. Both single-line and multi-line
  447. strings are acceptable.</p>
  448. </dd></dl>
  449. <dl class="py method">
  450. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.float">
  451. <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.distributional.normal.MultiVariateNormalMLP.float" title="Permalink to this definition">¶</a></dt>
  452. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">float</span></code> datatype.</p>
  453. <div class="admonition note">
  454. <p class="admonition-title">Note</p>
  455. <p>This method modifies the module in-place.</p>
  456. </div>
  457. <dl class="field-list simple">
  458. <dt class="field-odd">Returns</dt>
  459. <dd class="field-odd"><p>self</p>
  460. </dd>
  461. <dt class="field-even">Return type</dt>
  462. <dd class="field-even"><p>Module</p>
  463. </dd>
  464. </dl>
  465. </dd></dl>
  466. <dl class="py method">
  467. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward">
  468. <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">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_std</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-</span> <span class="pre">20</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_std</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</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">MultivariateNormal</span></span></span><a class="reference internal" href="../_modules/draugr/torch_utilities/architectures/distributional/normal.html#MultiVariateNormalMLP.forward"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward" title="Permalink to this definition">¶</a></dt>
  469. <dd><dl class="field-list simple">
  470. <dt class="field-odd">Parameters</dt>
  471. <dd class="field-odd"><ul class="simple">
  472. <li><p><strong>x</strong> – </p></li>
  473. <li><p><strong>min_std</strong> – </p></li>
  474. <li><p><strong>max_std</strong> – </p></li>
  475. <li><p><strong>kwargs</strong> – </p></li>
  476. </ul>
  477. </dd>
  478. <dt class="field-even">Returns</dt>
  479. <dd class="field-even"><p></p>
  480. </dd>
  481. <dt class="field-odd">Return type</dt>
  482. <dd class="field-odd"><p></p>
  483. </dd>
  484. </dl>
  485. </dd></dl>
  486. <dl class="py method">
  487. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_buffer">
  488. <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.distributional.normal.MultiVariateNormalMLP.get_buffer" title="Permalink to this definition">¶</a></dt>
  489. <dd><p>Returns the buffer given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists,
  490. otherwise throws an error.</p>
  491. <p>See the docstring for <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for a more detailed
  492. explanation of this method’s functionality as well as how to
  493. correctly specify <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
  494. <dl class="field-list simple">
  495. <dt class="field-odd">Parameters</dt>
  496. <dd class="field-odd"><p><strong>target</strong> – The fully-qualified string name of the buffer
  497. to look for. (See <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for how to specify a
  498. fully-qualified string.)</p>
  499. </dd>
  500. <dt class="field-even">Returns</dt>
  501. <dd class="field-even"><p>The buffer referenced by <code class="docutils literal notranslate"><span class="pre">target</span></code></p>
  502. </dd>
  503. <dt class="field-odd">Return type</dt>
  504. <dd class="field-odd"><p>torch.Tensor</p>
  505. </dd>
  506. <dt class="field-even">Raises</dt>
  507. <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
  508. path or resolves to something that is not a
  509. buffer</p>
  510. </dd>
  511. </dl>
  512. </dd></dl>
  513. <dl class="py method">
  514. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_extra_state">
  515. <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.distributional.normal.MultiVariateNormalMLP.get_extra_state" title="Permalink to this definition">¶</a></dt>
  516. <dd><p>Returns any extra state to include in the module’s state_dict.
  517. Implement this and a corresponding <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.set_extra_state" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.set_extra_state"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_extra_state()</span></code></a> for your module
  518. if you need to store extra state. This function is called when building the
  519. module’s <cite>state_dict()</cite>.</p>
  520. <p>Note that extra state should be pickleable to ensure working serialization
  521. of the state_dict. We only provide provide backwards compatibility guarantees
  522. for serializing Tensors; other objects may break backwards compatibility if
  523. their serialized pickled form changes.</p>
  524. <dl class="field-list simple">
  525. <dt class="field-odd">Returns</dt>
  526. <dd class="field-odd"><p>Any extra state to store in the module’s state_dict</p>
  527. </dd>
  528. <dt class="field-even">Return type</dt>
  529. <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>
  530. </dd>
  531. </dl>
  532. </dd></dl>
  533. <dl class="py method">
  534. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_parameter">
  535. <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.distributional.normal.MultiVariateNormalMLP.get_parameter" title="Permalink to this definition">¶</a></dt>
  536. <dd><p>Returns the parameter given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists,
  537. otherwise throws an error.</p>
  538. <p>See the docstring for <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for a more detailed
  539. explanation of this method’s functionality as well as how to
  540. correctly specify <code class="docutils literal notranslate"><span class="pre">target</span></code>.</p>
  541. <dl class="field-list simple">
  542. <dt class="field-odd">Parameters</dt>
  543. <dd class="field-odd"><p><strong>target</strong> – The fully-qualified string name of the Parameter
  544. to look for. (See <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> for how to specify a
  545. fully-qualified string.)</p>
  546. </dd>
  547. <dt class="field-even">Returns</dt>
  548. <dd class="field-even"><p>The Parameter referenced by <code class="docutils literal notranslate"><span class="pre">target</span></code></p>
  549. </dd>
  550. <dt class="field-odd">Return type</dt>
  551. <dd class="field-odd"><p>torch.nn.Parameter</p>
  552. </dd>
  553. <dt class="field-even">Raises</dt>
  554. <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
  555. path or resolves to something that is not an
  556. <code class="docutils literal notranslate"><span class="pre">nn.Parameter</span></code></p>
  557. </dd>
  558. </dl>
  559. </dd></dl>
  560. <dl class="py method">
  561. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_submodule">
  562. <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.distributional.normal.MultiVariateNormalMLP.get_submodule" title="Permalink to this definition">¶</a></dt>
  563. <dd><p>Returns the submodule given by <code class="docutils literal notranslate"><span class="pre">target</span></code> if it exists,
  564. otherwise throws an error.</p>
  565. <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
  566. looks like this:</p>
  567. <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>A(
  568. (net_b): Module(
  569. (net_c): Module(
  570. (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
  571. )
  572. (linear): Linear(in_features=100, out_features=200, bias=True)
  573. )
  574. )
  575. </pre></div>
  576. </div>
  577. <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
  578. 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>
  579. 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>
  580. <p>To check whether or not we have the <code class="docutils literal notranslate"><span class="pre">linear</span></code> submodule, we
  581. would call <code class="docutils literal notranslate"><span class="pre">get_submodule(&quot;net_b.linear&quot;)</span></code>. To check whether
  582. we have the <code class="docutils literal notranslate"><span class="pre">conv</span></code> submodule, we would call
  583. <code class="docutils literal notranslate"><span class="pre">get_submodule(&quot;net_b.net_c.conv&quot;)</span></code>.</p>
  584. <p>The runtime of <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> is bounded by the degree
  585. of module nesting in <code class="docutils literal notranslate"><span class="pre">target</span></code>. A query against
  586. <code class="docutils literal notranslate"><span class="pre">named_modules</span></code> achieves the same result, but it is O(N) in
  587. the number of transitive modules. So, for a simple check to see
  588. if some submodule exists, <code class="docutils literal notranslate"><span class="pre">get_submodule</span></code> should always be
  589. used.</p>
  590. <dl class="field-list simple">
  591. <dt class="field-odd">Parameters</dt>
  592. <dd class="field-odd"><p><strong>target</strong> – The fully-qualified string name of the submodule
  593. to look for. (See above example for how to specify a
  594. fully-qualified string.)</p>
  595. </dd>
  596. <dt class="field-even">Returns</dt>
  597. <dd class="field-even"><p>The submodule referenced by <code class="docutils literal notranslate"><span class="pre">target</span></code></p>
  598. </dd>
  599. <dt class="field-odd">Return type</dt>
  600. <dd class="field-odd"><p>torch.nn.Module</p>
  601. </dd>
  602. <dt class="field-even">Raises</dt>
  603. <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
  604. path or resolves to something that is not an
  605. <code class="docutils literal notranslate"><span class="pre">nn.Module</span></code></p>
  606. </dd>
  607. </dl>
  608. </dd></dl>
  609. <dl class="py method">
  610. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.half">
  611. <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.distributional.normal.MultiVariateNormalMLP.half" title="Permalink to this definition">¶</a></dt>
  612. <dd><p>Casts all floating point parameters and buffers to <code class="docutils literal notranslate"><span class="pre">half</span></code> datatype.</p>
  613. <div class="admonition note">
  614. <p class="admonition-title">Note</p>
  615. <p>This method modifies the module in-place.</p>
  616. </div>
  617. <dl class="field-list simple">
  618. <dt class="field-odd">Returns</dt>
  619. <dd class="field-odd"><p>self</p>
  620. </dd>
  621. <dt class="field-even">Return type</dt>
  622. <dd class="field-even"><p>Module</p>
  623. </dd>
  624. </dl>
  625. </dd></dl>
  626. <dl class="py method">
  627. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_input_shape">
  628. <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">infer_input_shape</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><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.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></span><a class="headerlink" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_input_shape" title="Permalink to this definition">¶</a></dt>
  629. <dd><blockquote>
  630. <div><dl class="field-list simple">
  631. <dt class="field-odd">return</dt>
  632. <dd class="field-odd"><p></p></dd>
  633. <dt class="field-even">rtype</dt>
  634. <dd class="field-even"><p></p></dd>
  635. </dl>
  636. </div></blockquote>
  637. <dl class="field-list simple">
  638. <dt class="field-odd">Parameters</dt>
  639. <dd class="field-odd"><p><strong>input_shape</strong> – </p>
  640. </dd>
  641. <dt class="field-even">Returns</dt>
  642. <dd class="field-even"><p></p>
  643. </dd>
  644. </dl>
  645. </dd></dl>
  646. <dl class="py method">
  647. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_output_shape">
  648. <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">infer_output_shape</span></span><span class="sig-paren">(</span><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> <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.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></span><a class="headerlink" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.infer_output_shape" title="Permalink to this definition">¶</a></dt>
  649. <dd><blockquote>
  650. <div><dl class="field-list simple">
  651. <dt class="field-odd">return</dt>
  652. <dd class="field-odd"><p></p></dd>
  653. <dt class="field-even">rtype</dt>
  654. <dd class="field-even"><p></p></dd>
  655. </dl>
  656. </div></blockquote>
  657. <dl class="field-list simple">
  658. <dt class="field-odd">Parameters</dt>
  659. <dd class="field-odd"><p><strong>output_shape</strong> – </p>
  660. </dd>
  661. <dt class="field-even">Returns</dt>
  662. <dd class="field-even"><p></p>
  663. </dd>
  664. </dl>
  665. </dd></dl>
  666. <dl class="py property">
  667. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.input_shape">
  668. <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.distributional.normal.MultiVariateNormalMLP.input_shape" title="Permalink to this definition">¶</a></dt>
  669. <dd><p>return:
  670. :rtype:</p>
  671. </dd></dl>
  672. <dl class="py method">
  673. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.ipu">
  674. <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.distributional.normal.MultiVariateNormalMLP.ipu" title="Permalink to this definition">¶</a></dt>
  675. <dd><p>Moves all model parameters and buffers to the IPU.</p>
  676. <p>This also makes associated parameters and buffers different objects. So
  677. it should be called before constructing optimizer if the module will
  678. live on IPU while being optimized.</p>
  679. <div class="admonition note">
  680. <p class="admonition-title">Note</p>
  681. <p>This method modifies the module in-place.</p>
  682. </div>
  683. <dl class="field-list simple">
  684. <dt class="field-odd">Parameters</dt>
  685. <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
  686. copied to that device</p>
  687. </dd>
  688. <dt class="field-even">Returns</dt>
  689. <dd class="field-even"><p>self</p>
  690. </dd>
  691. <dt class="field-odd">Return type</dt>
  692. <dd class="field-odd"><p>Module</p>
  693. </dd>
  694. </dl>
  695. </dd></dl>
  696. <dl class="py method">
  697. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.load_state_dict">
  698. <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.distributional.normal.MultiVariateNormalMLP.load_state_dict" title="Permalink to this definition">¶</a></dt>
  699. <dd><p>Copies parameters and buffers from <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a> into
  700. 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
  701. the keys of <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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
  702. by this module’s <code class="xref py py-meth docutils literal notranslate"><span class="pre">state_dict()</span></code> function.</p>
  703. <dl class="field-list simple">
  704. <dt class="field-odd">Parameters</dt>
  705. <dd class="field-odd"><ul class="simple">
  706. <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
  707. persistent buffers.</p></li>
  708. <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
  709. in <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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
  710. <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>
  711. </ul>
  712. </dd>
  713. <dt class="field-even">Returns</dt>
  714. <dd class="field-even"><p><ul class="simple">
  715. <li><p><strong>missing_keys</strong> is a list of str containing the missing keys</p></li>
  716. <li><p><strong>unexpected_keys</strong> is a list of str containing the unexpected keys</p></li>
  717. </ul>
  718. </p>
  719. </dd>
  720. <dt class="field-odd">Return type</dt>
  721. <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>
  722. </dd>
  723. </dl>
  724. <div class="admonition note">
  725. <p class="admonition-title">Note</p>
  726. <p>If a parameter or buffer is registered as <code class="docutils literal notranslate"><span class="pre">None</span></code> and its corresponding key
  727. exists in <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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.distributional.normal.MultiVariateNormalMLP.load_state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.load_state_dict"><code class="xref py py-meth docutils literal notranslate"><span class="pre">load_state_dict()</span></code></a> will raise a
  728. <code class="docutils literal notranslate"><span class="pre">RuntimeError</span></code>.</p>
  729. </div>
  730. </dd></dl>
  731. <dl class="py method">
  732. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.modules">
  733. <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.distributional.normal.MultiVariateNormalMLP.modules" title="Permalink to this definition">¶</a></dt>
  734. <dd><p>Returns an iterator over all modules in the network.</p>
  735. <dl class="field-list simple">
  736. <dt class="field-odd">Yields</dt>
  737. <dd class="field-odd"><p><em>Module</em> – a module in the network</p>
  738. </dd>
  739. </dl>
  740. <div class="admonition note">
  741. <p class="admonition-title">Note</p>
  742. <p>Duplicate modules are returned only once. In the following
  743. example, <code class="docutils literal notranslate"><span class="pre">l</span></code> will be returned only once.</p>
  744. </div>
  745. <p>Example:</p>
  746. <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>
  747. <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>
  748. <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>
  749. <span class="go"> print(idx, &#39;-&gt;&#39;, m)</span>
  750. <span class="go">0 -&gt; Sequential(</span>
  751. <span class="go"> (0): Linear(in_features=2, out_features=2, bias=True)</span>
  752. <span class="go"> (1): Linear(in_features=2, out_features=2, bias=True)</span>
  753. <span class="go">)</span>
  754. <span class="go">1 -&gt; Linear(in_features=2, out_features=2, bias=True)</span>
  755. </pre></div>
  756. </div>
  757. </dd></dl>
  758. <dl class="py method">
  759. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_buffers">
  760. <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.distributional.normal.MultiVariateNormalMLP.named_buffers" title="Permalink to this definition">¶</a></dt>
  761. <dd><p>Returns an iterator over module buffers, yielding both the
  762. name of the buffer as well as the buffer itself.</p>
  763. <dl class="field-list simple">
  764. <dt class="field-odd">Parameters</dt>
  765. <dd class="field-odd"><ul class="simple">
  766. <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>
  767. <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
  768. and all submodules. Otherwise, yields only buffers that
  769. are direct members of this module.</p></li>
  770. </ul>
  771. </dd>
  772. <dt class="field-even">Yields</dt>
  773. <dd class="field-even"><p><em>(string, torch.Tensor)</em> – Tuple containing the name and buffer</p>
  774. </dd>
  775. </dl>
  776. <p>Example:</p>
  777. <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>
  778. <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>
  779. <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>
  780. </pre></div>
  781. </div>
  782. </dd></dl>
  783. <dl class="py method">
  784. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_children">
  785. <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.distributional.normal.MultiVariateNormalMLP.named_children" title="Permalink to this definition">¶</a></dt>
  786. <dd><p>Returns an iterator over immediate children modules, yielding both
  787. the name of the module as well as the module itself.</p>
  788. <dl class="field-list simple">
  789. <dt class="field-odd">Yields</dt>
  790. <dd class="field-odd"><p><em>(string, Module)</em> – Tuple containing a name and child module</p>
  791. </dd>
  792. </dl>
  793. <p>Example:</p>
  794. <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>
  795. <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>
  796. <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>
  797. </pre></div>
  798. </div>
  799. </dd></dl>
  800. <dl class="py method">
  801. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_modules">
  802. <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.distributional.normal.MultiVariateNormalMLP.named_modules" title="Permalink to this definition">¶</a></dt>
  803. <dd><p>Returns an iterator over all modules in the network, yielding
  804. both the name of the module as well as the module itself.</p>
  805. <dl class="field-list simple">
  806. <dt class="field-odd">Parameters</dt>
  807. <dd class="field-odd"><ul class="simple">
  808. <li><p><strong>memo</strong> – a memo to store the set of modules already added to the result</p></li>
  809. <li><p><strong>prefix</strong> – a prefix that will be added to the name of the module</p></li>
  810. <li><p><strong>remove_duplicate</strong> – whether to remove the duplicated module instances in the result
  811. or not</p></li>
  812. </ul>
  813. </dd>
  814. <dt class="field-even">Yields</dt>
  815. <dd class="field-even"><p><em>(string, Module)</em> – Tuple of name and module</p>
  816. </dd>
  817. </dl>
  818. <div class="admonition note">
  819. <p class="admonition-title">Note</p>
  820. <p>Duplicate modules are returned only once. In the following
  821. example, <code class="docutils literal notranslate"><span class="pre">l</span></code> will be returned only once.</p>
  822. </div>
  823. <p>Example:</p>
  824. <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>
  825. <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>
  826. <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>
  827. <span class="go"> print(idx, &#39;-&gt;&#39;, m)</span>
  828. <span class="go">0 -&gt; (&#39;&#39;, Sequential(</span>
  829. <span class="go"> (0): Linear(in_features=2, out_features=2, bias=True)</span>
  830. <span class="go"> (1): Linear(in_features=2, out_features=2, bias=True)</span>
  831. <span class="go">))</span>
  832. <span class="go">1 -&gt; (&#39;0&#39;, Linear(in_features=2, out_features=2, bias=True))</span>
  833. </pre></div>
  834. </div>
  835. </dd></dl>
  836. <dl class="py method">
  837. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.named_parameters">
  838. <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.distributional.normal.MultiVariateNormalMLP.named_parameters" title="Permalink to this definition">¶</a></dt>
  839. <dd><p>Returns an iterator over module parameters, yielding both the
  840. name of the parameter as well as the parameter itself.</p>
  841. <dl class="field-list simple">
  842. <dt class="field-odd">Parameters</dt>
  843. <dd class="field-odd"><ul class="simple">
  844. <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>
  845. <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
  846. and all submodules. Otherwise, yields only parameters that
  847. are direct members of this module.</p></li>
  848. </ul>
  849. </dd>
  850. <dt class="field-even">Yields</dt>
  851. <dd class="field-even"><p><em>(string, Parameter)</em> – Tuple containing the name and parameter</p>
  852. </dd>
  853. </dl>
  854. <p>Example:</p>
  855. <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>
  856. <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>
  857. <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>
  858. </pre></div>
  859. </div>
  860. </dd></dl>
  861. <dl class="py property">
  862. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.output_shape">
  863. <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.distributional.normal.MultiVariateNormalMLP.output_shape" title="Permalink to this definition">¶</a></dt>
  864. <dd><p>return:
  865. :rtype:</p>
  866. </dd></dl>
  867. <dl class="py method">
  868. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.parameters">
  869. <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.distributional.normal.MultiVariateNormalMLP.parameters" title="Permalink to this definition">¶</a></dt>
  870. <dd><p>Returns an iterator over module parameters.</p>
  871. <p>This is typically passed to an optimizer.</p>
  872. <dl class="field-list simple">
  873. <dt class="field-odd">Parameters</dt>
  874. <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
  875. and all submodules. Otherwise, yields only parameters that
  876. are direct members of this module.</p>
  877. </dd>
  878. <dt class="field-even">Yields</dt>
  879. <dd class="field-even"><p><em>Parameter</em> – module parameter</p>
  880. </dd>
  881. </dl>
  882. <p>Example:</p>
  883. <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>
  884. <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>
  885. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L,)</span>
  886. <span class="go">&lt;class &#39;torch.Tensor&#39;&gt; (20L, 1L, 5L, 5L)</span>
  887. </pre></div>
  888. </div>
  889. </dd></dl>
  890. <dl class="py method">
  891. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_backward_hook">
  892. <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.distributional.normal.MultiVariateNormalMLP.register_backward_hook" title="Permalink to this definition">¶</a></dt>
  893. <dd><p>Registers a backward hook on the module.</p>
  894. <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
  895. the behavior of this function will change in future versions.</p>
  896. <dl class="field-list simple">
  897. <dt class="field-odd">Returns</dt>
  898. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
  899. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
  900. </dd>
  901. <dt class="field-even">Return type</dt>
  902. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
  903. </dd>
  904. </dl>
  905. </dd></dl>
  906. <dl class="py method">
  907. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_buffer">
  908. <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.distributional.normal.MultiVariateNormalMLP.register_buffer" title="Permalink to this definition">¶</a></dt>
  909. <dd><p>Adds a buffer to the module.</p>
  910. <p>This is typically used to register a buffer that should not to be
  911. considered a model parameter. For example, BatchNorm’s <code class="docutils literal notranslate"><span class="pre">running_mean</span></code>
  912. is not a parameter, but is part of the module’s state. Buffers, by
  913. default, are persistent and will be saved alongside parameters. This
  914. 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
  915. only difference between a persistent buffer and a non-persistent buffer
  916. is that the latter will not be a part of this module’s
  917. <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p>
  918. <p>Buffers can be accessed as attributes using given names.</p>
  919. <dl class="field-list simple">
  920. <dt class="field-odd">Parameters</dt>
  921. <dd class="field-odd"><ul class="simple">
  922. <li><p><strong>name</strong> (<em>string</em>) – name of the buffer. The buffer can be accessed
  923. from this module using the given name</p></li>
  924. <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
  925. that run on buffers, such as <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cuda" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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>,
  926. the buffer is <strong>not</strong> included in the module’s <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p></li>
  927. <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
  928. <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p></li>
  929. </ul>
  930. </dd>
  931. </dl>
  932. <p>Example:</p>
  933. <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>
  934. </pre></div>
  935. </div>
  936. </dd></dl>
  937. <dl class="py method">
  938. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_forward_hook">
  939. <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.distributional.normal.MultiVariateNormalMLP.register_forward_hook" title="Permalink to this definition">¶</a></dt>
  940. <dd><p>Registers a forward hook on the module.</p>
  941. <p>The hook will be called every time after <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward"><code class="xref py py-func docutils literal notranslate"><span class="pre">forward()</span></code></a> has computed an output.
  942. It should have the following signature:</p>
  943. <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>
  944. </pre></div>
  945. </div>
  946. <p>The input contains only the positional arguments given to the module.
  947. Keyword arguments won’t be passed to the hooks and only to the <code class="docutils literal notranslate"><span class="pre">forward</span></code>.
  948. The hook can modify the output. It can modify the input inplace but
  949. it will not have effect on forward since this is called after
  950. <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward"><code class="xref py py-func docutils literal notranslate"><span class="pre">forward()</span></code></a> is called.</p>
  951. <dl class="field-list simple">
  952. <dt class="field-odd">Returns</dt>
  953. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
  954. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
  955. </dd>
  956. <dt class="field-even">Return type</dt>
  957. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
  958. </dd>
  959. </dl>
  960. </dd></dl>
  961. <dl class="py method">
  962. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_forward_pre_hook">
  963. <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.distributional.normal.MultiVariateNormalMLP.register_forward_pre_hook" title="Permalink to this definition">¶</a></dt>
  964. <dd><p>Registers a forward pre-hook on the module.</p>
  965. <p>The hook will be called every time before <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.forward"><code class="xref py py-func docutils literal notranslate"><span class="pre">forward()</span></code></a> is invoked.
  966. It should have the following signature:</p>
  967. <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>
  968. </pre></div>
  969. </div>
  970. <p>The input contains only the positional arguments given to the module.
  971. Keyword arguments won’t be passed to the hooks and only to the <code class="docutils literal notranslate"><span class="pre">forward</span></code>.
  972. The hook can modify the input. User can either return a tuple or a
  973. single modified value in the hook. We will wrap the value into a tuple
  974. if a single value is returned(unless that value is already a tuple).</p>
  975. <dl class="field-list simple">
  976. <dt class="field-odd">Returns</dt>
  977. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
  978. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
  979. </dd>
  980. <dt class="field-even">Return type</dt>
  981. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
  982. </dd>
  983. </dl>
  984. </dd></dl>
  985. <dl class="py method">
  986. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_full_backward_hook">
  987. <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.distributional.normal.MultiVariateNormalMLP.register_full_backward_hook" title="Permalink to this definition">¶</a></dt>
  988. <dd><p>Registers a backward hook on the module.</p>
  989. <p>The hook will be called every time the gradients with respect to module
  990. inputs are computed. The hook should have the following signature:</p>
  991. <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>
  992. </pre></div>
  993. </div>
  994. <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
  995. with respect to the inputs and outputs respectively. The hook should
  996. not modify its arguments, but it can optionally return a new gradient with
  997. 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
  998. 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
  999. as positional arguments and all kwarg arguments are ignored. Entries
  1000. 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
  1001. arguments.</p>
  1002. <p>For technical reasons, when this hook is applied to a Module, its forward function will
  1003. receive a view of each Tensor passed to the Module. Similarly the caller will receive a view
  1004. of each Tensor returned by the Module’s forward function.</p>
  1005. <div class="admonition warning">
  1006. <p class="admonition-title">Warning</p>
  1007. <p>Modifying inputs or outputs inplace is not allowed when using backward hooks and
  1008. will raise an error.</p>
  1009. </div>
  1010. <dl class="field-list simple">
  1011. <dt class="field-odd">Returns</dt>
  1012. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
  1013. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
  1014. </dd>
  1015. <dt class="field-even">Return type</dt>
  1016. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
  1017. </dd>
  1018. </dl>
  1019. </dd></dl>
  1020. <dl class="py method">
  1021. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_load_state_dict_post_hook">
  1022. <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.distributional.normal.MultiVariateNormalMLP.register_load_state_dict_post_hook" title="Permalink to this definition">¶</a></dt>
  1023. <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>
  1024. is called.</p>
  1025. <dl class="simple">
  1026. <dt>It should have the following signature::</dt><dd><p>hook(module, incompatible_keys) -&gt; None</p>
  1027. </dd>
  1028. </dl>
  1029. <p>The <code class="docutils literal notranslate"><span class="pre">module</span></code> argument is the current module that this hook is registered
  1030. 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
  1031. 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>
  1032. 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
  1033. <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>
  1034. <p>The given incompatible_keys can be modified inplace if needed.</p>
  1035. <p>Note that the checks performed when calling <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.load_state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.load_state_dict"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_state_dict()</span></code></a> with
  1036. <code class="docutils literal notranslate"><span class="pre">strict=True</span></code> are affected by modifications the hook makes to
  1037. <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
  1038. set of keys will result in an error being thrown when <code class="docutils literal notranslate"><span class="pre">strict=True</span></code>, and
  1039. clearning out both missing and unexpected keys will avoid an error.</p>
  1040. <dl class="field-list simple">
  1041. <dt class="field-odd">Returns</dt>
  1042. <dd class="field-odd"><p>a handle that can be used to remove the added hook by calling
  1043. <code class="docutils literal notranslate"><span class="pre">handle.remove()</span></code></p>
  1044. </dd>
  1045. <dt class="field-even">Return type</dt>
  1046. <dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">torch.utils.hooks.RemovableHandle</span></code></p>
  1047. </dd>
  1048. </dl>
  1049. </dd></dl>
  1050. <dl class="py method">
  1051. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_module">
  1052. <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.distributional.normal.MultiVariateNormalMLP.register_module" title="Permalink to this definition">¶</a></dt>
  1053. <dd><p>Alias for <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.add_module" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.add_module"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_module()</span></code></a>.</p>
  1054. </dd></dl>
  1055. <dl class="py method">
  1056. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.register_parameter">
  1057. <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.distributional.normal.MultiVariateNormalMLP.register_parameter" title="Permalink to this definition">¶</a></dt>
  1058. <dd><p>Adds a parameter to the module.</p>
  1059. <p>The parameter can be accessed as an attribute using given name.</p>
  1060. <dl class="field-list simple">
  1061. <dt class="field-odd">Parameters</dt>
  1062. <dd class="field-odd"><ul class="simple">
  1063. <li><p><strong>name</strong> (<em>string</em>) – name of the parameter. The parameter can be accessed
  1064. from this module using the given name</p></li>
  1065. <li><p><strong>param</strong> (<em>Parameter</em><em> or </em><em>None</em>) – parameter to be added to the module. If
  1066. <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.distributional.normal.MultiVariateNormalMLP.cuda" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.cuda"><code class="xref py py-attr docutils literal notranslate"><span class="pre">cuda</span></code></a>,
  1067. are ignored. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the parameter is <strong>not</strong> included in the
  1068. module’s <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict"><code class="xref py py-attr docutils literal notranslate"><span class="pre">state_dict</span></code></a>.</p></li>
  1069. </ul>
  1070. </dd>
  1071. </dl>
  1072. </dd></dl>
  1073. <dl class="py method">
  1074. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.requires_grad_">
  1075. <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.distributional.normal.MultiVariateNormalMLP.requires_grad_" title="Permalink to this definition">¶</a></dt>
  1076. <dd><p>Change if autograd should record operations on parameters in this
  1077. module.</p>
  1078. <p>This method sets the parameters’ <code class="xref py py-attr docutils literal notranslate"><span class="pre">requires_grad</span></code> attributes
  1079. in-place.</p>
  1080. <p>This method is helpful for freezing part of the module for finetuning
  1081. or training parts of a model individually (e.g., GAN training).</p>
  1082. <p>See <span class="xref std std-ref">locally-disable-grad-doc</span> for a comparison between
  1083. <cite>.requires_grad_()</cite> and several similar mechanisms that may be confused with it.</p>
  1084. <dl class="field-list simple">
  1085. <dt class="field-odd">Parameters</dt>
  1086. <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
  1087. parameters in this module. Default: <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
  1088. </dd>
  1089. <dt class="field-even">Returns</dt>
  1090. <dd class="field-even"><p>self</p>
  1091. </dd>
  1092. <dt class="field-odd">Return type</dt>
  1093. <dd class="field-odd"><p>Module</p>
  1094. </dd>
  1095. </dl>
  1096. </dd></dl>
  1097. <dl class="py method">
  1098. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.sample_input">
  1099. <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="headerlink" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.sample_input" title="Permalink to this definition">¶</a></dt>
  1100. <dd><dl class="field-list simple">
  1101. <dt class="field-odd">Returns</dt>
  1102. <dd class="field-odd"><p></p>
  1103. </dd>
  1104. <dt class="field-even">Return type</dt>
  1105. <dd class="field-even"><p></p>
  1106. </dd>
  1107. </dl>
  1108. </dd></dl>
  1109. <dl class="py method">
  1110. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.set_extra_state">
  1111. <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.distributional.normal.MultiVariateNormalMLP.set_extra_state" title="Permalink to this definition">¶</a></dt>
  1112. <dd><p>This function is called from <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.load_state_dict" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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
  1113. found within the <cite>state_dict</cite>. Implement this function and a corresponding
  1114. <a class="reference internal" href="#draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.get_extra_state" title="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.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
  1115. <cite>state_dict</cite>.</p>
  1116. <dl class="field-list simple">
  1117. <dt class="field-odd">Parameters</dt>
  1118. <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>
  1119. </dd>
  1120. </dl>
  1121. </dd></dl>
  1122. <dl class="py method">
  1123. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.share_memory">
  1124. <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.distributional.normal.MultiVariateNormalMLP.share_memory" title="Permalink to this definition">¶</a></dt>
  1125. <dd><p>See <code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.Tensor.share_memory_()</span></code></p>
  1126. </dd></dl>
  1127. <dl class="py method">
  1128. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.state_dict">
  1129. <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.distributional.normal.MultiVariateNormalMLP.state_dict" title="Permalink to this definition">¶</a></dt>
  1130. <dd><p>Returns a dictionary containing a whole state of the module.</p>
  1131. <p>Both parameters and persistent buffers (e.g. running averages) are
  1132. included. Keys are corresponding parameter and buffer names.
  1133. Parameters and buffers set to <code class="docutils literal notranslate"><span class="pre">None</span></code> are not included.</p>
  1134. <div class="admonition warning">
  1135. <p class="admonition-title">Warning</p>
  1136. <p>Currently <code class="docutils literal notranslate"><span class="pre">state_dict()</span></code> also accepts positional arguments for
  1137. <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,
  1138. this is being deprecated and keyword arguments will be enforced in
  1139. future releases.</p>
  1140. </div>
  1141. <div class="admonition warning">
  1142. <p class="admonition-title">Warning</p>
  1143. <p>Please avoid the use of argument <code class="docutils literal notranslate"><span class="pre">destination</span></code> as it is not
  1144. designed for end-users.</p>
  1145. </div>
  1146. <dl class="field-list simple">
  1147. <dt class="field-odd">Parameters</dt>
  1148. <dd class="field-odd"><ul class="simple">
  1149. <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
  1150. be updated into the dict and the same object is returned.
  1151. Otherwise, an <code class="docutils literal notranslate"><span class="pre">OrderedDict</span></code> will be created and returned.
  1152. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p></li>
  1153. <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
  1154. names to compose the keys in state_dict. Default: <code class="docutils literal notranslate"><span class="pre">''</span></code>.</p></li>
  1155. <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
  1156. returned in the state dict are detached from autograd. If it’s
  1157. set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, detaching will not be performed.
  1158. Default: <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
  1159. </ul>
  1160. </dd>
  1161. <dt class="field-even">Returns</dt>
  1162. <dd class="field-even"><p>a dictionary containing a whole state of the module</p>
  1163. </dd>
  1164. <dt class="field-odd">Return type</dt>
  1165. <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>
  1166. </dd>
  1167. </dl>
  1168. <p>Example:</p>
  1169. <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>
  1170. <span class="go">[&#39;bias&#39;, &#39;weight&#39;]</span>
  1171. </pre></div>
  1172. </div>
  1173. </dd></dl>
  1174. <dl class="py method">
  1175. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.to">
  1176. <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.distributional.normal.MultiVariateNormalMLP.to" title="Permalink to this definition">¶</a></dt>
  1177. <dd><p>Moves and/or casts the parameters and buffers.</p>
  1178. <p>This can be called as</p>
  1179. <dl class="py function">
  1180. <dt class="sig sig-object py">
  1181. <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>
  1182. <dd></dd></dl>
  1183. <dl class="py function">
  1184. <dt class="sig sig-object py">
  1185. <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>
  1186. <dd></dd></dl>
  1187. <dl class="py function">
  1188. <dt class="sig sig-object py">
  1189. <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>
  1190. <dd></dd></dl>
  1191. <dl class="py function">
  1192. <dt class="sig sig-object py">
  1193. <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>
  1194. <dd></dd></dl>
  1195. <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
  1196. 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
  1197. 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>
  1198. (if given). The integral parameters and buffers will be moved
  1199. <code class="xref py py-attr docutils literal notranslate"><span class="pre">device</span></code>, if that is given, but with dtypes unchanged. When
  1200. <code class="xref py py-attr docutils literal notranslate"><span class="pre">non_blocking</span></code> is set, it tries to convert/move asynchronously
  1201. with respect to the host if possible, e.g., moving CPU Tensors with
  1202. pinned memory to CUDA devices.</p>
  1203. <p>See below for examples.</p>
  1204. <div class="admonition note">
  1205. <p class="admonition-title">Note</p>
  1206. <p>This method modifies the module in-place.</p>
  1207. </div>
  1208. <dl class="field-list simple">
  1209. <dt class="field-odd">Parameters</dt>
  1210. <dd class="field-odd"><ul class="simple">
  1211. <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
  1212. and buffers in this module</p></li>
  1213. <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
  1214. the parameters and buffers in this module</p></li>
  1215. <li><p><strong>tensor</strong> (<em>torch.Tensor</em>) – Tensor whose dtype and device are the desired
  1216. dtype and device for all parameters and buffers in this module</p></li>
  1217. <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
  1218. format for 4D parameters and buffers in this module (keyword
  1219. only argument)</p></li>
  1220. </ul>
  1221. </dd>
  1222. <dt class="field-even">Returns</dt>
  1223. <dd class="field-even"><p>self</p>
  1224. </dd>
  1225. <dt class="field-odd">Return type</dt>
  1226. <dd class="field-odd"><p>Module</p>
  1227. </dd>
  1228. </dl>
  1229. <p>Examples:</p>
  1230. <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>
  1231. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
  1232. <span class="go">Parameter containing:</span>
  1233. <span class="go">tensor([[ 0.1913, -0.3420],</span>
  1234. <span class="go"> [-0.5113, -0.2325]])</span>
  1235. <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>
  1236. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
  1237. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
  1238. <span class="go">Parameter containing:</span>
  1239. <span class="go">tensor([[ 0.1913, -0.3420],</span>
  1240. <span class="go"> [-0.5113, -0.2325]], dtype=torch.float64)</span>
  1241. <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>
  1242. <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>
  1243. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
  1244. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
  1245. <span class="go">Parameter containing:</span>
  1246. <span class="go">tensor([[ 0.1914, -0.3420],</span>
  1247. <span class="go"> [-0.5112, -0.2324]], dtype=torch.float16, device=&#39;cuda:1&#39;)</span>
  1248. <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>
  1249. <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>
  1250. <span class="go">Linear(in_features=2, out_features=2, bias=True)</span>
  1251. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
  1252. <span class="go">Parameter containing:</span>
  1253. <span class="go">tensor([[ 0.1914, -0.3420],</span>
  1254. <span class="go"> [-0.5112, -0.2324]], dtype=torch.float16)</span>
  1255. <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>
  1256. <span class="gp">&gt;&gt;&gt; </span><span class="n">linear</span><span class="o">.</span><span class="n">weight</span>
  1257. <span class="go">Parameter containing:</span>
  1258. <span class="go">tensor([[ 0.3741+0.j, 0.2382+0.j],</span>
  1259. <span class="go"> [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)</span>
  1260. <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>
  1261. <span class="go">tensor([[0.6122+0.j, 0.1150+0.j],</span>
  1262. <span class="go"> [0.6122+0.j, 0.1150+0.j],</span>
  1263. <span class="go"> [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)</span>
  1264. </pre></div>
  1265. </div>
  1266. </dd></dl>
  1267. <dl class="py method">
  1268. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.to_empty">
  1269. <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.distributional.normal.MultiVariateNormalMLP.to_empty" title="Permalink to this definition">¶</a></dt>
  1270. <dd><p>Moves the parameters and buffers to the specified device without copying storage.</p>
  1271. <dl class="field-list simple">
  1272. <dt class="field-odd">Parameters</dt>
  1273. <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
  1274. and buffers in this module.</p>
  1275. </dd>
  1276. <dt class="field-even">Returns</dt>
  1277. <dd class="field-even"><p>self</p>
  1278. </dd>
  1279. <dt class="field-odd">Return type</dt>
  1280. <dd class="field-odd"><p>Module</p>
  1281. </dd>
  1282. </dl>
  1283. </dd></dl>
  1284. <dl class="py method">
  1285. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.train">
  1286. <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.distributional.normal.MultiVariateNormalMLP.train" title="Permalink to this definition">¶</a></dt>
  1287. <dd><p>Sets the module in training mode.</p>
  1288. <p>This has any effect only on certain modules. See documentations of
  1289. particular modules for details of their behaviors in training/evaluation
  1290. 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>,
  1291. etc.</p>
  1292. <dl class="field-list simple">
  1293. <dt class="field-odd">Parameters</dt>
  1294. <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
  1295. 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>
  1296. </dd>
  1297. <dt class="field-even">Returns</dt>
  1298. <dd class="field-even"><p>self</p>
  1299. </dd>
  1300. <dt class="field-odd">Return type</dt>
  1301. <dd class="field-odd"><p>Module</p>
  1302. </dd>
  1303. </dl>
  1304. </dd></dl>
  1305. <dl class="py method">
  1306. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.type">
  1307. <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.distributional.normal.MultiVariateNormalMLP.type" title="Permalink to this definition">¶</a></dt>
  1308. <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>
  1309. <div class="admonition note">
  1310. <p class="admonition-title">Note</p>
  1311. <p>This method modifies the module in-place.</p>
  1312. </div>
  1313. <dl class="field-list simple">
  1314. <dt class="field-odd">Parameters</dt>
  1315. <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>
  1316. </dd>
  1317. <dt class="field-even">Returns</dt>
  1318. <dd class="field-even"><p>self</p>
  1319. </dd>
  1320. <dt class="field-odd">Return type</dt>
  1321. <dd class="field-odd"><p>Module</p>
  1322. </dd>
  1323. </dl>
  1324. </dd></dl>
  1325. <dl class="py method">
  1326. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.xpu">
  1327. <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.distributional.normal.MultiVariateNormalMLP.xpu" title="Permalink to this definition">¶</a></dt>
  1328. <dd><p>Moves all model parameters and buffers to the XPU.</p>
  1329. <p>This also makes associated parameters and buffers different objects. So
  1330. it should be called before constructing optimizer if the module will
  1331. live on XPU while being optimized.</p>
  1332. <div class="admonition note">
  1333. <p class="admonition-title">Note</p>
  1334. <p>This method modifies the module in-place.</p>
  1335. </div>
  1336. <dl class="field-list simple">
  1337. <dt class="field-odd">Parameters</dt>
  1338. <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
  1339. copied to that device</p>
  1340. </dd>
  1341. <dt class="field-even">Returns</dt>
  1342. <dd class="field-even"><p>self</p>
  1343. </dd>
  1344. <dt class="field-odd">Return type</dt>
  1345. <dd class="field-odd"><p>Module</p>
  1346. </dd>
  1347. </dl>
  1348. </dd></dl>
  1349. <dl class="py method">
  1350. <dt class="sig sig-object py" id="draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.zero_grad">
  1351. <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.distributional.normal.MultiVariateNormalMLP.zero_grad" title="Permalink to this definition">¶</a></dt>
  1352. <dd><p>Sets gradients of all model parameters to zero. See similar function
  1353. under <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.optim.Optimizer</span></code> for more context.</p>
  1354. <dl class="field-list simple">
  1355. <dt class="field-odd">Parameters</dt>
  1356. <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.
  1357. See <code class="xref py py-meth docutils literal notranslate"><span class="pre">torch.optim.Optimizer.zero_grad()</span></code> for details.</p>
  1358. </dd>
  1359. </dl>
  1360. </dd></dl>
  1361. </dd></dl>
  1362. </section>
  1363. </div>
  1364. </div>
  1365. </div>
  1366. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  1367. <div class="sphinxsidebarwrapper">
  1368. <p class="logo"><a href="../index.html">
  1369. <img class="logo" src="../_static/valknut.svg" alt="Logo"/>
  1370. </a></p>
  1371. <h1 class="logo"><a href="../index.html">Draugr</a></h1>
  1372. <h3>Navigation</h3>
  1373. <ul class="current">
  1374. <li class="toctree-l1 current"><a class="reference internal" href="draugr.html">draugr</a><ul class="current">
  1375. <li class="toctree-l2"><a class="reference internal" href="draugr.dist_is_editable.html">draugr.dist_is_editable</a></li>
  1376. <li class="toctree-l2"><a class="reference internal" href="draugr.get_version.html">draugr.get_version</a></li>
  1377. <li class="toctree-l2"><a class="reference internal" href="draugr.dlib_utilities.html">draugr.dlib_utilities</a></li>
  1378. <li class="toctree-l2"><a class="reference internal" href="draugr.drawers.html">draugr.drawers</a></li>
  1379. <li class="toctree-l2"><a class="reference internal" href="draugr.entry_points.html">draugr.entry_points</a></li>
  1380. <li class="toctree-l2"><a class="reference internal" href="draugr.extensions.html">draugr.extensions</a></li>
  1381. <li class="toctree-l2"><a class="reference internal" href="draugr.ffmpeg_utilities.html">draugr.ffmpeg_utilities</a></li>
  1382. <li class="toctree-l2"><a class="reference internal" href="draugr.jax_utilities.html">draugr.jax_utilities</a></li>
  1383. <li class="toctree-l2"><a class="reference internal" href="draugr.metrics.html">draugr.metrics</a></li>
  1384. <li class="toctree-l2"><a class="reference internal" href="draugr.multiprocessing_utilities.html">draugr.multiprocessing_utilities</a></li>
  1385. <li class="toctree-l2"><a class="reference internal" href="draugr.numpy_utilities.html">draugr.numpy_utilities</a></li>
  1386. <li class="toctree-l2"><a class="reference internal" href="draugr.opencv_utilities.html">draugr.opencv_utilities</a></li>
  1387. <li class="toctree-l2"><a class="reference internal" href="draugr.os_utilities.html">draugr.os_utilities</a></li>
  1388. <li class="toctree-l2"><a class="reference internal" href="draugr.pandas_utilities.html">draugr.pandas_utilities</a></li>
  1389. <li class="toctree-l2"><a class="reference internal" href="draugr.pygame_utilities.html">draugr.pygame_utilities</a></li>
  1390. <li class="toctree-l2"><a class="reference internal" href="draugr.python_utilities.html">draugr.python_utilities</a></li>
  1391. <li class="toctree-l2"><a class="reference internal" href="draugr.random_utilities.html">draugr.random_utilities</a></li>
  1392. <li class="toctree-l2"><a class="reference internal" href="draugr.scipy_utilities.html">draugr.scipy_utilities</a></li>
  1393. <li class="toctree-l2"><a class="reference internal" href="draugr.stopping.html">draugr.stopping</a></li>
  1394. <li class="toctree-l2"><a class="reference internal" href="draugr.tensorboard_utilities.html">draugr.tensorboard_utilities</a></li>
  1395. <li class="toctree-l2"><a class="reference internal" href="draugr.threading_utilities.html">draugr.threading_utilities</a></li>
  1396. <li class="toctree-l2 current"><a class="reference internal" href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul class="current">
  1397. <li class="toctree-l3 current"><a class="reference internal" href="draugr.torch_utilities.architectures.html">draugr.torch_utilities.architectures</a><ul class="current">
  1398. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.architecture.html">draugr.torch_utilities.architectures.architecture</a></li>
  1399. <li class="toctree-l4 current"><a class="reference internal" href="draugr.torch_utilities.architectures.distributional.html">draugr.torch_utilities.architectures.distributional</a><ul class="current">
  1400. <li class="toctree-l5"><a class="reference internal" href="draugr.torch_utilities.architectures.distributional.categorical.html">draugr.torch_utilities.architectures.distributional.categorical</a></li>
  1401. <li class="toctree-l5 current"><a class="reference internal" href="draugr.torch_utilities.architectures.distributional.normal.html">draugr.torch_utilities.architectures.distributional.normal</a><ul class="current">
  1402. <li class="toctree-l6"><a class="reference internal" href="draugr.torch_utilities.architectures.distributional.normal.ShallowStdNormalMLP.html">draugr.torch_utilities.architectures.distributional.normal.ShallowStdNormalMLP</a></li>
  1403. <li class="toctree-l6"><a class="reference internal" href="draugr.torch_utilities.architectures.distributional.normal.MultiDimensionalNormalMLP.html">draugr.torch_utilities.architectures.distributional.normal.MultiDimensionalNormalMLP</a></li>
  1404. <li class="toctree-l6 current"><a class="current reference internal" href="#">draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP</a></li>
  1405. <li class="toctree-l6"><a class="reference internal" href="draugr.torch_utilities.architectures.distributional.normal.MultipleNormalMLP.html">draugr.torch_utilities.architectures.distributional.normal.MultipleNormalMLP</a></li>
  1406. </ul>
  1407. </li>
  1408. </ul>
  1409. </li>
  1410. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.experimental.html">draugr.torch_utilities.architectures.experimental</a></li>
  1411. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.mlp.html">draugr.torch_utilities.architectures.mlp</a></li>
  1412. <li class="toctree-l4"><a class="reference internal" href="draugr.torch_utilities.architectures.mlp_variants.html">draugr.torch_utilities.architectures.mlp_variants</a></li>
  1413. </ul>
  1414. </li>
  1415. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.datasets.html">draugr.torch_utilities.datasets</a></li>
  1416. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.distributions.html">draugr.torch_utilities.distributions</a></li>
  1417. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.evaluation.html">draugr.torch_utilities.evaluation</a></li>
  1418. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.exporting.html">draugr.torch_utilities.exporting</a></li>
  1419. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.generators.html">draugr.torch_utilities.generators</a></li>
  1420. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.images.html">draugr.torch_utilities.images</a></li>
  1421. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.opencv.html">draugr.torch_utilities.opencv</a></li>
  1422. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.operations.html">draugr.torch_utilities.operations</a></li>
  1423. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.optimisation.html">draugr.torch_utilities.optimisation</a></li>
  1424. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.persistence.html">draugr.torch_utilities.persistence</a></li>
  1425. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.sessions.html">draugr.torch_utilities.sessions</a></li>
  1426. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.system.html">draugr.torch_utilities.system</a></li>
  1427. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.tensors.html">draugr.torch_utilities.tensors</a></li>
  1428. <li class="toctree-l3"><a class="reference internal" href="draugr.torch_utilities.writers.html">draugr.torch_utilities.writers</a></li>
  1429. </ul>
  1430. </li>
  1431. <li class="toctree-l2"><a class="reference internal" href="draugr.tqdm_utilities.html">draugr.tqdm_utilities</a></li>
  1432. <li class="toctree-l2"><a class="reference internal" href="draugr.visualisation.html">draugr.visualisation</a></li>
  1433. <li class="toctree-l2"><a class="reference internal" href="draugr.writers.html">draugr.writers</a></li>
  1434. </ul>
  1435. </li>
  1436. </ul>
  1437. <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
  1438. <ul>
  1439. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
  1440. </ul>
  1441. <div class="relations">
  1442. <h3>Related Topics</h3>
  1443. <ul>
  1444. <li><a href="../index.html">Documentation overview</a><ul>
  1445. <li><a href="draugr.html">draugr</a><ul>
  1446. <li><a href="draugr.torch_utilities.html">draugr.torch_utilities</a><ul>
  1447. <li><a href="draugr.torch_utilities.architectures.html">draugr.torch_utilities.architectures</a><ul>
  1448. <li><a href="draugr.torch_utilities.architectures.distributional.html">draugr.torch_utilities.architectures.distributional</a><ul>
  1449. <li><a href="draugr.torch_utilities.architectures.distributional.normal.html">draugr.torch_utilities.architectures.distributional.normal</a><ul>
  1450. <li>Previous: <a href="draugr.torch_utilities.architectures.distributional.normal.MultiDimensionalNormalMLP.html" title="previous chapter">draugr.torch_utilities.architectures.distributional.normal.MultiDimensionalNormalMLP</a></li>
  1451. <li>Next: <a href="draugr.torch_utilities.architectures.distributional.normal.MultipleNormalMLP.html" title="next chapter">draugr.torch_utilities.architectures.distributional.normal.MultipleNormalMLP</a></li>
  1452. </ul></li>
  1453. </ul></li>
  1454. </ul></li>
  1455. </ul></li>
  1456. </ul></li>
  1457. </ul></li>
  1458. </ul>
  1459. </div>
  1460. <div id="searchbox" style="display: none" role="search">
  1461. <h3 id="searchlabel">Quick search</h3>
  1462. <div class="searchformwrapper">
  1463. <form class="search" action="../search.html" method="get">
  1464. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  1465. <input type="submit" value="Go" />
  1466. </form>
  1467. </div>
  1468. </div>
  1469. <script>document.getElementById('searchbox').style.display = "block"</script>
  1470. </div>
  1471. </div>
  1472. <div class="clearer"></div>
  1473. </div>
  1474. <div class="footer">
  1475. &copy;.
  1476. |
  1477. Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
  1478. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
  1479. |
  1480. <a href="../_sources/generated/draugr.torch_utilities.architectures.distributional.normal.MultiVariateNormalMLP.rst.txt"
  1481. rel="nofollow">Page source</a>
  1482. </div>
  1483. </body>
  1484. </html>