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

[Doc] Rewrite the installation guide #7897

Merged
merged 10 commits into from
May 13, 2022
Merged

Conversation

hellock
Copy link
Member

@hellock hellock commented May 2, 2022

Reorganize the installation guide

# Prerequisites
# Installation
## Best Practices
## Verify the installation
## Customize Installation
## FAQ

@ZwwWayne
Copy link
Collaborator

ZwwWayne commented May 2, 2022

The overall contents read very smoothly.
Just find that there is also an faq.md that records many frequently asked questions including installation and other issues. Shall we deal with these two docs, e.g., migrating the installation part in faq.md into the FAQ section of get_started.md?

@hellock
Copy link
Member Author

hellock commented May 3, 2022

Yes we can collect all issues on the FAQ page.

docs/en/get_started.md Outdated Show resolved Hide resolved
docs/en/get_started.md Outdated Show resolved Hide resolved
```shell
conda install pytorch cudatoolkit=10.1 torchvision -c pytorch
```
**Step 0.** Install [MMCV](https://github.com/open-mmlab/mmcv) using [MIM](https://github.com/open-mmlab/mim).
Copy link
Collaborator

Choose a reason for hiding this comment

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

The style is different from line 160-161, line 168-169, and line 177-187. It's better to unify them

Copy link
Collaborator

@chhluo chhluo left a comment

Choose a reason for hiding this comment

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

LGTM

docs/en/get_started.md Outdated Show resolved Hide resolved
docs/en/get_started.md Outdated Show resolved Hide resolved
docs/en/get_started.md Outdated Show resolved Hide resolved
docs/en/get_started.md Outdated Show resolved Hide resolved
eyalpe pushed a commit to eyalpe/mmdetection that referenced this pull request Jun 29, 2022
* rewrite the installation guide

* move installation trouble shooting to the FAQ page

* fix typo

* fix the config file path in the demo codes

* minor rephrases

* minor update of the doc format

* typo fix

* update fap link

* fix a typo

* update config to fix the error with anchors
ZwwWayne pushed a commit that referenced this pull request Jul 18, 2022
* rewrite the installation guide

* move installation trouble shooting to the FAQ page

* fix typo

* fix the config file path in the demo codes

* minor rephrases

* minor update of the doc format

* typo fix

* update fap link

* fix a typo

* update config to fix the error with anchors
ZwwWayne pushed a commit to ZwwWayne/mmdetection that referenced this pull request Jul 19, 2022
* rewrite the installation guide

* move installation trouble shooting to the FAQ page

* fix typo

* fix the config file path in the demo codes

* minor rephrases

* minor update of the doc format

* typo fix

* update fap link

* fix a typo

* update config to fix the error with anchors
ZwwWayne pushed a commit to ZwwWayne/mmdetection that referenced this pull request Jul 19, 2022
* rewrite the installation guide

* move installation trouble shooting to the FAQ page

* fix typo

* fix the config file path in the demo codes

* minor rephrases

* minor update of the doc format

* typo fix

* update fap link

* fix a typo

* update config to fix the error with anchors
SakiRinn pushed a commit to SakiRinn/mmdetection-locount that referenced this pull request Mar 17, 2023
* rewrite the installation guide

* move installation trouble shooting to the FAQ page

* fix typo

* fix the config file path in the demo codes

* minor rephrases

* minor update of the doc format

* typo fix

* update fap link

* fix a typo

* update config to fix the error with anchors
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

6 participants