:py:mod:`lightning_template.utils`
==================================

.. py:module:: lightning_template.utils


Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   callbacks/index.rst
   cli/index.rst
   loggers/index.rst
   loop/index.rst
   mixin/index.rst
   optim/index.rst
   progress/index.rst
   timer/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   lightning_template.utils.LightningCLI
   lightning_template.utils.Trainer
   lightning_template.utils.Timer




.. py:class:: LightningCLI(save_config_callback: Optional[Type[lightning.pytorch.cli.SaveConfigCallback]] = SaveAndLogConfigCallback, trainer_class: Union[Type[lightning_template.utils.cli.trainer._Trainer], Callable[Ellipsis, lightning_template.utils.cli.trainer._Trainer]] = Trainer, *args, **kwargs)


   Bases: :py:obj:`lightning.pytorch.cli.LightningCLI`

   Implementation of a configurable command line tool for pytorch-lightning.

   .. py:method:: _setup_parser_kwargs(*args, **kwargs) -> Tuple[Dict[str, Any], Dict[str, Any]]


   .. py:method:: add_default_arguments_to_parser(parser: lightning.pytorch.cli.LightningArgumentParser) -> None

      Adds default arguments to the parser.


   .. py:method:: randomly_select_seed() -> int
      :staticmethod:


   .. py:method:: _set_seed() -> None

      Sets the seed.


   .. py:method:: before_instantiate_classes() -> None

      Implement to run some code before instantiating the classes.


   .. py:method:: _add_configure_optimizers_method_to_model(*args, **kwargs) -> None

      Overrides the model's :meth:`~lightning.pytorch.core.LightningModule.configure_optimizers` method if a
      single optimizer and optionally a scheduler argument groups are added to the parser as 'AUTOMATIC'.



.. py:class:: Trainer(num_folds: Optional[int] = None, *args, **kwargs)


   Bases: :py:obj:`lightning.pytorch.Trainer`


.. py:class:: Timer


   .. py:property:: duration


   .. py:attribute:: duration_ms

      

   .. py:method:: __enter__()


   .. py:method:: __exit__(*args)


   .. py:method:: iters_per_second(batch_size=1)