updated docs and version for 0.3.2 release [ci skip]

docs/changes.rst

@@ -1,6 +1,14 @@
 Changes
 =======
 
+v0.3.2
+------
+
+- Added schemata for ``tag_urbansound`` and ``scaper`` (`PR #191 <https://github.com/marl/jams/pull/191>`_)
+- Fixed a timing bug in ``Annotation.slice`` (`PR #189 <https://github.com/marl/jams/pull/189>`_)
+- Added ``display`` mapping for ``tag_open`` namespaces (`PR #188 <https://github.com/marl/jams/pull/188>`_)
+- Updated `sortedcontainers` dependency to avoid deprecations (`PR #187 <https://github.com/marl/jams/pull/187>`_)
+
 v0.3.1
 ------
 

docs/namespaces/misc.rst

@@ -17,6 +17,7 @@ Each observation value must be an array of at least one number.  Different obser
 may have different length arrays, so it is up to the user to verify that arrays have the
 desired length.
 
+
 Blob
 ~~~~
 
@@ -34,3 +35,37 @@ output data that does not fit any particular task schema, such as regression tar
 
 It is strongly advised that the AnnotationMetadata for blobs be as explicit as possible.
 
+
+Scaper
+~~~~~~
+
+Structured representation for soundscapes synthesized by the Scaper_ package.
+
+    ===== ======== ================ ==========
+    time  duration value            confidence
+    ===== ======== ================ ==========
+    [sec] [sec]    - label          --
+                   - source_file
+                   - source_time
+                   - event_time
+                   - event_duration
+                   - snr
+                   - time_stretch
+                   - pitch_shift
+                   - role
+    ===== ======== ================ ==========
+
+Each ``value`` field contains a dictionary with the following keys:
+
+    * ``label``: a string indicating the label of the sound source
+    * ``source_file``: a full path to the original sound source (on disk)
+    * ``source_time``: a non-negative number indicating the time offset within ``source_file`` of the sound
+    * ``event_time``: the start time of the event in the synthesized soundscape
+    * ``event_duration``: a strictly positive number indicating the duration of the event
+    * ``snr``: the signal-to-noise ratio (in LUFS) of the sound compared to the background
+    * ``time_stetch``: (optional) a strictly positive number indicating the amount of time-stretch applied to
+      the source
+    * ``pitch_shift``: (optional) the amount of pitch-shift applied to the source
+    * ``role``: one of ``background`` or ``foreground``
+
+.. _Scaper: https://scaper.readthedocs.io/en/latest/

docs/namespaces/tag.rst

@@ -338,3 +338,37 @@ The ``value`` field is constrained to the 163 genres and sub-genres of the FMA_
     5.000 25.000   "Power-Pop"        null
     9.000 35.000   "Nerdcore"         null
     ===== ======== ================== ==========
+
+tag_urbansound
+~~~~~~~~~~~~~~
+Genre classes from the UrbanSound_ dataset.
+
+    ===== ======== ================== ==========
+    time  duration value              confidence
+    ===== ======== ================== ==========
+    [sec] [sec]    string             --
+    ===== ======== ================== ==========
+
+The ``value`` field is constrained to one of ten strings:
+
+    - ``air_conditioner``
+    - ``car_horn``
+    - ``children_playing``
+    - ``dog_bark``
+    - ``drilling``
+    - ``engine_idling``
+    - ``gun_shot``
+    - ``jackhammer``
+    - ``siren``
+    - ``street_music``
+
+.. _UrbanSound: https://serv.cusp.nyu.edu/projects/urbansounddataset/
+
+*Example*
+
+    ===== ======== ============== ==========
+    time  duration value          confidence
+    ===== ======== ============== ==========
+    0.000 30.000   "street_music" null
+    ===== ======== ============== ==========
+

jams/version.py

@@ -3,4 +3,4 @@
 """Version info"""
 
 short_version = '0.3'
-version = '0.3.1'
+version = '0.3.2'