folivo/PINA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Dario Coscia
2025-03-17 12:23:26 +01:00
committed by FilippoOlivo
parent ae1fd2680f
commit 480140dd31
33 changed files with 265 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
pina/optim/torch_optimizer.py
View File

@@ -17,8 +17,9 @@ class TorchOptimizer(Optimizer):
:param torch.optim.Optimizer optimizer_class: A
:class:`torch.optim.Optimizer` class.
:param dict kwargs: Additional parameters passed to `optimizer_class`,
see more: <https://pytorch.org/docs/stable/optim.html#algorithms>_.
:param dict kwargs: Additional parameters passed to ``optimizer_class``,
see more
`here <https://pytorch.org/docs/stable/optim.html#algorithms>`_.
"""
check_consistency(optimizer_class, torch.optim.Optimizer, subclass=True)

5
pina/optim/torch_scheduler.py
View File

@@ -23,8 +23,9 @@ class TorchScheduler(Scheduler):
:param torch.optim.LRScheduler scheduler_class: A
:class:`torch.optim.LRScheduler` class.
:param dict kwargs: Additional parameters passed to `scheduler_class`,
see more: <https://pytorch.org/docs/stable/optim.html#algorithms>_.
:param dict kwargs: Additional parameters passed to ``scheduler_class``,
see more
`here <https://pytorch.org/docs/stable/optim.html#algorithms>_`.
"""
check_consistency(scheduler_class, LRScheduler, subclass=True)