https://github.com/audeering/audformat

Format to store media files and annotations
https://github.com/audeering/audformat

audio format machine-learning video

Last synced: 3 months ago
JSON representation

Format to store media files and annotations

• Host: GitHub
• URL: https://github.com/audeering/audformat
• Owner: audeering
• License: other
• Created: 2020-12-18T12:07:16.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2026-04-08T13:18:31.000Z (3 months ago)
• Last Synced: 2026-04-08T14:23:23.674Z (3 months ago)
• Topics: audio, format, machine-learning, video
• Language: Python
• Homepage: https://audeering.github.io/audformat/
• Size: 37.2 MB
• Stars: 12
• Watchers: 2
• Forks: 1
• Open Issues: 21
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=========

audformat

=========

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

Specification and reference implementation of **audformat**.

audformat stores media data,

such as audio, video, or text

together with corresponding annotations

in a pre-defined way.

This makes it easy to combine or replace databases

in machine learning projects.

An audformat database is a folder

that contains media files

together with a header YAML file

and one or several files storing the annotations.

The database is represented as an ``audformat.Database`` object

and can be loaded with ``audformat.Database.load()``

or written to disk with ``audformat.Database.save()``.

Have a look at the installation_ and usage_ instructions

and the `format specifications`_ as a starting point.

.. _installation: https://audeering.github.io/audformat/install.html

.. _usage: https://audeering.github.io/audformat/create-database.html

.. _format specifications: https://audeering.github.io/audformat/data-introduction.html

.. badges images and links:

.. |tests| image:: https://github.com/audeering/audformat/workflows/Test/badge.svg

    :target: https://github.com/audeering/audformat/actions?query=workflow%3ATest

    :alt: Test status

.. |coverage| image:: https://codecov.io/gh/audeering/audformat/branch/main/graph/badge.svg?token=1FEG9P5XS0

    :target: https://codecov.io/gh/audeering/audformat/

    :alt: code coverage

.. |docs| image:: https://img.shields.io/pypi/v/audformat?label=docs

    :target: https://audeering.github.io/audformat/

    :alt: audformat's documentation

.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg

    :target: https://github.com/audeering/audformat/blob/main/LICENSE

    :alt: audformat's MIT license

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audformat.svg

    :target: https://pypi.org/project/audformat/

    :alt: audformats's supported Python versions