:py:mod:`src.use`
=================

.. py:module:: src.use


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

Classes
~~~~~~~

.. autoapisummary::

   src.use.Use




Attributes
~~~~~~~~~~

.. autoapisummary::

   src.use.UseID


.. py:data:: UseID
   :type: TypeAlias

   

.. py:class:: Use


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

   .. py:attribute:: identifier
      :type: UseID

      

   .. py:attribute:: grouping
      :type: str

      

   .. py:attribute:: context
      :type: str

      

   .. py:attribute:: target
      :type: str

      

   .. py:attribute:: indices
      :type: tuple[int, int]

      

   .. py:attribute:: pos
      :type: str

      

   .. py:method:: from_series(use: pandas.Series) -> Use
      :classmethod:

      Return one use from type series with specific columns. The use is the Series includes 
      the folloing columns: lemma, pos, grouping, identifier, context_prepeocessed,
      target_index_begin, and target_index_end.

      :param use: use
      :type use: Series
      :return: Use object with specific columns.
      :rtype: Use


   .. py:method:: __hash__() -> int

      Called by built-in function hash() and for operations on members of hashed collections.

      :return: The hash value of identifier of the Use.
      :rtype: int


   .. py:method:: __lt__(other: Use) -> bool

      Compare the value of the identifier of self.use and the value of the identifier of 
      other use.

      :param other: The use to be compared.
      :type other: Use
      :return: Return Ture if the value of the identifier of self.use is less than the value of the identifier of 
      other use.
      :rtype: bool