agedi.models.conditionings.integer
==================================

.. py:module:: agedi.models.conditionings.integer


Classes
-------

.. autoapisummary::

   agedi.models.conditionings.integer.IntegerConditioning


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

.. py:class:: IntegerConditioning(max_int: int = 200, input_dim: int = 1, output_dim: int = 64, *args, **kwargs)

   Bases: :py:obj:`agedi.models.conditionings.base.Conditioning`


   Conditioning module for integer-valued properties.

   Embeds an integer property (e.g. number of atoms) into a fixed-size
   representation using :class:`torch.nn.Embedding`.


   .. py:attribute:: max_int
      :value: 200



   .. py:attribute:: embedder


   .. py:method:: get_hparams() -> Dict

      Return hyperparameters for this integer conditioning module.



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

      Get the conditioning tensor for x

      :param x: Time tensor of shape (Nodes, 1).
      :type x: torch.Tensor

      :returns: Conditioning tensor of shape (Nodes, 2).
      :rtype: torch.Tensor



   .. py:method:: get_empty_conditioning(n: int) -> torch.Tensor

      Get an empty conditioning tensor.

      :returns: Empty conditioning tensor of shape (n, 2).
      :rtype: torch.Tensor