bittensor.core.tensor
=====================

.. py:module:: bittensor.core.tensor


Attributes
----------

.. autoapisummary::

   bittensor.core.tensor.dtypes


Classes
-------

.. autoapisummary::

   bittensor.core.tensor.DTypes
   bittensor.core.tensor.Tensor
   bittensor.core.tensor.tensor


Functions
---------

.. autoapisummary::

   bittensor.core.tensor.cast_dtype
   bittensor.core.tensor.cast_shape


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

.. py:class:: DTypes(*args, **kwargs)

   Bases: :py:obj:`dict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: torch
      :type:  bool
      :value: False



.. py:class:: Tensor

   Bases: :py:obj:`pydantic.BaseModel`


   Represents a Tensor object.

   :param buffer: Tensor buffer data.
   :param dtype: Tensor data type.
   :param shape: Tensor shape.


   .. py:attribute:: buffer
      :type:  Optional[str]


   .. py:method:: deserialize()

      Deserializes the Tensor object.

      :returns: The deserialized tensor object.
      :rtype: np.array or torch.Tensor

      :raises Exception: If the deserialization process encounters an error.



   .. py:attribute:: dtype
      :type:  str


   .. py:attribute:: model_config


   .. py:method:: numpy()


   .. py:method:: serialize(tensor_)
      :staticmethod:


      Serializes the given tensor.

      :param tensor_: The tensor to serialize.

      :returns: The serialized tensor.

      :raises Exception: If the serialization process encounters an error.



   .. py:attribute:: shape
      :type:  list[int]


   .. py:method:: tensor()


   .. py:method:: tolist()


.. py:function:: cast_dtype(raw)

   Casts the raw value to a string representing the `numpy data type <https://numpy.org/doc/stable/user/basics.types.html>`_, or the `torch data type <https://pytorch.org/docs/stable/tensor_attributes.html>`_ if using torch.

   :param raw: The raw value to cast.

   :returns: The string representing the numpy/torch data type.

   :raises Exception: If the raw value is of an invalid type.


.. py:function:: cast_shape(raw)

   Casts the raw value to a string representing the tensor shape.

   :param raw: The raw value to cast.

   :returns: The string representing the tensor shape.

   :raises Exception: If the raw value is of an invalid type or if the list elements are not of type int.


.. py:data:: dtypes

.. py:class:: tensor