Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] Add metric doc #118

Merged
merged 5 commits into from
Aug 1, 2023
Merged

[DOC] Add metric doc #118

merged 5 commits into from
Aug 1, 2023

Conversation

Ezra-Yu
Copy link
Contributor

@Ezra-Yu Ezra-Yu commented Jul 27, 2023

Motivation

Add metric doc

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects.
  • CLA has been signed and all committers have signed the CLA in this PR.

@Ezra-Yu Ezra-Yu requested a review from gaotongxiao July 28, 2023 03:26
@gaotongxiao gaotongxiao requested a review from tonysy July 28, 2023 06:08
gaotongxiao
gaotongxiao reviewed Jul 28, 2023
View reviewed changes
Copy link
Contributor

@gaotongxiao gaotongxiao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. But I'm not sure if @tonysy wants more metric details to be covered in the docs, like https://mmocr.readthedocs.io/en/dev-1.x/basic_concepts/evaluation.html#hmeanioumetric

docs/en/user_guides/metrics.md Outdated Show resolved Hide resolved
@Ezra-Yu Ezra-Yu requested a review from gaotongxiao July 31, 2023 07:39
@gaotongxiao gaotongxiao merged commit e9b7b8a into open-compass:main Aug 1, 2023
1 check passed
go-with-me000 pushed a commit to go-with-me000/opencompass that referenced this pull request Oct 9, 2023
@Ezra-Yu @BunnyRunnerX
Add metric doc (open-compass#118)
3fc9b35 
* update

* update

* update metric docs

* update index.rst

* update metrics
liuyaox pushed a commit to liuyaox/opencompass that referenced this pull request Jun 26, 2024
@Ezra-Yu
[DOC] Add metric doc (open-compass#118)
7bff339 
* update

* update

* update metric docs

* update index.rst

* update metrics
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gaotongxiao gaotongxiao gaotongxiao approved these changes

@tonysy tonysy Awaiting requested review from tonysy

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Ezra-Yu @gaotongxiao