Skip to main content

Load and publish databases in audformat

Project description

Test status code coverage audb's documentation audbs's supported Python versions audb's MIT 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 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.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Version 1.5.0 (2023-04-27)

  • Added: support loading and publishing of database attachments (audformat.Attachment)

  • Added: audb.load_attachment() to load a single attachment of a database

  • Added: audb.info.attachments() to return the attachments entry of a database header

  • Added: attachments argument to audb.load() to load only specific attachments of a database

  • Changed: raise RuntimeError in audb.publish() if the file extension of a media file contains uppercase letters

  • Changed: raise RuntimeError in audb.publish() if a table ID or attachment ID contains a character not in [A-Za-z0-9._-]

  • Changed: raise ValueError in audb.publish() if version or previous_version are not conform to audeer.StrictVersion

  • Changed: use emodb v1.4.1 for documentation examples

  • Changed: require audbackend<1.0.0 as audbackend will introduce breaking changes

  • Fixed: speed up audb.load_to() when loading databases with large tables using only_metadata=True

Version 1.4.2 (2023-02-13)

  • Added: support for Python 3.10

  • Added: document optional needed overwrite permissions for audb.publish() when continuing a canceled publishing command

  • Changed: require audbackend>=0.3.17

  • Changed: split API documentation into sub-pages for each function

Version 1.4.1 (2022-10-17)

  • Changed: audb.load() and audb.load_to() extract archives in the corresponding database folder inside the audb cache instead of the system-wide temporary folder

Version 1.4.0 (2022-08-18)

  • Added: support for audformat’s newly introduced misc tables

  • Added: audb.info.misc_tables()

  • Added: load_tables=True argument to audb.info.header() and audb.info.schemes() specifying if misc tables used as labels in a scheme should be downloaded

  • Changed: require audformat >=0.15.2

  • Changed: use version 1.3.0 of emodb in the documentation examples

  • Removed: support for Python 3.7

Version 1.3.0 (2022-07-14)

  • Added: lock cache folder with a lock file when modifying it

  • Added: verbose argument to audb.dependencies()

  • Added: audb.info.files()

  • Added: media and tables arguments to appropriate functions in audb.info sub-module

  • Added: only_metadata argument to audb.load_to()

  • Added: audb.publish() raises ValueError if previous_version is not smaller than version

  • Changed: audb.publish() does not require unchanged media files to exists in database folder

  • Changed: audb.load() raises ValueError if a table or media file is requested that is not part of the database

  • Fixed: add missing exceptions to docstrings

Version 1.2.6 (2022-04-01)

  • Changed: use emodb v1.2.0 for examples and tests

  • Changed: depend on audobject>=0.5.0

  • Changed: depend on audformat>=0.14.0

  • Changed: depend on audeer>=1.18.0

  • Fixed: depend on audbackend>=0.3.15 to avoid the possibility of an error when requesting versions of a database

  • Fixed: add full Windows support and tests

  • Fixed: only create tmp folder when needed in audb.load()

  • Removed: include/exclude keyword arguments

  • Removed: audb.get_default_cache_root()

Version 1.2.5 (2022-02-23)

  • Fixed: make moving of local files Windows compatible

  • Fixed: create folder tree more efficiently when loading to cache

Version 1.2.4 (2022-02-07)

  • Changed: depend on audformat>=0.13.3

  • Fixed: conversion of pickle protocol 5 files to pickle protocol 4 in cache

Version 1.2.3 (2022-02-01)

  • Added: more examples to the API docstrings

  • Changed: depend on audformat>=0.13.2

  • Changed: use pickle protocol-4 for caching dependencies

Version 1.2.2 (2022-01-03)

  • Fixed: small improvements to API documentation

  • Fixed: speed up audb.load_to() storing of CSV files

Version 1.2.1 (2021-11-18)

  • Fixed: build documentation inside the release process with Python 3.8

Version 1.2.0 (2021-11-18)

  • Added: support for Python 3.9

  • Added: store file duration of the database in the duration cache of audformat.Database

  • Changed: audb.publish() now raises an error if a table contains duplicated index entries

  • Fixed: several speed ups when loading or publishing a database

  • Fixed: the root attribute of the returned database object from audb.load_to() does now point to the correct folder and not the temporal folder

  • Removed: support for Python 3.6

Version 1.1.9 (2021-08-05)

  • Added: name argument to audb.cached() to limit search to given database name

  • Changed: speedup audb.available() by 100%

  • Changed: use audiofile.duration(..., sloppy=True) for estimating durations for dependency files

  • Fixed: audb.cached() for empty or missing shared cache

Version 1.1.8 (2021-08-03)

  • Fixed: set bit_depth to 0 instead of None for non SND formats in the dependency table

Version 1.1.7 (2021-08-03)

  • Fixed: store metadata in dependency table for non SND formats like MP3 and MP4 files

Version 1.1.6 (2021-07-29)

  • Added: documentation sub-section on database duration info

  • Fixed: made compatible with future versions of pandas

  • Fixed: missing audb.Repository documentation

Version 1.1.5 (2021-05-26)

  • Fixed: audb.load() raises now error for wrong keyword argument

  • Fixed: look also in shared cache for partial loaded databases

Version 1.1.4 (2021-05-19)

  • Fixed: version number shown in the documentation table of content

Version 1.1.3 (2021-05-18)

  • Added: discussion of needed system packages for handling audio files in the documentation

  • Changed: allow only to publish portable databases

  • Fixed: macOS support by relying on new audresample version

Version 1.1.2 (2021-05-06)

  • Added: audb.load_media()

  • Added: audb.load_table()

  • Added: documentation on how to configure access rights for shared cache folder

  • Changed: speedup audb.Dependencies methods

  • Changed: speedup audb.info functions

  • Changed: audb.info uses cache as well

  • Changed: use emodb 1.1.1 in documentation

  • Changed: depend on audformat>=0.11.0

  • Fixed: allow audb.load() to work offline if database is cached

Version 1.1.1 (2021-04-30)

  • Fixed: update removal version of deprecated stuff to 1.2.0

Version 1.1.0 (2021-04-29)

  • Added: audb.Dependencies._remove()

  • Changed: audb.Dependencies internally uses pd.DataFrame instead of dict

  • Changed: store dependencies with pickle to speed up loading

  • Changed: versions of the same flavor share dependency file

  • Changed: if possible audb.load() copies tables and media files from other versions in the cache

  • Changed: audb.Dependencies._add_media() is now private

  • Changed: audb.Dependencies._add_meta() is now private

  • Changed: audb.Dependencies.is_removed renamed to audb.Dependencies.removed

  • Fixed: audb.load() considers format when searching the cache

  • Fixed: audb.load() considers format when resolving missing media

  • Fixed: audb.available() correctly returns versions of the same database from multiple repositories

  • Fixed: add missing link to emodb example repository

  • Removed: audb.Dependencies.data

Version 1.0.4 (2021-04-09)

  • Changed: audb.Dependencies.bit_depth() now always returns an integer

  • Changed: audb.Dependencies.channels() now always returns an integer

  • Changed: audb.Dependencies.duration() now always returns a float

  • Changed: audb.Dependencies.sampling_rate() now always returns an integer

  • Fixed: audb.info.duration() for databases that contain files with a duration of 0s

  • Fixed: remove dependency to fire package

Version 1.0.3 (2021-04-08)

  • Fixed: docstring of audb.exists() falsely claimed that it was not returning a boolean

  • Fixed: several typos in documentation

Version 1.0.2 (2021-04-07)

  • Fixed: renamed latest_only argument of audb.available() to only_latest as it was before

Version 1.0.1 (2021-04-07)

  • Fixed: appearance of documentation TOC by requirering docutils<0.17

Version 1.0.0 (2021-04-07)

  • Added: first public release

  • Added: audb.info.author()

  • Added: audb.info.license()

  • Added: audb.info.license_url()

  • Added: audb.info.organization()

  • Added: audb.Dependencies.archives property

  • Added: section on publication in the documentation

  • Added: introduction texts to documentation

  • Changed: raise error for conversion of non-supported format

  • Changed: audb.exists() to return bool

  • Changed: rename audb.lookup_repository() to audb.repository()

  • Changed: one combined section on load in the documentation

  • Fixed: data types in dataframe returned by audb.cached()

  • Fixed: support files stored in archives with nested folders

  • Fixed: listing of cache entries

  • Removed: command line interface

  • Removed: audb.cached_databases()

  • Removed: audb.define module

Version 0.93.0 (2021-03-29)

  • Added: complete column in audb.cached()

  • Added: previous_version argument to audb.publish()

  • Added: backward compatibility with audb <0.90

  • Changed: cache flavor path to name/version/flavor_id

  • Changed: use open source releases of audbackend, audobject, and audresample

  • Changed: require audformat>=0.10.0

  • Changed: rename audb.load_original_to() to audb.load_to()

  • Changed: shorten flavor ID in cache

  • Changed: filter operations and only_metadata no longer part of audb.Flavor

  • Deprecated: include and excldue arguments

  • Fixed: looking for latest version across repositories

  • Fixed: Flavor.destination for nested paths

  • Fixed: allow for cross-backend dependencies for audb.publish()

  • Fixed: audb.remove_media() can now be called several times

Version 0.92.1 (2021-03-19)

  • Changed: enforce mixdown=False for mono file flavors

  • Fixed: global config file was missing in PyPI package

Version 0.92.0 (2021-03-09)

  • Added: configuration file

  • Changed: use external package for backend implementations

Version 0.91.0 (2021-02-19)

  • Added: audb.Backend.latest_version()

  • Added: audb.Backend.create()

  • Added: audb.Backend.register()

  • Added: audb.lookup_repository()

  • Added: config.REPOSITORY_PUBLISH

  • Fixed: update fire dependency

  • Fixed: remove config.GROUP_ID

  • Fixed: use sphinx>=3.5.1 to fix inherited attributes in documentation

Version 0.90.3 (2021-02-01)

  • Changed: define data types when reading dependency file

Version 0.90.2 (2021-01-28)

  • Added: data-provate-local to the default repositories

Version 0.90.1 (2021-01-25)

  • Fixed: CHANGELOG

Version 0.90.0 (2021-01-22)

  • Added: initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

audb-1.5.0.tar.gz (79.7 kB view details)

Uploaded Source

Built Distribution

audb-1.5.0-py3-none-any.whl (45.7 kB view details)

Uploaded Python 3

File details

Details for the file audb-1.5.0.tar.gz.

File metadata

  • Download URL: audb-1.5.0.tar.gz
  • Upload date:
  • Size: 79.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for audb-1.5.0.tar.gz
Algorithm Hash digest
SHA256 b4806471df08ce429fdb922056dfb5f4ac0c81ff604f0e097362048f7182fb08
MD5 69d76c487c4b0d717cffa45c089b5e53
BLAKE2b-256 c5c11b39fb57e6b2070b5b444867e0c8234e204cf0707c1faafae1e815ec556f

See more details on using hashes here.

File details

Details for the file audb-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: audb-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 45.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for audb-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb53864d10c28c0d7de542d55959f1e371aff3b01f3068501e3d195142de6171
MD5 c1c52be95ce77d67e5172c622d32ac59
BLAKE2b-256 4366cce3b6726d0c21d9e4df60b1c263a135d569c59d712e7bc70690fc0d6c2f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page