ncalab.prediction
=================

.. py:module:: ncalab.prediction


Classes
-------

.. autoapisummary::

   ncalab.prediction.Prediction


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

.. py:class:: Prediction(model, steps: int, output_image: torch.Tensor, logits: torch.Tensor, head_prediction: Optional[torch.Tensor] = None)

   Stores the result of an NCA prediction, including the number of steps it took.

   Sequences are typically stored by BasicNCAModel's "record" function, and are
   returned as a list of Prediction objects.

   Constructor is typically not called explicitly.
   Rather, the forward pass of BasicNCAModel (and its
   subclasses) is responsible for filling its attributes.

   :param model: Reference to model used for prediction.
   :type model: ncalab.BasicNCAModel
   :param steps: Number of steps taken for the prediction.
   :type steps: int
   :param output_image: Output image tensor.
   :type output_image: torch.Tensor


   .. py:attribute:: model


   .. py:attribute:: steps


   .. py:attribute:: output_image


   .. py:attribute:: _output_array
      :type:  Optional[numpy.ndarray]
      :value: None



   .. py:attribute:: logits


   .. py:attribute:: _logits_array
      :type:  Optional[numpy.ndarray]
      :value: None



   .. py:attribute:: head_prediction
      :value: None



   .. py:attribute:: _head_prediction_array
      :type:  Optional[numpy.ndarray]
      :value: None



   .. py:property:: image_channels
      :type: torch.Tensor


      Convenience property to access the image channels as a Tensor.

      :returns: BCWH Tensor
      :rtype: torch.Tensor



   .. py:property:: hidden_channels
      :type: torch.Tensor


      Convenience property to access the hidden channels as a Tensor.

      :returns: BCWH Tensor
      :rtype: torch.Tensor



   .. py:property:: output_channels
      :type: torch.Tensor


      Convenience property to access the output channels as a Tensor.

      :returns: BCWH Tensor
      :rtype: torch.Tensor



   .. py:property:: output_array
      :type: numpy.ndarray


      Convenience property to access the whole output image in the format of
      a numpy array. Brings the entire tensor to CPU on demand, and only at
      the first call.

      :returns: Numpy array in BCWH format
      :rtype: np.ndarray



   .. py:property:: image_channels_np
      :type: numpy.ndarray


      Convenience property to access the output image channels in the format of
      a numpy array. Brings the entire tensor to CPU on demand, and only at
      the first call.

      :returns: Numpy array in BCWH format
      :rtype: np.ndarray



   .. py:property:: hidden_channels_np
      :type: numpy.ndarray


      Convenience property to access the hidden image channels in the format of
      a numpy array. Brings the entire tensor to CPU on demand, and only at
      the first call.

      :returns: Numpy array in BCWH format
      :rtype: np.ndarray



   .. py:property:: output_channels_np
      :type: numpy.ndarray


      Convenience property to access the image's output channels in the format of
      a numpy array. Brings the entire tensor to CPU on demand, and only at
      the first call.

      :returns: Numpy array in BCWH format
      :rtype: np.ndarray



   .. py:property:: head_prediction_array
      :type: numpy.ndarray | None



   .. py:property:: logits_array
      :type: numpy.ndarray