deepmd.backend.pytorch
======================

.. py:module:: deepmd.backend.pytorch


Classes
-------

.. autoapisummary::

   deepmd.backend.pytorch.PyTorchBackend


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

.. py:class:: PyTorchBackend

   Bases: :py:obj:`deepmd.backend.backend.Backend`


   
   PyTorch backend.
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: name
      :value: 'PyTorch'


      
      The formal name of the backend.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: features
      :type:  ClassVar[deepmd.backend.backend.Backend.Feature]

      
      The features of the backend.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: suffixes
      :type:  ClassVar[list[str]]
      :value: ['.pth', '.pt']


      
      The suffixes of the backend.
















      ..
          !! processed by numpydoc !!


   .. py:method:: is_available() -> bool

      
      Check if the backend is available.





      :Returns:

          :ref:`bool <python:bltin-boolean-values>`
              Whether the backend is available.











      ..
          !! processed by numpydoc !!


   .. py:property:: entry_point_hook
      :type: collections.abc.Callable[[argparse.Namespace], None]


      
      The entry point hook of the backend.





      :Returns:

          :obj:`Callable <typing.Callable>`\[[:obj:`Namespace`], :data:`python:None`]
              The entry point hook of the backend.











      ..
          !! processed by numpydoc !!


   .. py:property:: deep_eval
      :type: type[deepmd.infer.deep_eval.DeepEvalBackend]


      
      The Deep Eval backend of the backend.





      :Returns:

          :obj:`type`\[:obj:`DeepEvalBackend`]
              The Deep Eval backend of the backend.











      ..
          !! processed by numpydoc !!


   .. py:property:: neighbor_stat
      :type: type[deepmd.pt.utils.neighbor_stat.NeighborStat]


      
      The neighbor statistics of the backend.





      :Returns:

          :obj:`type`\[:obj:`NeighborStat`]
              The neighbor statistics of the backend.











      ..
          !! processed by numpydoc !!


   .. py:property:: serialize_hook
      :type: collections.abc.Callable[[str], dict]


      
      The serialize hook to convert the model file to a dictionary.





      :Returns:

          :obj:`Callable <typing.Callable>`\[[:class:`python:str`], :class:`python:dict`]
              The serialize hook of the backend.











      ..
          !! processed by numpydoc !!


   .. py:property:: deserialize_hook
      :type: collections.abc.Callable[[str, dict], None]


      
      The deserialize hook to convert the dictionary to a model file.





      :Returns:

          :obj:`Callable <typing.Callable>`\[[:class:`python:str`, :class:`python:dict`], :data:`python:None`]
              The deserialize hook of the backend.











      ..
          !! processed by numpydoc !!