ncalab.models.basicNCA.abstractNCAhead
======================================

.. py:module:: ncalab.models.basicNCA.abstractNCAhead


Classes
-------

.. autoapisummary::

   ncalab.models.basicNCA.abstractNCAhead.AbstractNCAHead


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

.. py:class:: AbstractNCAHead

   Bases: :py:obj:`torch.nn.Module`, :py:obj:`abc.ABC`


   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:attribute:: optimizer
      :value: None



   .. py:method:: forward(x: torch.Tensor) -> torch.Tensor

      :param x: Input tensor
      :type x: torch.Tensor

      :returns: NotImplemented, subclasses are required to implement this method.



   .. py:method:: freeze(freeze_last: bool = True) -> None
      :abstractmethod:


      Freeze head weights.

      :param freeze_last: Whether to freeze the last layer (if applicable), defaults to True
      :type freeze_last: bool, optional
      :returns: NotImplemented, subclasses are required to implement this method.