:py:mod:`kosmos.ml.config.factories.encoding`
=============================================

.. py:module:: kosmos.ml.config.factories.encoding







Classes
-------

.. py:class:: EncodingConfig

   Bases: :py:class:`abc.ABC`

   Encoding configuration.





   |

   .. rubric:: Methods

   .. py:method:: get_instance(input_dim: int, output_dim: int) -> kosmos.ml.models.vqc.encoding.VQCEncoding

      Get the encoding instance.

      :param input_dim: Model input dimension.
      :type input_dim: int
      :param output_dim: Model output dimension.
      :type output_dim: int

      :returns: Encoding instance.
      :rtype: VQCEncoding




----

.. py:class:: AngleEmbeddingConfig(rotation: Literal['X', 'Y', 'Z'] = 'X')

   Bases: :py:class:`EncodingConfig`

   Angle embedding configuration.

   Initialize the angle embedding configuration.

   :param rotation: The rotation to use for the angle embedding.
                    Defaults to "X".
   :type rotation: Literal["X", "Y", "Z"]





   |

   .. rubric:: Methods

   .. py:method:: get_instance(input_dim: int, output_dim: int) -> kosmos.ml.models.vqc.encoding.AngleEmbedding

      Get the angle embedding instance.

      :param input_dim: Model input dimension.
      :type input_dim: int
      :param output_dim: Model output dimension.
      :type output_dim: int

      :returns: Angle embedding instance.
      :rtype: AngleEmbedding




----

.. py:class:: AmplitudeEmbeddingConfig(pad_with: complex = 0.3, *, normalize: bool = True)

   Bases: :py:class:`EncodingConfig`

   Amplitude embedding configuration.

   Initialize the amplitude embedding configuration.

   :param pad_with: The input is padded with this constant to size :math:`2^n`.
   :type pad_with: complex
   :param normalize: Whether to normalize the features. Defaults to True.
   :type normalize: bool





   |

   .. rubric:: Methods

   .. py:method:: get_instance(input_dim: int, output_dim: int) -> kosmos.ml.models.vqc.encoding.AmplitudeEmbedding

      Get the amplitude embedding instance.

      :param input_dim: Model input dimension.
      :type input_dim: int
      :param output_dim: Model output dimension.
      :type output_dim: int

      :returns: Amplitude embedding instance.
      :rtype: AmplitudeEmbedding