timesead.models
===============

.. py:module:: timesead.models


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/timesead/models/baselines/index
   /autoapi/timesead/models/common/index
   /autoapi/timesead/models/generative/index
   /autoapi/timesead/models/layers/index
   /autoapi/timesead/models/other/index
   /autoapi/timesead/models/prediction/index
   /autoapi/timesead/models/reconstruction/index


Classes
-------

.. autoapisummary::

   timesead.models.BaseModel


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

.. py:class:: BaseModel(*args, **kwargs)

   Bases: :py:obj:`torch.nn.Module`


   Base class for all neural network modules.

   Your models should also subclass this class.

   Modules can also contain other Modules, allowing them to be nested in
   a tree structure. You can assign the submodules as regular attributes::

       import torch.nn as nn
       import torch.nn.functional as F

       class Model(nn.Module):
           def __init__(self) -> None:
               super().__init__()
               self.conv1 = nn.Conv2d(1, 20, 5)
               self.conv2 = nn.Conv2d(20, 20, 5)

           def forward(self, x):
               x = F.relu(self.conv1(x))
               return F.relu(self.conv2(x))

   Submodules assigned in this way will be registered, and will also have their
   parameters converted when you call :meth:`to`, etc.

   .. note::
       As per the example above, an ``__init__()`` call to the parent class
       must be made before assignment on the child.

   :ivar training: Boolean represents whether this module is in training or
                   evaluation mode.
   :vartype training: bool

   Initialize internal Module state, shared by both nn.Module and ScriptModule.


   .. py:method:: grouped_parameters() -> Tuple[Iterator[torch.nn.Parameter], Ellipsis]