jams.eval.transcription

jams.eval.transcription(ref, est, **kwargs)

Note transcription evaluation

Parameters:

ref : jams.Annotation

Reference annotation object

est : jams.Annotation

Estimated annotation object

kwargs

Additional keyword arguments

Returns:

scores : dict

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

See also

mir_eval.transcription.evaluate

Examples

>>> # Load in the JAMS objects
>>> ref_jam = jams.load('reference.jams')
>>> est_jam = jams.load('estimated.jams')
>>> # Select the first relevant annotations. You can use any annotation
>>> # type that can be converted to pitch_contour (such as pitch_midi)
>>> ref_ann = ref_jam.search(namespace='pitch_contour')[0]
>>> est_ann = est_jam.search(namespace='note_hz')[0]
>>> scores = jams.eval.transcription(ref_ann, est_ann)