deepmd.dpmodel.utils.env_mat_stat
=================================

.. py:module:: deepmd.dpmodel.utils.env_mat_stat


Classes
-------

.. autoapisummary::

   deepmd.dpmodel.utils.env_mat_stat.EnvMatStat
   deepmd.dpmodel.utils.env_mat_stat.EnvMatStatSe


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

.. py:class:: EnvMatStat

   Bases: :py:obj:`deepmd.utils.env_mat_stat.EnvMatStat`


   
   A base class to store and calculate the statistics of the environment matrix.
















   ..
       !! processed by numpydoc !!

   .. py:method:: compute_stat(env_mat: dict[str, deepmd.dpmodel.array_api.Array]) -> dict[str, deepmd.utils.env_mat_stat.StatItem]

      
      Compute the statistics of the environment matrix for a single system.


      :Parameters:

          **env_mat** : :obj:`Array`
              The environment matrix.



      :Returns:

          :class:`python:dict`\[:class:`python:str`, :obj:`StatItem`]
              The statistics of the environment matrix.











      ..
          !! processed by numpydoc !!


.. py:class:: EnvMatStatSe(descriptor: Union[deepmd.dpmodel.descriptor.Descriptor, deepmd.dpmodel.descriptor.DescriptorBlock])

   Bases: :py:obj:`EnvMatStat`


   
   Environmental matrix statistics for the se_a/se_r environmental matrix.


   :Parameters:

       **descriptor** : :obj:`Descriptor` or :obj:`DescriptorBlock`
           The descriptor of the model.














   ..
       !! processed by numpydoc !!

   .. py:attribute:: descriptor


   .. py:attribute:: last_dim


   .. py:method:: iter(data: list[dict[str, numpy.ndarray | list[tuple[int, int]]]]) -> collections.abc.Iterator[dict[str, deepmd.utils.env_mat_stat.StatItem]]

      
      Get the iterator of the environment matrix.


      :Parameters:

          **data** : :class:`python:list`\[:class:`python:dict`\[:class:`python:str`, :obj:`Union <typing.Union>`\[:obj:`np.ndarray <numpy.ndarray>`, :class:`python:list`\[:class:`python:tuple`\[:class:`python:int`, :class:`python:int`]]]]]
              The data.




      :Yields:

          :class:`python:dict`\[:class:`python:str`, :obj:`StatItem`]
              The statistics of the environment matrix.










      ..
          !! processed by numpydoc !!


   .. py:method:: get_hash() -> str

      
      Get the hash of the environment matrix.





      :Returns:

          :class:`python:str`
              The hash of the environment matrix.











      ..
          !! processed by numpydoc !!


   .. py:method:: __call__() -> tuple[deepmd.dpmodel.array_api.Array, deepmd.dpmodel.array_api.Array]