Skip to content

Commit

Permalink
[Docs] add brief installation steps in README.md (#265)
Browse files Browse the repository at this point in the history
  • Loading branch information
fangyixiao18 authored and YuanLiuuuuuu committed Mar 31, 2022
1 parent 29c9ed8 commit 9b04c08
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,24 @@ More algorithms are in our plan.

## Installation

Please refer to [install.md](docs/en/install.md) for installation and [prepare_data.md](docs/en/prepare_data.md) for dataset preparation.
MMSelfSup depends on [PyTorch](https://pytorch.org/)], [MMCV](https://github.com/open-mmlab/mmcv) and [MMClassification](https://github.com/open-mmlab/mmclassification).

Please refer to [install.md](docs/en/install.md) for more detailed instruction and below are quick steps for installation.

```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
mim install mmcls
git clone https://github.com/open-mmlab/mmselfsup.git
cd mmselfsup
pip3 install -e .
```

## Get Started

Please see [getting_started.md](docs/en/getting_started.md) for the basic usage of MMSelfSup.
Please refer to [prepare_data.md](docs/en/prepare_data.md) for dataset preparation and [getting_started.md](docs/en/getting_started.md) for the basic usage of MMSelfSup.

We also provides tutorials for more details:
- [config](docs/en/tutorials/0_config.md)
Expand Down
17 changes: 15 additions & 2 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,24 @@ MMSelfSup 和 OpenSelfSup 的不同点写在 [对比文档](docs/en/compatibilit

## 安装

请参考 [安装文档](docs/zh_cn/install.md) 进行安装和参考 [准备数据](docs/zh_cn/prepare_data.md) 准备数据集。
MMSelfSup 依赖 [PyTorch](https://pytorch.org/)], [MMCV](https://github.com/open-mmlab/mmcv)[MMClassification](https://github.com/open-mmlab/mmclassification).

请参考 [安装文档](docs/zh_cn/install.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
mim install mmcls
git clone https://github.com/open-mmlab/mmselfsup.git
cd mmselfsup
pip3 install -e .
```

## 快速入门

请参考 [入门指南](docs/zh_cn/getting_started.md) 获取 MMSelfSup 的基本使用方法.
请参考 [准备数据](docs/zh_cn/prepare_data.md) 准备数据集和 [入门指南](docs/zh_cn/getting_started.md) 获取 MMSelfSup 的基本使用方法.

我们也提供了更加全面的教程,包括:
- [配置文件](docs/zh_cn/tutorials/0_config.md)
Expand Down

0 comments on commit 9b04c08

Please sign in to comment.