Skip to content

Commit dcd6ef0

Browse files
committed
update docs
1 parent 99b3fd5 commit dcd6ef0

276 files changed

Lines changed: 9719 additions & 505 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_modules/parametricmatrixmodels/model.html

Lines changed: 48 additions & 35 deletions
Large diffs are not rendered by default.

_modules/parametricmatrixmodels/modules/affineeigenvaluepmm.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,8 @@ <h1>Source code for parametricmatrixmodels.modules.affineeigenvaluepmm</h1><div
430430
<span class="sd"> https://doi.org/10.1038/s41467-025-61362-4</span>
431431
<span class="sd"> &quot;&quot;&quot;</span>
432432

433+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
434+
433435
<div class="viewcode-block" id="AffineEigenvaluePMM.__init__">
434436
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.AffineEigenvaluePMM.html#parametricmatrixmodels.modules.AffineEigenvaluePMM.__init__">[docs]</a>
435437
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>

_modules/parametricmatrixmodels/modules/affinehermitianmatrix.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,8 @@ <h1>Source code for parametricmatrixmodels.modules.affinehermitianmatrix</h1><di
428428
<span class="sd"> ``AffineEigenvaluePMM`` module.</span>
429429
<span class="sd"> &quot;&quot;&quot;</span>
430430

431+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
432+
431433
<div class="viewcode-block" id="AffineHermitianMatrix.__init__">
432434
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.AffineHermitianMatrix.html#parametricmatrixmodels.modules.AffineHermitianMatrix.__init__">[docs]</a>
433435
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>

_modules/parametricmatrixmodels/modules/affineobservablepmm.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -479,6 +479,8 @@ <h1>Source code for parametricmatrixmodels.modules.affineobservablepmm</h1><div
479479
<span class="sd"> https://doi.org/10.1038/s41467-025-61362-4</span>
480480
<span class="sd"> &quot;&quot;&quot;</span>
481481

482+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
483+
482484
<div class="viewcode-block" id="AffineObservablePMM.__init__">
483485
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.AffineObservablePMM.html#parametricmatrixmodels.modules.AffineObservablePMM.__init__">[docs]</a>
484486
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>

_modules/parametricmatrixmodels/modules/basemodule.html

Lines changed: 116 additions & 20 deletions
Large diffs are not rendered by default.

_modules/parametricmatrixmodels/modules/bias.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,8 @@ <h1>Source code for parametricmatrixmodels.modules.bias</h1><div class="highligh
399399
<span class="sd"> leaf array (or be a scalar).</span>
400400
<span class="sd"> &quot;&quot;&quot;</span>
401401

402+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
403+
402404
<div class="viewcode-block" id="Bias.__init__">
403405
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.Bias.html#parametricmatrixmodels.modules.Bias.__init__">[docs]</a>
404406
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>

_modules/parametricmatrixmodels/modules/comment.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,8 @@ <h1>Source code for parametricmatrixmodels.modules.comment</h1><div class="highl
385385
<span class="sd"> A module that allows adding comments to ``Model`` summaries.</span>
386386
<span class="sd"> &quot;&quot;&quot;</span>
387387

388+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
389+
388390
<div class="viewcode-block" id="Comment.__init__">
389391
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.Comment.html#parametricmatrixmodels.modules.Comment.__init__">[docs]</a>
390392
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

_modules/parametricmatrixmodels/modules/concatenateleaves.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,8 @@ <h1>Source code for parametricmatrixmodels.modules.concatenateleaves</h1><div cl
394394
<span class="sd"> single array.</span>
395395
<span class="sd"> &quot;&quot;&quot;</span>
396396

397+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
398+
397399
<div class="viewcode-block" id="ConcatenateLeaves.__init__">
398400
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.ConcatenateLeaves.html#parametricmatrixmodels.modules.ConcatenateLeaves.__init__">[docs]</a>
399401
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>

_modules/parametricmatrixmodels/modules/constant.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,8 @@ <h1>Source code for parametricmatrixmodels.modules.constant</h1><div class="high
394394
<span class="sd"> Module that always returns a constant value which is optionally trainable.</span>
395395
<span class="sd"> &quot;&quot;&quot;</span>
396396

397+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
398+
397399
<div class="viewcode-block" id="Constant.__init__">
398400
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.Constant.html#parametricmatrixmodels.modules.Constant.__init__">[docs]</a>
399401
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>

_modules/parametricmatrixmodels/modules/eigensystem.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,8 @@ <h1>Source code for parametricmatrixmodels.modules.eigensystem</h1><div class="h
414414
<span class="sd"> matrix, which is used internally by this module.</span>
415415
<span class="sd"> &quot;&quot;&quot;</span>
416416

417+
<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;0.0.0&quot;</span>
418+
417419
<div class="viewcode-block" id="Eigensystem.__init__">
418420
<a class="viewcode-back" href="../../../generated/parametricmatrixmodels.modules.Eigensystem.html#parametricmatrixmodels.modules.Eigensystem.__init__">[docs]</a>
419421
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>

0 commit comments

Comments
 (0)