[Segmentation] Added generalized dice score metric

[jlcsilva]

What does this PR do?

Fixes #1089 . Didn't manage to make it work for multidimensional multilabel scenarios. However, that shouldn't a very common use case.

Before submitting

• Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure to update the docs?
• Did you write any new necessary tests?

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

[Borda]

I beilve that this shall be automatically resolved in cmd by git merge upstream/master

[jlcsilva]

I beilve that this shall be automatically resolved in cmd by git merge upstream/master

I tried that, but got merge: upstream/master - not something we can merge. Any tips? I searched the error, but I'm a bit of a git rookie, so I'm afraid I'll break stuff instead of fixing it 😅

[Borda]

@jlcsilva shall be resolved now, pls check if I did not make a mistake... 🐰

[codecov]

Codecov Report

Merging #1090 (bd375c0) into master (82ab513) will decrease coverage by 35%.
The diff coverage is 87%.

Additional details and impacted files

@@           Coverage Diff            @@
##           master   #1090     +/-   ##
========================================
- Coverage      69%     33%    -35%     
========================================
  Files         307     311      +4     
  Lines       17427   17527    +100     
========================================
- Hits        11989    5849   -6140     
- Misses       5438   11678   +6240     

[jlcsilva]

@jlcsilva shall be resolved now, pls check if I did not make a mistake... 🐰

Seems ok to me.

Also, I know why the tests are failing, but I'm unsure about what to do. In the file tests/unittests/classification/inputs.py
I changed the data type of some input tensors, such as _input_binary, from int to float, to match the description here. Since the tests are failing, I'm not sure what's wrong, the documentation or the code. Any thoughts from someone with a better overall view of the repo?

[SkafteNicki]

Hi @jlcsilva, when looking at the changes in the PR there also seems to be some changes to other metrics. Any particular reason for this?

[justusschock]

@SkafteNicki I believe they are coming from resolving the merge conflicts

[jlcsilva]

Hi @jlcsilva, when looking at the changes in the PR there also seems to be some changes to other metrics. Any particular reason for this?

In the StatScore class I added the None option for the reduce argument, which I needed for my generalized dice score implementation, and changed its documentation and that of its subclasses accordingly. Additionally, I corrected some typos and added some missing information to these classes' documentation.

Finally, I changes the data type of some test inputs to match that in the general input type documentation page, and added new multidimensional input tensors. To me, this seems to be what is making the code fail the tests. Currently, I'm out of office, but I'll check it as soon as I go back to work

[Borda]

So happy to see it landing 🤩