ncalab.training.trainingparameters
==================================

.. py:module:: ncalab.training.trainingparameters


Classes
-------

.. autoapisummary::

   ncalab.training.trainingparameters.TrainingParameters


Module Contents
---------------

.. py:class:: TrainingParameters(gradient_clipping: bool = False, lr: Optional[float] = None, lr_gamma: float = 0.9999, adam_betas: tuple = (0.9, 0.99), batch_repeat: int = 2, max_epochs: int = 200, optimizer_method: str = 'adamw')

       


   .. py:attribute:: _gradient_clipping
      :value: False



   .. py:attribute:: _lr_gamma
      :value: 0.9999



   .. py:attribute:: _adam_betas
      :value: (0.9, 0.99)



   .. py:method:: info() -> str

      Shows a markdown-formatted info string with training parameters.
      Useful for showing info on tensorboard to keep track of parameter changes.

      :returns [str]: Markdown-formatted info string.



   .. py:method:: save(path)