From 73053c1812a58048f45975dede2ee497e3ad9937 Mon Sep 17 00:00:00 2001
From: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Date: Fri, 24 Jun 2022 16:34:30 +0800
Subject: [PATCH] Update README (#142)
* Update README
* fix url
---
README.md | 40 ++++++++--------------------------------
1 file changed, 8 insertions(+), 32 deletions(-)
diff --git a/README.md b/README.md
index b61691b..d57e3c0 100644
--- a/README.md
+++ b/README.md
@@ -42,31 +42,25 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
1. install
-[](https://asciinema.org/a/416945)
-
- command
```bash
# install latest version of mmcv-full
> mim install mmcv-full # wheel
- # install 1.3.1
- > mim install mmcv-full==1.3.1
- # install master branch
- > mim install mmcv-full -f https://github.com/open-mmlab/mmcv.git
+ # install 1.5.0
+ > mim install mmcv-full==1.5.0
# install latest version of mmcls
> mim install mmcls
- # install 0.11.0
- > mim install mmcls==0.11.0 # v0.11.0
# install master branch
- > mim install mmcls -f https://github.com/open-mmlab/mmclassification.git
+ > mim install git+https://github.com/open-mmlab/mmclassification.git
# install local repo
> git clone https://github.com/open-mmlab/mmclassification.git
> cd mmclassification
> mim install .
# install extension based on OpenMMLab
- mim install mmcls-project -f https://github.com/xxx/mmcls-project.git
+ mim install git+https://github.com/xxx/mmcls-project.git
```
- api
@@ -77,13 +71,11 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
# install mmcv
install('mmcv-full')
- # install mmcls
# install mmcls will automatically install mmcv if it is not installed
- install('mmcv-full', find_url='https://github.com/open-mmlab/mmcv.git')
- install('mmcv-full==1.3.1', find_url='https://github.com/open-mmlab/mmcv.git')
+ install('mmcls')
# install extension based on OpenMMLab
- install('mmcls-project', find_url='https://github.com/xxx/mmcls-project.git')
+ install('git+https://github.com/xxx/mmcls-project.git')
```
@@ -91,8 +83,6 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
2. uninstall
-[](https://asciinema.org/a/416948)
-
- command
```bash
@@ -120,8 +110,6 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
3. list
-[](https://asciinema.org/a/416949)
-
- command
```bash
@@ -143,13 +131,11 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
4. search
-[](https://asciinema.org/a/416950)
-
- command
```bash
> mim search mmcls
- > mim search mmcls==0.11.0 --remote
+ > mim search mmcls==0.23.0 --remote
> mim search mmcls --config resnet18_8xb16_cifar10
> mim search mmcls --model resnet
> mim search mmcls --dataset cifar-10
@@ -168,7 +154,7 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
from mim import get_model_info
get_model_info('mmcls')
- get_model_info('mmcls==0.11.0', local=False)
+ get_model_info('mmcls==0.23.0', local=False)
get_model_info('mmcls', models=['resnet'])
get_model_info('mmcls', training_datasets=['cifar-10'])
get_model_info('mmcls', filter_conditions='batch_size>45,epochs>100')
@@ -183,8 +169,6 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
5. download
-[](https://asciinema.org/a/416951)
-
- command
```bash
@@ -206,8 +190,6 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
6. train
-[](https://asciinema.org/a/416953)
-
- command
```bash
@@ -250,8 +232,6 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
7. test
-[](https://asciinema.org/a/416955)
-
- command
```bash
@@ -296,8 +276,6 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
8. run
-[](https://asciinema.org/a/416956)
-
- command
```bash
@@ -341,8 +319,6 @@ Please refer to [installation.md](docs/en/installation.md) for installation.
9. gridsearch
-[](https://asciinema.org/a/416958)
-
- command
```bash