.. _api:


Initialize a dataset
--------------------

.. autofunction:: soundata.initialize

.. autofunction:: soundata.list_datasets

.. _Datasets API:

Dataset Loaders
---------------

3D-MARCo
^^^^^^^^
.. _marco-module:

.. automodule:: soundata.datasets.marco
   :members:
   :inherited-members:

Clotho
^^^^^^
.. _clotho-module:

.. automodule:: soundata.datasets.clotho
   :members:
   :inherited-members:

DCASE23-Task2
^^^^^^^^^^^^^
.. _dcase23-task2-module:

.. automodule:: soundata.datasets.dcase23_task2
   :members:
   :inherited-members:

DCASE23-Task4B
^^^^^^^^^^^^^^
.. _dcase23-task4b-module:

.. automodule:: soundata.datasets.dcase23_task4b
   :members:
   :inherited-members:

DCASE23-Task6a
^^^^^^^^^^^^^^
.. _dcase23-task6a-module:

.. automodule:: soundata.datasets.dcase23_task6a
   :members:
   :inherited-members:

DCASE23-Task6b
^^^^^^^^^^^^^^
.. _dcase23-task6b-module:

.. automodule:: soundata.datasets.dcase23_task6b
   :members:
   :inherited-members:

DCASE-bioacoustic
^^^^^^^^^^^^^^^^^
.. _dcase-bioacoustic-module:

.. automodule:: soundata.datasets.dcase_bioacoustic
   :members:
   :inherited-members:

DCASE-birdVox20k
^^^^^^^^^^^^^^^^
.. _dcase-birdVox20k-module:

.. automodule:: soundata.datasets.dcase_birdVox20k
   :members:
   :inherited-members:

EigenScape
^^^^^^^^^^
.. _eigenscape-module:

.. automodule:: soundata.datasets.eigenscape
   :members:
   :inherited-members:

EigenScape Raw
^^^^^^^^^^^^^^
.. _eigenscape-raw-module:

.. automodule:: soundata.datasets.eigenscape_raw
   :members:
   :inherited-members:

ESC-50
^^^^^^
.. _esc50-module:

.. automodule:: soundata.datasets.esc50
   :members:
   :inherited-members:

Freefield1010
^^^^^^^^^^^^^
.. _freefield1010-module:

.. automodule:: soundata.datasets.freefield1010
   :members:
   :inherited-members:

FSD50K
^^^^^^
.. _fsd50k-module:

.. automodule:: soundata.datasets.fsd50k
   :members:
   :inherited-members:

FSDnoisy18K
^^^^^^^^^^^
.. _fsdnoisy18k-module:

.. automodule:: soundata.datasets.fsdnoisy18k
   :members:
   :inherited-members:

SINGA:PURA
^^^^^^^^^^
.. _singapura-module:

.. automodule:: soundata.datasets.singapura
   :members:
   :inherited-members:


STARSS 2022
^^^^^^^^^^^
.. _starss2022-module:

.. automodule:: soundata.datasets.starss2022
   :members:
   :inherited-members:
   

TAU NIGENS SSE 2020
^^^^^^^^^^^^^^^^^^^
.. _tau2020sse_nigens-module:

.. automodule:: soundata.datasets.tau2020sse_nigens
   :members:
   :inherited-members:
   

TAU NIGENS SSE 2021
^^^^^^^^^^^^^^^^^^^
.. _tau2021sse_nigens-module:

.. automodule:: soundata.datasets.tau2021sse_nigens
   :members:
   :inherited-members:
   

TAU Spatial Sound Events 2019
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _tau2019sse-module:

.. automodule:: soundata.datasets.tau2019sse
   :members:
   :inherited-members:

TAU Urban Acoustic Scenes 2019
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _tau2019uas-module:

.. automodule:: soundata.datasets.tau2019uas
   :members:
   :inherited-members:
   
TAU Urban Acoustic Scenes 2020 Mobile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _tau2020uas_mobile-module:

.. automodule:: soundata.datasets.tau2020uas_mobile
   :members:
   :inherited-members:

TAU Urban Acoustic Scenes 2022 Mobile
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _tau2022uas_mobile-module:

.. automodule:: soundata.datasets.tau2022uas_mobile
   :members:
   :inherited-members:

TUT Sound events 2017
^^^^^^^^^^^^^^^^^^^^^
.. _tut2017se-module:

.. automodule:: soundata.datasets.tut2017se
   :members:
   :inherited-members:

URBAN-SED
^^^^^^^^^
.. _urbansed-module:

.. automodule:: soundata.datasets.urbansed
   :members:
   :inherited-members:

UrbanSound8K
^^^^^^^^^^^^
.. _urbansound8k-module:

.. automodule:: soundata.datasets.urbansound8k
   :members:
   :inherited-members:


Warblrb10k
^^^^^^^^^^
.. _warblrb10k-module:

.. automodule:: soundata.datasets.warblrb10k
   :members:
   :inherited-members:


Core
----

.. automodule:: soundata.core
   :members:

.. _annotations:

Annotations
-----------

.. automodule:: soundata.annotations
   :members:


Advanced
--------

soundata.validate
^^^^^^^^^^^^^^^^^

.. automodule:: soundata.validate
   :members:


soundata.download_utils
^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: soundata.download_utils
   :members:


Using soundata with JAMS
^^^^^^^^^^^^^^^^^^^^^^^^^

This section demonstrates how to use JAMS to load clips's data.

Ensure you have JAMS installed by running:

    .. code-block:: bash

        pip install jams

.. admonition:: jams_utils
    :class: dropdown

    The following code contains utilities functions for converting soundata Annotation classes to JAMS format.

    .. literalinclude:: tutorial_examples/jams_utils.py
        :language: python


.. admonition:: Using JAMS to read Annotations

    The following example shows how to convert a clip's data into JAMS format using the utilities above.

    .. literalinclude:: tutorial_examples/to_jams.py
        :language: python

For more information, visit the `JAMS documentation <https://jams.readthedocs.io/en/stable/index.html>`_.