Adding loader for SCMS (#597)

* first commit * update on dependencies * missing track in test_loaders * fix testing hindustani track * check mypy problem * add more tests * create entry for annotation type activation in quick ref * update table, quick ref, and docstring, add test * remove deprecated functions of dataset * black --------- Co-authored-by: Magdalena Fuentes <[email protected]> Co-authored-by: Guillem Cortès <[email protected]>
mir-dataset-loaders · Nov 3, 2023 · a944318 · a944318
1 parent c1dccb0
commit a944318
Show file tree

Hide file tree

Showing 15 changed files with 35,105 additions and 3 deletions.
diff --git a/docs/source/mirdata.rst b/docs/source/mirdata.rst
@@ -368,6 +368,15 @@ saraga_hindustani
 .. automodule:: mirdata.datasets.saraga_hindustani
    :members:
    :inherited-members:
+
+
+scms
+^^^^
+
+.. automodule:: mirdata.datasets.scms
+   :members:
+   :inherited-members:
+
 
 
 slakh

diff --git a/docs/source/quick_reference.rst b/docs/source/quick_reference.rst
@@ -47,6 +47,15 @@ Here we provide a rough guide to the types in this table, but we **strongly reco
 the dataset specific documentation to ensure the data is as you expect. To see how these annotation
 types are implemented in ``mirdata`` see :ref:`annotations`.
 
+.. _events:
+
+Events
+^^^^^^
+A generic annotation to indicate whether a particular event is happening at a given time. 
+It can be used, for instance, to indicate whether a particular instrument is playing at a 
+given time-step or whether a particular note is being played at a given time-step. In fact,
+it is implicit in annotations such as F0_ or Vocal Notes_ (instrument is activated when the
+melody is non-0). However, some datasets provide it as a standalone event annotation.
 
 .. _beats:
 

diff --git a/docs/source/table.rst b/docs/source/table.rst
@@ -446,6 +446,15 @@
      - 108
      - .. image:: https://licensebuttons.net/l/by-nc-sa/4.0/80x15.png
           :target: https://creativecommons.org/licenses/by-nc-sa/4.0
+
+   * - Saraga-Carnatic-Melody-Synth (SCMS)
+     - - audio: ✅
+       - annotations: ✅
+     - - :ref:`f0`
+       - :ref:`events`
+     - 2460
+     - .. image:: https://licensebuttons.net/l/by-nc-sa/4.0/80x15.png
+          :target: https://creativecommons.org/licenses/by-nc-sa/4.0
 
    * - Slakh
      - - multitrack audio: ✅