Skip to content

[Docs] reorganize the documents in English and update the contents based on v0.5.0 status #531

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

Merged
merged 23 commits into from
Jun 7, 2022

Conversation

lvhan028
Copy link
Collaborator

@lvhan028 lvhan028 commented May 30, 2022

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

Motivation

Lots of features are being introduced to v0.5.0. And user documents should be updated accordingly.

Modification

  • README.md
  • Reorganize the structure of documents listed in docs/en/*
  • Upate get_started.md

@lvhan028 lvhan028 added the WIP label May 30, 2022
@lvhan028 lvhan028 force-pushed the update-readme branch 2 times, most recently from 14a2971 to 7191dab Compare June 1, 2022 07:15
@tpoisonooo
Copy link
Collaborator

CI link check 加一下 en 目录吧。

@tpoisonooo
Copy link
Collaborator

  • how-to-evaluate-modelhow-to-measure-performance 实际上在讲同一个命令,所以在 zh_cn 里是一个 profile_model.md
  • zh_cn 还有 ncnn 量化文档

@tpoisonooo
Copy link
Collaborator

tpoisonooo commented Jun 6, 2022

如果想中英文件名+段落完全对齐,推荐个神器 BeyondCompare,两边 setup 一下 dir 可看 diff

@lvhan028 lvhan028 closed this Jun 6, 2022
@lvhan028 lvhan028 reopened this Jun 6, 2022
@lvhan028 lvhan028 force-pushed the update-readme branch 6 times, most recently from 7807f81 to baae49e Compare June 6, 2022 12:17
@lvhan028 lvhan028 mentioned this pull request Jun 6, 2022
@lvhan028
Copy link
Collaborator Author

lvhan028 commented Jun 7, 2022

  • how-to-evaluate-modelhow-to-measure-performance 实际上在讲同一个命令,所以在 zh_cn 里是一个 profile_model.md
  • zh_cn 还有 ncnn 量化文档

这两份文档虽然是同一个test.py命令,但是测试metric,和测试速度的arguments不一样。计划暂时保留,之后再更新到一个文档中。
zh_cn 中 ncnn 文档的英文版本计划放在下一个版本中。现在有些来不及

@lvhan028 lvhan028 merged commit e929201 into open-mmlab:dev-v0.5.0 Jun 7, 2022
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.

5 participants