:py:mod:`maha.datasets.templates`
=================================

.. py:module:: maha.datasets.templates


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   dataset/index.rst
   dataset_templates/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   maha.datasets.templates.Dataset
   maha.datasets.templates.IterableDataset
   maha.datasets.templates.Name




.. py:class:: Dataset(path, template, sep = '\t')

   Bases: :py:obj:`Generic`\ [\ :py:obj:`T`\ ]

   Base class for all datasets.

   :param path: Path to the dataset.
   :type path: Union[str, Path]
   :param template: Template class for the dataset.
   :type template: Type
   :param sep: Separator for the dataset. The default is "     ".
   :type sep: str, optional

   .. py:method:: data(self)
      :property:



.. py:class:: IterableDataset(path, template, sep = '\t')

   Bases: :py:obj:`Generic`\ [\ :py:obj:`T`\ ]

   Base class for all datasets that need to be streamed.

   :param path: Path to the dataset.
   :type path: Union[str, Path]
   :param template: Template class for the dataset.
   :type template: Type
   :param sep: Separator for the dataset. The default is "     ".
   :type sep: str, optional


.. py:class:: Name(name, description, origin)

   Template for the names dataset.

   :param name: Name of person.
   :type name: str
   :param description: Description or meaning of the name. Can contain multiple descriptions separated
                       by "||".
   :type description: str
   :param origin: Origin of the name.
   :type origin: str

   .. py:attribute:: name
      :annotation: :str

      

   .. py:attribute:: description
      :annotation: :List[str]

      

   .. py:attribute:: origin
      :annotation: :str

      

   .. py:method:: cleaned_name(self)
      :property:

      Cleaned name.