Adding loader for BAF dataset (#583)

* Add BAF loader * Extend docstring and improve test coverage * Better check if file does not exist and improve test coverage * formatting... * Remove unused imports
mir-dataset-loaders · Mar 15, 2023 · 8c84e50 · 8c84e50
1 parent 0620b8c
commit 8c84e50
Show file tree

Hide file tree

Showing 14 changed files with 21,273 additions and 2 deletions.
diff --git a/docs/source/mirdata.rst b/docs/source/mirdata.rst
@@ -21,6 +21,14 @@ acousticbrainz_genre
    :inherited-members:
 
 
+baf
+^^^
+
+.. automodule:: mirdata.datasets.baf
+   :members:
+   :inherited-members:
+
+
 beatles
 ^^^^^^^
 

diff --git a/docs/source/quick_reference.rst b/docs/source/quick_reference.rst
@@ -108,10 +108,18 @@ Lyrics corresponding to the singing voice of the audio. These may be raw text wi
 or they may be time-aligned events. They may have varying levels of granularity (paragraph, line, word,
 phoneme, character) depending on the dataset.
 
+.. _matches:
+
+Matches
+^^^^^^^
+Music identifications in a query audio. This term is used in Audio Fingerprinting to refer to
+identifications of music from a reference database. Matches include information about which reference
+audio has been identified and the start and end times of the query match.
+
 .. _meter:
 
 Meter
-^^^^^^
+^^^^^
 Rhythmic meter for each measure. A classical example of meter in Western music would be 4/4. Details how
 many subdivisions and the length of this subdivisions that we do have per each measure.
 

diff --git a/docs/source/table.rst b/docs/source/table.rst
@@ -17,6 +17,14 @@
             :target: https://creativecommons.org/licenses/by-sa/4.0
        - :acousticbrainz:`\ `
 
+   * - BAF
+     - - audio: 🔑
+       - annotations: 🔑
+     - - :ref:`matches`
+     - 3425
+     - - .. image:: https://img.shields.io/badge/license-custom-orange
+            :target: https://zenodo.org/record/6868083
+
    * - Beatles
      - - audio: ❌
        - annotations: ✅