Skip to content

Commit

Permalink
Update key scoring warning to specify future default behaviour change
Browse files Browse the repository at this point in the history
  • Loading branch information
stefan-baumann committed Jul 23, 2021
1 parent 886b3a8 commit 31729d8
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion mir_eval/key.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ def weighted_score(reference_key, estimated_key,
When specifying allow_descending_fifths=True, the scoring changes so that
keys that are a perfect fifth above or below the reference key score 0.5
points. This is consistent with the scoring used for MIREX since 2017.
In the future, the default behaviour will change to use the new method by
default.
Examples
--------
Expand Down Expand Up @@ -146,7 +148,8 @@ def weighted_score(reference_key, estimated_key,
if not allow_descending_fifths:
warnings.warn('The selected key scoring method does not match that '\
'currently used by MIREX. To use the same method, specify '\
'allow_descending_fifths=True.')
'allow_descending_fifths=True. The default behaviour will '\
'change to allow_descending_fifths=True in the future.')

validate(reference_key, estimated_key)
reference_key, reference_mode = split_key_string(reference_key)
Expand Down

0 comments on commit 31729d8

Please sign in to comment.