|
6 | 6 | <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
7 | 7 |
|
8 | 8 | <meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
9 |
| - <title>Training — pyNeVer '1.2.0' documentation</title> |
| 9 | + <title>Training — pyNeVer '1.2.1' documentation</title> |
10 | 10 | <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
|
11 | 11 | <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
12 | 12 |
|
13 | 13 |
|
14 | 14 | <script src="../_static/jquery.js?v=5d32c60e"></script>
|
15 | 15 | <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> |
17 | 17 | <script src="../_static/doctools.js?v=9bcbadda"></script>
|
18 | 18 | <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
19 | 19 | <script src="../_static/js/theme.js"></script>
|
|
93 | 93 | </ul>
|
94 | 94 | </li>
|
95 | 95 | <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> |
96 | 97 | </ul>
|
97 | 98 |
|
98 | 99 | </div>
|
|
184 | 185 | <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>
|
185 | 186 | <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>
|
186 | 187 | <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 |
188 | 189 | the attributes provided at instantiation time.</p>
|
189 | 190 | <dl class="py attribute">
|
190 | 191 | <dt class="sig sig-object py" id="pynever.strategies.training.PytorchTraining.optimizer_con">
|
|
204 | 205 | assumed to be the parameters to optimize</p>
|
205 | 206 | <dl class="field-list simple">
|
206 | 207 | <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> |
208 | 209 | </dd>
|
209 | 210 | </dl>
|
210 | 211 | </dd></dl>
|
|
285 | 286 | assumed to be the optimizer whose learning rate must be updated. (default: None)</p>
|
286 | 287 | <dl class="field-list simple">
|
287 | 288 | <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> |
289 | 290 | </dd>
|
290 | 291 | </dl>
|
291 | 292 | </dd></dl>
|
|
377 | 378 | <dl class="py method">
|
378 | 379 | <dt class="sig sig-object py" id="pynever.strategies.training.PytorchTraining.pytorch_training">
|
379 | 380 | <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> |
381 | 382 | <dl class="field-list simple">
|
382 | 383 | <dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
383 | 384 | <dd class="field-odd"><ul class="simple">
|
384 | 385 | <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> |
386 | 387 | </ul>
|
387 | 388 | </dd>
|
388 | 389 | <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> |
390 | 391 | </dd>
|
391 | 392 | <dt class="field-odd">Return type<span class="colon">:</span></dt>
|
392 | 393 | <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 | 422 | decrease for increasing correctness of the network (as the traditional loss value).</p>
|
422 | 423 | <dl class="field-list simple">
|
423 | 424 | <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> |
425 | 426 | </dd>
|
426 | 427 | </dl>
|
427 | 428 | </dd></dl>
|
|
483 | 484 | <hr/>
|
484 | 485 |
|
485 | 486 | <div role="contentinfo">
|
486 |
| - <p>© Copyright 2025, f'NeverTools'.</p> |
| 487 | + <p>© Copyright 2025, 'NeverTools'.</p> |
487 | 488 | </div>
|
488 | 489 |
|
489 | 490 | Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
0 commit comments