search

open-mmlab / mmeval

A unified evaluation library for multiple machine learning libraries
https://mmeval.readthedocs.io/en/latest/
Apache License 2.0
256 stars 49 forks source link

[Feature] Add KeypointNME #93

Closed LareinaM closed 1 year ago

LareinaM commented 1 year ago

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Add KeypointNME.

Modification

  1. Add mmeval/metrics/keypoint_nme.py
  2. Modify metric doc and __init__.py
  3. Add unit test tests/test_metrics/test_keypoint_nme.py

Related PR on MMPose

https://github.com/open-mmlab/mmpose/pull/1992 Update NME to use MMEval

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos? If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.