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.

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

[Docs] Add analysis&msic docs #525

Merged
merged 21 commits into from
Dec 7, 2021
Merged

Conversation

Ezra-Yu
Copy link
Collaborator

@Ezra-Yu Ezra-Yu commented Nov 9, 2021

Motivation

Add docs about analysis

  • add analysis_log doc
  • add get_flops doc
  • add analysis_result doc
  • add eval_result doc
  • add msic doc

Modification

Add CN\EN analysis docs.

BC-breaking (Optional)

no.

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, like MMDet or MMSeg.
  • CLA has been signed and all committers have signed the CLA in this PR.

@codecov
Copy link

codecov bot commented Nov 9, 2021

Codecov Report

Merging #525 (83bcc7c) into master (7b37bc5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #525   +/-   ##
=======================================
  Coverage   79.75%   79.75%           
=======================================
  Files         107      107           
  Lines        6120     6120           
  Branches     1046     1046           
=======================================
  Hits         4881     4881           
  Misses       1105     1105           
  Partials      134      134           
Flag Coverage Δ
unittests 79.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b37bc5...83bcc7c. Read the comment docs.

@Ezra-Yu Ezra-Yu mentioned this pull request Nov 11, 2021
6 tasks
@Ezra-Yu Ezra-Yu added the WIP label Nov 11, 2021
@Ezra-Yu Ezra-Yu changed the title Refactor ananlysis_log and add docs [WIP] Add analysis docs Nov 11, 2021
@Ezra-Yu Ezra-Yu changed the title [WIP] Add analysis docs [WIP] Add analysis&msic docs Nov 18, 2021
@Ezra-Yu Ezra-Yu added Documentation Improvements or additions to documentation and removed WIP labels Nov 22, 2021
@Ezra-Yu Ezra-Yu requested a review from mzr1996 November 22, 2021 06:51
Copy link
Member

@mzr1996 mzr1996 left a comment

Choose a reason for hiding this comment

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

LGTM

@mzr1996 mzr1996 changed the title [WIP] Add analysis&msic docs [Docs] Add analysis&msic docs Dec 3, 2021
@mzr1996 mzr1996 merged commit fdb1783 into open-mmlab:master Dec 7, 2021
@Ezra-Yu Ezra-Yu deleted the add-analysis-docs branch July 18, 2022 08:47
mzr1996 added a commit to mzr1996/mmpretrain that referenced this pull request Nov 24, 2022
* refactor ananlysis_log and add docs

* refactor ananlysis_log and fix lint

* improve docs

* improve docs

* improve docs

* fix bugs and refactor analysis_log

* rename analysis folder to analysis_tools

* fix failure link

* add result analysis docs

* add eval-metrics docs

* add misc doc

* fix lint

* improve docs

* improve misc docs

* fix docs

* Change the `eval_options` in `tools/analysis_tools/eval_metric.py` to
`metric_options`

* Improve tutorials

Co-authored-by: mzr1996 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants