logitorch.utilities.discourse_delimiter
=======================================

.. py:module:: logitorch.utilities.discourse_delimiter


Attributes
----------

.. autoapisummary::

   logitorch.utilities.discourse_delimiter.EXCPLICIT_CONNECTIVES
   logitorch.utilities.discourse_delimiter.PUNCTUATION_DELIMETERS
   logitorch.utilities.discourse_delimiter.d


Classes
-------

.. autoapisummary::

   logitorch.utilities.discourse_delimiter.DiscourseDelimiter


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

.. py:class:: DiscourseDelimiter

   A class that provides methods to split a passage into educational units (EDUs) based on explicit connectives and punctuation delimiters.


   .. py:method:: split_edu(passage: str) -> str

      Splits the passage into educational units (EDUs) by replacing explicit connectives with "<CONNECTIVE>" and punctuation delimiters with "<PUNCT>".

      Args:
          passage (str): The passage to be split into EDUs.

      Returns:
          str: The passage with explicit connectives and punctuation delimiters replaced by "<CONNECTIVE>" and "<PUNCT>" respectively.



   .. py:method:: split_explicit_connectives(passage: str) -> List[str]

      Splits the passage into segments based on explicit connectives.

      Args:
          passage (str): The passage to be split.

      Returns:
          List[str]: A list of segments split based on explicit connectives.



   .. py:method:: split_punctuation_delimiters(passage: str) -> List[str]

      Splits the passage into segments based on punctuation delimiters.

      Args:
          passage (str): The passage to be split.

      Returns:
          List[str]: A list of segments split based on punctuation delimiters.



   .. py:attribute:: regex_explicit_connectives
      :value: ''



   .. py:attribute:: regex_punctuation_delimiters
      :value: ''



.. py:data:: EXCPLICIT_CONNECTIVES

.. py:data:: PUNCTUATION_DELIMETERS

.. py:data:: d