Annotation Extensions (#504)

mir-dataset-loaders · Apr 29, 2021 · 36eeec5 · 36eeec5
1 parent b782d52
commit 36eeec5
Show file tree

Hide file tree

Showing 55 changed files with 1,721 additions and 913 deletions.
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -361,14 +361,6 @@ We've added one extra convenience flag for this test, for getting the tests runn
 
 which will skip the downloading step. Note that this is just for convenience during debugging - the tests should eventually all pass without this flag.
 
-.. _working_big_datasets:
-
-Working with big datasets
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-In the development of large datasets, it is advisable to create an index as small as possible to optimize the implementation process
-of the dataset loader and pass the tests.
-
 
 .. _reducing_test_space:
 

diff --git a/docs/source/contributing_examples/example.py b/docs/source/contributing_examples/example.py
@@ -254,8 +254,11 @@ def load_annotation(fhandle: TextIO) -> Optional[annotations.EventData]:
         intervals.append([float(line[0]), float(line[1])])
         annotation.append(line[2])
 
+    # there are several annotation types in annotations.py
+    # They should be initialized with data, followed by their units
+    # see annotations.py for a complete list of types and units.
     annotation_data = annotations.EventData(
-        np.array(intervals), np.array(annotation)
+        np.array(intervals), "s", np.array(annotation), "open"
     )
     return annotation_data
 

diff --git a/docs/source/table.rst b/docs/source/table.rst
@@ -49,7 +49,8 @@
    * - cante100
      - - audio: 🔑
        - annotations: ✅
-     - :ref:`f0`
+     - - :ref:`f0`
+       - Vocal :ref:`notes`
      - 100
      - :cante:`\ `