Lightning-AI / Lightning-AI/torchmetrics

Supporting mask

Open
#1,282 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Python
Stars
2.5k
Forks
526
Avg merge
6d 11h
Merged PRs (30d)
5

Description

## 🚀 Feature

In addition to `ignore_index`, metrics should also support masks, which are more robust.

I posted this reply under a closed issue https://github.com/Lightning-AI/metrics/issues/54#issuecomment-1275195071, but it might have been overlooked because it's closed. So just wanted to draw attention to this. Feel free to close this and reopen the original issue, if appropriate.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing ignore_index behavior in the metrics code and the discussion in issue #54, which this request references. Determine which metrics and APIs are in scope for mask support, then define completion by covering the agreed cases with tests and documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
machine-learning
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.