From 416103adc81dee8f4c63f1fbbc5a93f28ef5ccf4 Mon Sep 17 00:00:00 2001 From: BigDong Date: Wed, 30 Mar 2022 22:57:19 +0800 Subject: [PATCH] [Docs] Add brief installation steps in README(_zh-CN).md (#62) * [Docs] Add brief installation steps in README(_zh-CN).md * minor fix --- README.md | 22 +++++++++++++++++++++- README_zh-CN.md | 21 ++++++++++++++++++++- 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 93d1074..44edd4e 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,27 @@ Supported algorithms: ## Installation & Dataset Preparation -Please refer to [install.md](docs/install.md) for installation of mmfewshot and [data preparation](tools/data/README.md) for dataset preparation. +MMFewShot depends on [PyTorch](https://pytorch.org/) and [MMCV](https://github.com/open-mmlab/mmcv). +Below are quick steps for installation. +Please refer to [install.md](/docs/en/install.md) for installation of MMFewShot and [data preparation](tools/data/README.md) for dataset preparation. +```shell +conda create -n openmmlab python=3.7 -y +conda activate openmmlab + +conda install pytorch==1.7.0 torchvision==0.8.0 torchaudio==0.7.0 cudatoolkit=10.1 -c pytorch + +# install the latest mmcv +pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.7.0/index.html + +# install mmclassification mmdetection +pip install mmcls mmdet + +# install mmfewshot +git clone https://github.com/open-mmlab/mmfewshot.git +cd mmfewshot +pip install -r requirements/build.txt +pip install -v -e . # or "python setup.py develop" +``` ## Getting Started diff --git a/README_zh-CN.md b/README_zh-CN.md index 05e6b44..6e7fbba 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -97,7 +97,26 @@ MMFewShot 是一款基于 PyTorch 的少样本学习代码库,是 [OpenMMLab]( ## 安装与准备数据集 -请参考[安装文档](docs/install.md)进行安装和参考[数据准备](tools/data/README.md)准备数据集。 +MMFewShot 依赖 [PyTorch](https://pytorch.org/) 和 [MMCV](https://github.com/open-mmlab/mmcv) ,以下是安装的简要步骤。 +请参考[安装文档](docs/zh_cn/install.md)进行安装和参考[数据准备](tools/data/README.md)准备数据集。 +```shell +conda create -n openmmlab python=3.7 -y +conda activate openmmlab + +conda install pytorch==1.7.0 torchvision==0.8.0 torchaudio==0.7.0 cudatoolkit=10.1 -c pytorch + +# install the latest mmcv +pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.7.0/index.html + +# install mmclassification mmdetection +pip install mmcls mmdet + +# install mmfewshot +git clone https://github.com/open-mmlab/mmfewshot.git +cd mmfewshot +pip install -r requirements/build.txt +pip install -v -e . # or "python setup.py develop" +``` ## 快速入门 如果初次了解少样本学习,你可以从[基础介绍](docs/en/intro.md)开始了解少样本学习的基本概念和 MMFewShot 的框架。