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 faq document #1420

Merged
merged 6 commits into from
Mar 28, 2022
Merged

[Docs] add faq document #1420

merged 6 commits into from
Mar 28, 2022

Conversation

RockeyCoss
Copy link
Contributor

@RockeyCoss RockeyCoss commented Mar 26, 2022

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 faq document and describe how to know the number of GPUs needed to train a model.
Related PR: open-mmlab/mmdetection#4045

FAQ in MMDet https://github.com/open-mmlab/mmdetection/blob/master/docs/en/faq.md.

Modification

Add faq document and describe how to know the number of GPUs needed to train a model.

Copy link
Collaborator

@Junjun2016 Junjun2016 left a comment

Choose a reason for hiding this comment

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

Add the link of FAQ to README.

docs/en/faq.md Outdated Show resolved Hide resolved
docs/zh_cn/faq.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Junjun2016 Junjun2016 left a comment

Choose a reason for hiding this comment

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

Please also add related works in PR message, e.g. FAQ in mmdet.

RockeyCoss and others added 5 commits March 27, 2022 13:58
Copy link
Collaborator

@Junjun2016 Junjun2016 left a comment

Choose a reason for hiding this comment

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

LGTM

@MeowZheng MeowZheng merged commit 1a33d50 into open-mmlab:master Mar 28, 2022
mob5566 pushed a commit to mob5566/mmsegmentation that referenced this pull request Apr 13, 2022
* [Docs] add faq document

* Update docs/en/faq.md

Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn>

* Update docs/zh_cn/faq.md

Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn>

* modify readme

* modify index.rst

Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn>
ZhimingNJ pushed a commit to AetrexTechnology/mmsegmentation that referenced this pull request Jun 29, 2022
* [Docs] add faq document

* Update docs/en/faq.md

Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn>

* Update docs/zh_cn/faq.md

Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn>

* modify readme

* modify index.rst

Co-authored-by: Junjun2016 <hejunjun@sjtu.edu.cn>
aravind-h-v pushed a commit to aravind-h-v/mmsegmentation that referenced this pull request Mar 27, 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.

3 participants