agedi.models.conditionings.scalar
=================================

.. py:module:: agedi.models.conditionings.scalar


Classes
-------

.. autoapisummary::

   agedi.models.conditionings.scalar.ScalarConditioning


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

.. py:class:: ScalarConditioning(*args, input_dim: int = 1, output_dim: int = 2, **kwargs)

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


   Conditioning module for continuous scalar properties.

   Projects a scalar property through a learned linear layer and encodes it
   with sinusoidal features (``cos`` and ``sin``), producing a 2-dimensional
   conditioning vector.


   .. py:attribute:: embedder


   .. 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