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

.. py:module:: maha.datasets.functions


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

   load_fn/index.rst


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


Functions
~~~~~~~~~

.. autosummary::

   load_dataset



.. 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.