What does this PR do?

Removes docstring mistake. Average micro is not available for auroc.

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?

Sure!

Codecov Report

Merging #1187 (35b6bcb) into master (13f19e5) will decrease coverage by 43%. The diff coverage is n/a.

@@           Coverage Diff            @@
##           master   #1187     +/-   ##
========================================
- Coverage      94%     51%    -43%     
========================================
  Files         185     185             
  Lines        8389    8389             
========================================
- Hits         7880    4294   -3586     
- Misses        509    4095   +3586     

Hi @lukasfolle, thanks for wanting to contribute. Actually, average='micro' is an valid option, however only when data is multilabel: https://github.com/Lightning-AI/metrics/blob/35b6bcbb982c4b26969da690db934fee1b4d2eca/src/torchmetrics/functional/classification/auroc.py#L119-L121 this is also stated in the docstring. Additionally, we are refactoring the hole classification package in this PR https://github.com/Lightning-AI/metrics/pull/1195 splitting auroc into a binary_auroc, multiclass_auroc, multilabel_auroc where it will be more clear that average='micro' is only a valid option in the multilabel case. Closing PR.