caikit.interfaces.common.data_model.vectors
===========================================

.. py:module:: caikit.interfaces.common.data_model.vectors

.. autoapi-nested-parse::

   Data structures for embedding vector representations



Attributes
----------

.. autoapisummary::

   caikit.interfaces.common.data_model.vectors.log
   caikit.interfaces.common.data_model.vectors.error


Classes
-------

.. autoapisummary::

   caikit.interfaces.common.data_model.vectors.PyFloatSequence
   caikit.interfaces.common.data_model.vectors.NpFloat32Sequence
   caikit.interfaces.common.data_model.vectors.NpFloat64Sequence
   caikit.interfaces.common.data_model.vectors.Vector1D
   caikit.interfaces.common.data_model.vectors.ListOfVector1D


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

.. py:data:: log

.. py:data:: error

.. py:class:: PyFloatSequence

   Bases: :py:obj:`caikit.core.DataObjectBase`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: values
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[float], FieldNumber(1)]
      :value: []



.. py:class:: NpFloat32Sequence

   Bases: :py:obj:`caikit.core.DataObjectBase`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: values
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[numpy.float32], FieldNumber(1)]


   .. py:method:: from_proto(proto)
      :classmethod:


      Build a DataBase from protobufs.

      Args:
          proto: A protocol buffer to serialize from.
      Returns:
          protobufs: A DataBase object.



.. py:class:: NpFloat64Sequence

   Bases: :py:obj:`caikit.core.DataObjectBase`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: values
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[numpy.float64], FieldNumber(1)]


   .. py:method:: from_proto(proto)
      :classmethod:


      Build a DataBase from protobufs.

      Args:
          proto: A protocol buffer to serialize from.
      Returns:
          protobufs: A DataBase object.



.. py:class:: Vector1D

   Bases: :py:obj:`caikit.core.DataObjectBase`


   Data representation for a 1 dimension vector of float-type data.


   .. py:attribute:: data
      :type:  py_to_proto.dataclass_to_proto.Annotated[Union[PyFloatSequence, NpFloat32Sequence, NpFloat64Sequence], FieldNumber(1)]


   .. py:method:: __post_init__()


   .. py:method:: from_vector(vector)
      :classmethod:



   .. py:method:: from_json(json_str: Union[Dict[str, Any], str]) -> Vector1D
      :classmethod:


      JSON does not have different float types. Move data into data_pyfloatsequence



   .. py:method:: to_dict() -> dict

      to_dict is needed to make things serializable



   .. py:method:: from_proto(proto)
      :classmethod:


      Wrap the data in an appropriate float sequence, wrapped by this class



   .. py:method:: fill_proto(proto)

      Fill in the data in an appropriate data_<float type sequence>



.. py:class:: ListOfVector1D

   Bases: :py:obj:`caikit.core.DataObjectBase`


   Data representation for an embedding matrix holding 2D vectors


   .. py:attribute:: vectors
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[Vector1D], FieldNumber(1)]


   .. py:method:: __post_init__()


   .. py:method:: from_json(json_str: Union[Dict[str, Any], str]) -> ListOfVector1D
      :classmethod:


      Fill in the vector data in an appropriate data_<float type sequence>