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 brief installation steps in README(_zh-CN).md #800

Merged
merged 2 commits into from
Mar 19, 2022

Conversation

wangruohui
Copy link
Member

No description provided.

@mm-assistant mm-assistant bot added the size/XS label Mar 17, 2022
@wangruohui wangruohui changed the title [Docs] Add brief installation in README(_zh-CN).md [Docs] Add brief installation steps in README(_zh-CN).md Mar 17, 2022
@wangruohui wangruohui merged commit 9482dde into open-mmlab:master Mar 19, 2022
Below are quick steps for installation.

**Step 1.**
Install PyTorch following [official instructions](https://pytorch.org/get-started/locally/), e.g.
Copy link

@ZwwWayne ZwwWayne Mar 23, 2022

Choose a reason for hiding this comment

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

I suggest simply putting a script here for copy-paste.

conda create -n open-mmlab python=3.7 -y
conda activate open-mmlab
conda install cudatoolkit=11.0 pytorch=1.9 -c pytorch -y
pip install openmim
mim install mmcv-full
git clone https://github.com/open-mmlab/mmediting.git
cd mmediting && pip install -e .

Copy link
Member Author

Choose a reason for hiding this comment

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

I think three pieces of code are better.

  • Github provides functions to copy by a single click, so coping three pieces does not require more effort.
  • Multiple commands are buggier when they are interrupted by errors. Command followed will still execute to cause more errors. For example if conda commands failed, the following pip install will install to another environment (probably base or the OS's python environment) and may even break that environment.
  • Multiple sections separated by functionalities are clear to show and we can also add some descriptive words.

If this is considered too long to show in README we can move it to docs.
And if one prefer conda install pytorch instead of pip, this PR #816 changed it.

@wangruohui
Copy link
Member Author

#816 further modified

Yshuo-Li pushed a commit to Yshuo-Li/mmediting that referenced this pull request Jul 15, 2022
Yshuo-Li pushed a commit to Yshuo-Li/mmediting that referenced this pull request Jul 15, 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.

2 participants