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

.. py:module:: maha.datasets


Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   functions/index.rst
   templates/index.rst


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

   utils/index.rst


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


Functions
~~~~~~~~~

.. autosummary::

   load_dataset
   get_available_datasets



.. py:function:: load_dataset(name: typing_extensions.Literal[names], streaming: typing_extensions.Literal[False] = False) -> maha.datasets.templates.Dataset[maha.datasets.templates.Name]
              load_dataset(name: typing_extensions.Literal[names], streaming: typing_extensions.Literal[True]) -> maha.datasets.templates.IterableDataset[maha.datasets.templates.Name]

   Loads a dataset.

   :param name: Name of the dataset.
   :param streaming: Whether to return a streaming dataset. If set to True, an IterableDataset is
                     returned instead.
   :type streaming: bool, optional

   :returns: The loaded dataset.
   :rtype: Union[:class:`~.Dataset`, :class:`~.IterableDataset`]

   :raises FileNotFoundError: If the dataset does not exist.


.. py:function:: get_available_datasets()

   Returns a list of available datasets.

   :returns: A list of available datasets.
   :rtype: list