jams.eval.melody

jams.eval.melody(ref, est, **kwargs)[source]

Melody extraction evaluation

Parameters:

refjams.Annotation: Reference annotation object
estjams.Annotation: Estimated annotation object
**kwargs: Additional keyword arguments

Returns:

scoresdict: Dictionary of scores, where the key is the metric name (str) and the value is the (float) score achieved.

See also

mir_eval.melody.evaluate

Examples

>>> # Load in the JAMS objects
>>> ref_jam = jams.load('reference.jams')
>>> est_jam = jams.load('estimated.jams')
>>> # Select the first relevant annotations
>>> ref_ann = ref_jam.search(namespace='pitch_contour')[0]
>>> est_ann = est_jam.search(namespace='pitch_contour')[0]
>>> scores = jams.eval.melody(ref_ann, est_ann)