Metadata-Version: 2.4
Name: audb
Version: 1.12.1
Summary: Load and publish databases in audformat
Author: Johannes Wagner
Author-email: Hagen Wierstorf <hwierstorf@audeering.com>, Christian Geng <cgeng@audeering.com>
License-Expression: MIT
Project-URL: repository, https://github.com/audeering/audb/
Project-URL: documentation, https://audeering.github.io/audb/
Keywords: audio,data,dataset,annotation,mlops,machine learning
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: audbackend[all]>=2.4.0
Requires-Dist: audeer>=2.2.0
Requires-Dist: audformat>=1.4.2
Requires-Dist: audiofile>=1.0.0
Requires-Dist: audobject>=0.5.0
Requires-Dist: audresample>=0.1.6
Requires-Dist: filelock
Requires-Dist: oyaml
Requires-Dist: pandas>=2.1.0
Requires-Dist: pyarrow
Dynamic: license-file

====
audb
====

|tests| |coverage| |docs| |python-versions| |license|

**audb** manages your annotated media files.

Databases used in machine learning
should be easily exchangeable
and versioned for reproducibility.
**audb** allows both
as it stores all databases in a `common format`_
and manages different versions of a database.
Databases are stored in repositories
on local file systems,
MinIO_,
S3_,
or Artifactory_ servers.

You can request resampling or remixing of audio content
and filter the downloaded data,
e.g. if you just want to download the test set.

Have a look at the installation_ and quickstart_ instructions.


Citation
--------

If you want to cite **audb**, you can refer to our paper_:

.. code-block:: bibtex

    @article{wierstorf2023audb,
      title={audb -- Sharing and Versioning of Audio and Annotation Data in Python},
      author={Hagen Wierstorf
        and Johannes Wagner
        and Florian Eyben
        and Felix Burkhardt
        and Bj{\"o}rn W. Schuller},
      journal={arXiv preprint arXiv:2303.00645},
      year={2023},
    }


.. _Artifactory: https://jfrog.com/artifactory/
.. _common format: https://audeering.github.io/audformat/
.. _installation: https://audeering.github.io/audb/install.html
.. _MinIO: https://min.io
.. _paper: https://arxiv.org/abs/2303.00645
.. _quickstart: https://audeering.github.io/audb/quickstart.html
.. _S3: https://aws.amazon.com/s3/


.. badges images and links:
.. |tests| image:: https://github.com/audeering/audb/workflows/Test/badge.svg
    :target: https://github.com/audeering/audb/actions?query=workflow%3ATest
    :alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/audb/branch/main/graph/badge.svg?token=drrULW8vEG
    :target: https://codecov.io/gh/audeering/audb/
    :alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/audb?label=docs
    :target: https://audeering.github.io/audb/
    :alt: audb's documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :target: https://github.com/audeering/audb/blob/main/LICENSE
    :alt: audb's MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audb.svg
    :target: https://pypi.org/project/audb/
    :alt: audbs's supported Python versions
