Skip to content

Commit 1b5dc21

Browse files
author
github-actions
committed
Update API docs from pynever
1 parent bf90201 commit 1b5dc21

15 files changed

+675
-48
lines changed

pynever/API/0_Networks.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Networks &mdash; pyNeVer &#39;1.2.0&#39; documentation</title>
9+
<title>Networks &mdash; pyNeVer &#39;1.2.1&#39; documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="../_static/jquery.js?v=5d32c60e"></script>
1515
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="../_static/documentation_options.js?v=a8716bae"></script>
16+
<script src="../_static/documentation_options.js?v=3733ff34"></script>
1717
<script src="../_static/doctools.js?v=9bcbadda"></script>
1818
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="../_static/js/theme.js"></script>
@@ -98,6 +98,7 @@
9898
<li class="toctree-l1"><a class="reference internal" href="1_Nodes.html">Nodes</a></li>
9999
<li class="toctree-l1"><a class="reference internal" href="2_Training.html">Training</a></li>
100100
<li class="toctree-l1"><a class="reference internal" href="3_Conversion.html">Conversion</a></li>
101+
<li class="toctree-l1"><a class="reference internal" href="4_Verification.html">Verification</a></li>
101102
</ul>
102103

103104
</div>
@@ -627,7 +628,7 @@
627628
<hr/>
628629

629630
<div role="contentinfo">
630-
<p>&#169; Copyright 2025, f&#39;NeverTools&#39;.</p>
631+
<p>&#169; Copyright 2025, &#39;NeverTools&#39;.</p>
631632
</div>
632633

633634
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

pynever/API/1_Nodes.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Nodes &mdash; pyNeVer &#39;1.2.0&#39; documentation</title>
9+
<title>Nodes &mdash; pyNeVer &#39;1.2.1&#39; documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="../_static/jquery.js?v=5d32c60e"></script>
1515
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="../_static/documentation_options.js?v=a8716bae"></script>
16+
<script src="../_static/documentation_options.js?v=3733ff34"></script>
1717
<script src="../_static/doctools.js?v=9bcbadda"></script>
1818
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="../_static/js/theme.js"></script>
@@ -201,6 +201,7 @@
201201
</li>
202202
<li class="toctree-l1"><a class="reference internal" href="2_Training.html">Training</a></li>
203203
<li class="toctree-l1"><a class="reference internal" href="3_Conversion.html">Conversion</a></li>
204+
<li class="toctree-l1"><a class="reference internal" href="4_Verification.html">Verification</a></li>
204205
</ul>
205206

206207
</div>
@@ -1375,7 +1376,7 @@
13751376
<hr/>
13761377

13771378
<div role="contentinfo">
1378-
<p>&#169; Copyright 2025, f&#39;NeverTools&#39;.</p>
1379+
<p>&#169; Copyright 2025, &#39;NeverTools&#39;.</p>
13791380
</div>
13801381

13811382
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

pynever/API/2_Training.html

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Training &mdash; pyNeVer &#39;1.2.0&#39; documentation</title>
9+
<title>Training &mdash; pyNeVer &#39;1.2.1&#39; documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="../_static/jquery.js?v=5d32c60e"></script>
1515
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="../_static/documentation_options.js?v=a8716bae"></script>
16+
<script src="../_static/documentation_options.js?v=3733ff34"></script>
1717
<script src="../_static/doctools.js?v=9bcbadda"></script>
1818
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="../_static/js/theme.js"></script>
@@ -93,6 +93,7 @@
9393
</ul>
9494
</li>
9595
<li class="toctree-l1"><a class="reference internal" href="3_Conversion.html">Conversion</a></li>
96+
<li class="toctree-l1"><a class="reference internal" href="4_Verification.html">Verification</a></li>
9697
</ul>
9798

9899
</div>
@@ -184,7 +185,7 @@
184185
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pynever.strategies.training.</span></span><span class="sig-name descname"><span class="pre">PytorchTraining</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">optimizer_con</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opt_params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loss_function</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_epochs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validation_percentage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_batch_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validation_batch_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">r_split</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scheduler_con</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">sch_params</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">precision_metric</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">network_transform</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">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'cpu'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">train_patience</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">checkpoints_root</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">verbose_rate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NeverTools/pynever/blob/main/pynever/strategies/training.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pynever.strategies.training.PytorchTraining" title="Link to this definition"></a></dt>
185186
<dd><p>Bases: <a class="reference internal" href="#pynever.strategies.training.TrainingStrategy" title="pynever.strategies.training.TrainingStrategy"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrainingStrategy</span></code></a></p>
186187
<p>Class used to represent the training strategy based on the Pytorch learning framework.
187-
It supports different optimization algorithm, schedulers, loss function and others based on
188+
It supports different optimization algorithms, schedulers, loss functions and others based on
188189
the attributes provided at instantiation time.</p>
189190
<dl class="py attribute">
190191
<dt class="sig sig-object py" id="pynever.strategies.training.PytorchTraining.optimizer_con">
@@ -204,7 +205,7 @@
204205
assumed to be the parameters to optimize</p>
205206
<dl class="field-list simple">
206207
<dt class="field-odd">Type<span class="colon">:</span></dt>
207-
<dd class="field-odd"><p>Dict</p>
208+
<dd class="field-odd"><p>dict</p>
208209
</dd>
209210
</dl>
210211
</dd></dl>
@@ -285,7 +286,7 @@
285286
assumed to be the optimizer whose learning rate must be updated. (default: None)</p>
286287
<dl class="field-list simple">
287288
<dt class="field-odd">Type<span class="colon">:</span></dt>
288-
<dd class="field-odd"><p>Dict, Optional</p>
289+
<dd class="field-odd"><p>dict, Optional</p>
289290
</dd>
290291
</dl>
291292
</dd></dl>
@@ -377,16 +378,16 @@
377378
<dl class="py method">
378379
<dt class="sig sig-object py" id="pynever.strategies.training.PytorchTraining.pytorch_training">
379380
<span class="sig-name descname"><span class="pre">pytorch_training</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">net</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataset</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NeverTools/pynever/blob/main/pynever/strategies/training.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pynever.strategies.training.PytorchTraining.pytorch_training" title="Link to this definition"></a></dt>
380-
<dd><p>Training procedure for the PyTorchNetwork.</p>
381+
<dd><p>Training procedure using PyTorch.</p>
381382
<dl class="field-list simple">
382383
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
383384
<dd class="field-odd"><ul class="simple">
384385
<li><p><strong>net</strong> (<a class="reference internal" href="3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork" title="pynever.strategies.conversion.representation.PyTorchNetwork"><em>PyTorchNetwork</em></a>) – The PyTorchNetwork to train.</p></li>
385-
<li><p><strong>dataset</strong> (<em>Dataset</em>) – The dataset to use for the training of the PyTorchNetwork</p></li>
386+
<li><p><strong>dataset</strong> (<em>Dataset</em>) – The dataset to use for the training of the <a class="reference internal" href="3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork" title="pynever.strategies.conversion.representation.PyTorchNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyTorchNetwork</span></code></a></p></li>
386387
</ul>
387388
</dd>
388389
<dt class="field-even">Returns<span class="colon">:</span></dt>
389-
<dd class="field-even"><p>The trained PyTorchNetwork.</p>
390+
<dd class="field-even"><p>The trained <a class="reference internal" href="3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork" title="pynever.strategies.conversion.representation.PyTorchNetwork"><code class="xref py py-class docutils literal notranslate"><span class="pre">PyTorchNetwork</span></code></a>.</p>
390391
</dd>
391392
<dt class="field-odd">Return type<span class="colon">:</span></dt>
392393
<dd class="field-odd"><p><a class="reference internal" href="3_Conversion.html#pynever.strategies.conversion.representation.PyTorchNetwork" title="pynever.strategies.conversion.representation.PyTorchNetwork">PyTorchNetwork</a></p>
@@ -421,7 +422,7 @@
421422
decrease for increasing correctness of the network (as the traditional loss value).</p>
422423
<dl class="field-list simple">
423424
<dt class="field-odd">Type<span class="colon">:</span></dt>
424-
<dd class="field-odd"><p>Dict</p>
425+
<dd class="field-odd"><p>dict</p>
425426
</dd>
426427
</dl>
427428
</dd></dl>
@@ -483,7 +484,7 @@
483484
<hr/>
484485

485486
<div role="contentinfo">
486-
<p>&#169; Copyright 2025, f&#39;NeverTools&#39;.</p>
487+
<p>&#169; Copyright 2025, &#39;NeverTools&#39;.</p>
487488
</div>
488489

489490
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

pynever/API/3_Conversion.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Conversion &mdash; pyNeVer &#39;1.2.0&#39; documentation</title>
9+
<title>Conversion &mdash; pyNeVer &#39;1.2.1&#39; documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="../_static/jquery.js?v=5d32c60e"></script>
1515
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="../_static/documentation_options.js?v=a8716bae"></script>
16+
<script src="../_static/documentation_options.js?v=3733ff34"></script>
1717
<script src="../_static/doctools.js?v=9bcbadda"></script>
1818
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="../_static/js/theme.js"></script>
2020
<link rel="index" title="Index" href="../genindex.html" />
2121
<link rel="search" title="Search" href="../search.html" />
22+
<link rel="next" title="Verification" href="4_Verification.html" />
2223
<link rel="prev" title="Training" href="2_Training.html" />
2324
</head>
2425

@@ -80,6 +81,7 @@
8081
</li>
8182
</ul>
8283
</li>
84+
<li class="toctree-l1"><a class="reference internal" href="4_Verification.html">Verification</a></li>
8385
</ul>
8486

8587
</div>
@@ -268,12 +270,13 @@
268270
</div>
269271
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
270272
<a href="2_Training.html" class="btn btn-neutral float-left" title="Training" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
273+
<a href="4_Verification.html" class="btn btn-neutral float-right" title="Verification" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
271274
</div>
272275

273276
<hr/>
274277

275278
<div role="contentinfo">
276-
<p>&#169; Copyright 2025, f&#39;NeverTools&#39;.</p>
279+
<p>&#169; Copyright 2025, &#39;NeverTools&#39;.</p>
277280
</div>
278281

279282
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

0 commit comments

Comments
 (0)