Key evaluation updates by bscherrer · Pull Request #396 · CPJKU/madmom

bscherrer · 2018-11-30T19:45:08Z

separate identification of key error category and score computation: error_scores are now a class variable of the KeyEvaluation class
addition of a new type of error category: relative_of_fifth that plays well with the strict_fifth option
additional documentation for the error_type function
updates to the key evaluation test code and data files to account for the separation of the error category determination and the score to attribute to a given key error

This pull request fixes #395 .

… each error category so new files have been added to the detection folder.

…aluation class uses exactly the same error_scores

codecov · 2019-07-17T15:10:17Z

Codecov Report

Merging #396 into master will increase coverage by 0.04%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #396      +/-   ##
==========================================
+ Coverage    94.6%   94.65%   +0.04%     
==========================================
  Files          93       93              
  Lines       15078    15197     +119     
==========================================
+ Hits        14265    14384     +119     
  Misses        813      813

Impacted Files	Coverage Δ
tests/test_utils.py	`100% <ø> (ø)`	⬆️
tests/test_evaluation_key.py	`100% <100%> (ø)`	⬆️
madmom/evaluation/key.py	`96.55% <100%> (+2.52%)`	⬆️
tests/test_bin_evaluate.py	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d33863...ec67a5f. Read the comment docs.

bscherrer · 2019-07-17T15:11:57Z

Hi @fdlm (or @superbock),

Would you mind having a look at this PR ? It should be quick :)

It does preserve previous behaviour and adds functionalities that can be useful to other researchers interested in musical key detection evaluation.

If there are changes you think are needed I would be happy to discuss.

Cheers,

Thanks !

fdlm

Thanks for your work and sorry for the late reply. Your PR looks good, I'd like to request just some minor changes, then we're ready to go!

madmom/evaluation/key.py

fdlm · 2019-09-18T01:13:25Z

madmom/evaluation/key.py

-                'Relative: {:.3f}  Parallel: {:.3f}  Other: {:.3f}'.format(
-                    self.name, self.weighted, self.correct, self.fifth,
-                    self.relative, self.parallel, self.other))
+                'Relative: {:.3f}  Relative of Fifth: {:.3f} '


We should only report "Relative of Fifth" here if it is actually present in all the evaluation objects.

madmom/evaluation/key.py

superbock · 2019-10-25T10:21:17Z

What's the status of this PR? I'm preparing v0.17 and wonder if this is ready to be included.

bscherrer · 2019-10-25T13:17:49Z

I guess I have missed the v0.17 release boat, sorry ... it should be done today (Montreal time zone).

…into key_evaluation_updates

superbock · 2019-10-25T13:30:12Z

No hurry, there's still some more time until the release will be ready. I was just wondering abot the current status.

bscherrer · 2019-10-25T13:38:45Z

OK, cool. I'll still try to aim for finishing this today :) Bertrand Scherrer, Ph.D. Audio Research Scientist LANDR Audio Inc. 160 St Viateur East, Suite 809 Montreal, QC, Canada, H2T 1A8 www.landr.com

…

On Fri, Oct 25, 2019 at 9:30 AM Sebastian Böck ***@***.***> wrote: No hurry, there's still some more time until the release will be ready. I was just wondering abot the current status. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#396?email_source=notifications&email_token=ADPHIF3WLBRYKJIUY3JPUY3QQLYGNA5CNFSM4GHRDVH2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOECILKMI#issuecomment-546354481>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADPHIF562DRCPFOS2IBW2E3QQLYGNANCNFSM4GHRDVHQ> .

…is actually present in evaluation objects

… same way

bscherrer · 2019-10-28T13:24:56Z

@superbock and @fdlm all should be good now.

fdlm

Good work! Looking forward to having this merged. Just two comments to polish the code until we can include it.

Also, we should squash some of the commits before/when merging this.

madmom/evaluation/key.py

superbock · 2022-01-07T12:54:41Z

Ok, v0.17 was delayed a bit ;), but I'm currently working on getting a new version out, so I'd like to check back on this PR and its current status. @bscherrer can you comment on the two comments above? Would be really nice to have this in!

bscherrer · 2022-01-10T16:00:35Z

Hi @superbock, I will get this done this week or next. Is that OK timewise ?

…ding relative of fifth error score

fdlm

Looking good, thanks!

github-advanced-security · 2023-04-04T06:34:13Z

You have successfully added a new CodeQL configuration .github/workflows/codeql-analysis.yml:analyze/language:python. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

bscherrer added 8 commits November 23, 2018 15:44

add option to identify the relative of the fifth

cfe8b03

update tests: now the KeyEvalutation test has to check the scores for…

561c80a

… each error category so new files have been added to the detection folder.

fix naming of key detection file so that it does not break other tests

849eb19

add a check that each KeyEvaluation in a list passed to the KeyMeanEv…

30123e7

…aluation class uses exactly the same error_scores

KeyMeanEvaluation can now handle empty evaluation lists.

50b3571

Merge branch 'master' into key_evaluation_updates

0902771

fixing code style issues + "too many returns"

2fab590

pep8 fixes (take 2)

3aae767

superbock requested a review from fdlm December 1, 2018 12:05

bscherrer added 7 commits December 3, 2018 11:36

attempt at refactoring the error_types function

0ceb751

creating separate methods for each type of error

2ede2f5

decreasing number of arguments for _is_relative_of_fifth

b305019

nth refactor

e5659c8

Merge branch 'master' into key_evaluation_updates

73d8244

Merge branch 'master' into key_evaluation_updates

a176382

Merge branch 'master' into key_evaluation_updates

ec67a5f

fdlm suggested changes Sep 18, 2019

View reviewed changes

bscherrer added 3 commits October 25, 2019 09:20

Merge branch 'master' into key_evaluation_updates

f251d67

code review (quick stuff)

fe6f6d2

Merge branch 'key_evaluation_updates' of github.com:Mixgenius/madmom …

7726946

…into key_evaluation_updates

bscherrer added 4 commits October 25, 2019 12:43

fixing tostring to only display info about relative of fifth when it …

33cc362

…is actually present in evaluation objects

Really checking that all key evaluation objects are configured in the…

0e451f5

… same way

hopefully reducing the code complexity

661adcd

new attempt a diminishing complexity

5f05759

bscherrer added 3 commits October 25, 2019 16:13

fix line too long

2bc55eb

fix test

dfbf7a4

update models

2f9d65e

fdlm suggested changes Oct 30, 2019

View reviewed changes

madmom/evaluation/key.py Outdated Show resolved Hide resolved

madmom/evaluation/key.py Outdated Show resolved Hide resolved

bscherrer added 3 commits January 10, 2022 15:36

simplification of key eval objects checking + more flexible way of ad…

d6059d1

…ding relative of fifth error score

update models

04f6566

Merge branch 'master' into key_evaluation_updates

53e976a

bscherrer requested a review from fdlm January 10, 2022 20:43

fdlm approved these changes Jan 11, 2022

View reviewed changes

Comments

Conversation

bscherrer commented Nov 30, 2018

Uh oh!

codecov bot commented Jul 17, 2019

Codecov Report

Uh oh!

bscherrer commented Jul 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fdlm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fdlm Sep 18, 2019

Choose a reason for hiding this comment

Uh oh!

bscherrer Oct 25, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

superbock commented Oct 25, 2019

Uh oh!

bscherrer commented Oct 25, 2019

Uh oh!

superbock commented Oct 25, 2019

Uh oh!

bscherrer commented Oct 25, 2019 via email

Uh oh!

bscherrer commented Oct 28, 2019

Uh oh!

fdlm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

superbock commented Jan 7, 2022

Uh oh!

bscherrer commented Jan 10, 2022

Uh oh!

fdlm left a comment

Choose a reason for hiding this comment

Uh oh!

github-advanced-security bot commented Apr 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bscherrer commented Jul 17, 2019 •

edited

Loading

fdlm left a comment •

edited

Loading

fdlm left a comment •

edited

Loading