update readmes (#372)

mindspore-lab · Dec 30, 2022 · 974463d · 974463d
1 parent c7e7066
commit 974463d
Show file tree

Hide file tree

Showing 13 changed files with 13 additions and 140 deletions.
diff --git a/README.md b/README.md
@@ -91,13 +91,15 @@ MindSpore can be easily installed by following the official [instruction](https:
 
 The following instructions assume the desired dependency is fulfilled. 
 
-### Install with pip
-The released version of MindCV can be installed via `pip` as follows:
+### Install with PyPI
+
+The released version of MindCV can be installed via `PyPI` as follows:
 ```shell
 pip install mindcv
 ```
 
-### Install from source
+### Install from Source
+
 The latest version of MindCV can be installed as follows:
 ```shell
 pip install git+https://github.com/mindspore-lab/mindcv.git
@@ -197,7 +199,7 @@ It is easy to validate a trained model with `validate.py`.
 python validate.py --model=resnet50 --dataset=imagenet --val_split=validation --ckpt_path='./ckpt/densenet121-best.ckpt' 
 ``` 
 
-- Pynative mode with ms_function (Experiental)
+- Pynative mode with ms_function (Experimental)
 
 By default, the training pipeline (`train.py`) is run in [graph mode](https://www.mindspore.cn/tutorials/zh-CN/r1.8/advanced/pynative_graph/mode.html), which is optimized for efficienty and speed but may not be flexible enough for debugging. You may alter the parameter `--mode` to switch to pure pynative mode for debugging purpose.
 
@@ -206,6 +208,8 @@ By default, the training pipeline (`train.py`) is run in [graph mode](https://ww
 ``` shell
 python train_with_func.py --model=resnet50 --dataset=cifar10 --dataset_download  --epoch_size=10  
 ```
+>Note: `train_with_func.py` is an experimental training pipeline and is less stable than `train.py`. It will be improved after MindSpore 2.0 released.
+
 
 For more examples, see [examples/scripts](examples/scripts). 
 

diff --git a/README_CN.md b/README_CN.md
@@ -92,9 +92,10 @@ pip install -r requirements.txt
 
 之后的说明将默认用户已正确安装好相关依赖。
 
-### pip安装
+### PyPI安装
+
+MindCV的已发布版本可以通过PyPI安装。
 
-MindCV的已发布版本可以通过pip安装。
 
 ```shell
 pip install https://github.com/mindspore-lab/mindcv/releases/download/v0.0.1-beta/mindcv-0.0.1b0-py3-none-any.whl
@@ -133,7 +134,7 @@ pip install git+https://github.com/mindspore-lab/mindcv.git
 **图片分类示例**
 
 <p align="left">
-  <img src="./tutorials/data/test/dog/dog.jpg" width=360 />
+  <img src="https://user-images.githubusercontent.com/8156835/210049681-89f68b9f-eb44-44e2-b689-4d30c93c6191.jpg" width=360 />
 </p>
 
 使用加载了预训练参数的SoTA模型对一张图片进行推理。
@@ -214,6 +215,7 @@ python validate.py --model resnet50 --dataset imagenet --val_split validation --
 ```shell
 python train_with_func.py --model resnet50 --dataset cifar10 --dataset_download --epoch_size 10  
 ```
+> `train_with_func.py`为试验性的训练脚本，待MindSpore 2.0发布后改进。
 
 更多样例请参见[examples/scripts](examples/scripts)。
 

diff --git a/configs/googlenet/GoogLeNet网络.jpg b/configs/googlenet/GoogLeNet网络.jpg
diff --git a/configs/googlenet/README.md b/configs/googlenet/README.md
diff --git a/configs/inception_v3/InceptionV3网络.jpg b/configs/inception_v3/InceptionV3网络.jpg
diff --git a/configs/inception_v3/README.md b/configs/inception_v3/README.md
diff --git a/configs/inception_v4/InceptionV4.jpg b/configs/inception_v4/InceptionV4.jpg
diff --git a/configs/inception_v4/README.md b/configs/inception_v4/README.md
diff --git a/configs/repvgg/README.md b/configs/repvgg/README.md
diff --git a/configs/sknet/README.md b/configs/sknet/README.md
diff --git a/configs/xception/README.md b/configs/xception/README.md
diff --git a/configs/xception/README_CN.md b/configs/xception/README_CN.md
diff --git a/configs/xception/Xception.jpg b/configs/xception/Xception.jpg