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] Translate model analysis document to English #956

Merged
merged 9 commits into from Mar 5, 2023

Conversation

enkilee
Copy link
Contributor

@enkilee enkilee commented Feb 23, 2023

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 model analysis english doc

Modification

add model analysis english doc

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.

@zhouzaida
Copy link
Member

Please refer to #939 to update the docs/en/index.rst

docs/en/index.rst Outdated Show resolved Hide resolved
@zhouzaida
Copy link
Member

Hi, please rename docs/en/common_usage/mode_analysis.md to docs/en/common_usage/model_analysis.md.

zhouzaida
zhouzaida previously approved these changes Feb 24, 2023
Copy link
Collaborator

@HAOCHENYE HAOCHENYE left a comment

Choose a reason for hiding this comment

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

Thanks for your contributions! During the review, you've fixed some common issues that exist in both English and Chinese documents, it could be helpful to enhance the Chinese document at the same time 😄 !

Comment on lines 735 to 738
```python
print("Model Parameters:{}".format(analysis_results['params_str']))
# Model Parameters:25.557M
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggest using f-string and using '' rather than "" to describe string.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, changed it

@zhouzaida zhouzaida changed the title add model analysis english doc [Docs] Translate model analysis document to English Mar 5, 2023
@zhouzaida zhouzaida merged commit 54b6bbb into open-mmlab:main Mar 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants