DeepAudio-X
===========

.. image:: https://img.shields.io/pypi/v/deepaudio-x.svg
   :target: https://pypi.org/project/deepaudio-x/
   :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/deepaudio-x.svg
   :target: https://pypi.org/project/deepaudio-x/
   :alt: Python versions

.. image:: https://img.shields.io/github/license/magcil/deepaudio-x.svg
   :target: https://github.com/magcil/deepaudio-x/blob/main/LICENSE
   :alt: License

.. image:: https://github.com/magcil/deepaudio-x/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/magcil/deepaudio-x/actions/workflows/tests.yml
   :alt: Tests

.. image:: https://github.com/magcil/deepaudio-x/actions/workflows/publish.yml/badge.svg
   :target: https://github.com/magcil/deepaudio-x/actions/workflows/publish.yml
   :alt: Publish

DeepAudio-X is a self-supervised audio toolkit for audio classification and related
tasks.

This documentation helps you get started with DeepAudio-X. The :doc:`About <about>`
page provides an overview of the project, :doc:`Installation <installation>`
explains how to set it up, and the :doc:`API Reference <api-reference>` documents
the public Python interface. For more details and updates, see the
`DeepAudio-X GitHub repository <https://github.com/magcil/deepaudio-x>`_.

.. toctree::
   :maxdepth: 4
   :hidden:
   :caption: Contents:

   about
   installation
   api-reference
   tutorials/index
   contributing
   citation