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 #121

Merged
merged 2 commits into from
Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,19 @@ Results and models are available in the [model zoo](/docs/en/model_zoo.md).

## Installation

Please refer to [get_started.md](/docs/en/get_started.md) for installation.
MMRazor depends on [PyTorch](https://pytorch.org/) and [MMCV](/~https://github.com/open-mmlab/mmcv).
Below are quick steps for installation.
Please refer to [get_started.md](/docs/en/get_started.md) for more detailed instruction.

```shell
conda create -n open-mmlab python=3.8 pytorch=1.10 cudatoolkit=11.3 torchvision -c pytorch -y
conda activate open-mmlab
pip3 install openmim
mim install mmcv-full
git clone /~https://github.com/open-mmlab/mmrazor.git
cd mmrazor
pip install -v -e . # or "python setup.py develop"
```

## Getting Started
Please refer to [train.md](/docs/en/train.md) and [test.md](/docs/en/test.md) for the basic usage of MMRazor. There are also tutorials:
Expand Down
13 changes: 12 additions & 1 deletion README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,18 @@ v0.1.0 版本已经在 2021.12.23 发布

## 安装

请参考 [get_started.md](/docs/en/get_started.md) 进行安装。
MMRazor 依赖 [PyTorch](https://pytorch.org/) 和 [MMCV](/~https://github.com/open-mmlab/mmcv),以下是安装的简要步骤。
更详细的安装指南请参考 [get_started.md](/docs/en/get_started.md) 。

```shell
conda create -n open-mmlab python=3.8 pytorch=1.10 cudatoolkit=11.3 torchvision -c pytorch -y
conda activate open-mmlab
pip3 install openmim
mim install mmcv-full
git clone /~https://github.com/open-mmlab/mmrazor.git
cd mmrazor
pip install -v -e . # or "python setup.py develop"
```

## 快速入门
请参考 [get_started.md](/docs/en/get_started.md) 学习 MMRazor 的基本使用。 我们也提供了一些进阶教程:
Expand Down