[WIP] Implement current MIREX key scoring method and warn if using old one #339
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to solve the issue discussed in #337 in a backwards-compatible manner.
An additional argument
allow_descending_fifths
was added to thekey.weighted_score
andkey.evaluate
methods, which is set toFalse
by default (and thus being backwards-consistent), but raises a warning stating that this method is no longer used for MIREX. If set toTrue
, descending fifth errors are given a score of 0.5, matching current MIREX scoring.I'd love to get feedback on whether the maintainers approve of the way I implemented this change and whether they might have ideas how to improve keyword naming or the added documentation.
If the feedback is positive, I'll extend the tests to cover this behaviour as well.