add README_CN and update README

fix readme

mindinsight/mindconverter/README.md

@@ -1,20 +1,17 @@
-### Introduction
+# MindConverter Documents
 
-MindConverter is a tool that converting PyTorch scripts to MindSpore scripts. With minial manual editing and the guidance from conversion reports, users may easily migrate their model from PyTorch framework to MindSpore.
+[查看中文](./README_CN.md)
 
+## Introduction
 
+MindConverter is a tool that converting PyTorch scripts to MindSpore scripts. With minial manual editing and the guidance from conversion reports, users may easily migrate their model from PyTorch framework to MindSpore.
 
-### Installation
+## Installation
 
 This tool is part of MindInsight and accessible to users after installing MindInsight, no extra installation is needed.
 
-### Commandline Usage
-Set the model scripts directory as the PYTHONPATH environment variable first: 
-```buildoutcfg
-export PYTHONPATH=<model scripts dir>
-```
+## Commandline Usage
 
-mindconverter commandline usage:
 ```buildoutcfg
 mindconverter [-h] [--version] --in_file IN_FILE [--output OUTPUT]
               [--report REPORT]
@@ -29,7 +26,7 @@ optional arguments:
                      directorys
 ```
 
-#### Use example:
+## Use example
 
 We have a collection of PyTorch model scripts
 ```buildoutcfg
@@ -39,9 +36,8 @@ models
 lenet.py resnet.py vgg.py
 ```
 
-Then we set the PYTHONPATH environment variable and convert alexnet.py
+Then convert lenet.py
 ```buildoutcfg
-~$ export PYTHONPATH=~/models
 ~$ mindconverter --in_file models/lenet.py
 ```
 
@@ -56,21 +52,21 @@ lenet.py
 Please checkout [models/lenet.py](../../tests/st/func/mindconverter/data/lenet_script.py) and [output/lenet.py](../../tests/st/func/mindconverter/data/lenet_converted.py) as the input/output example representatively.
 Since the conversion is not 100% flawless, we encourage users to checkout the report when fixing issues of the converted script.
 
+## Unsupported Situation1
 
-### Unsupported Situation #1
 Classes and functions that can't be converted:
+
 * The use of shape, ndim and dtype member of torch.Tensor.
 * torch.nn.AdaptiveXXXPoolXd and torch.nn.functional.adaptive_XXX_poolXd()
 * torch.nn.functional.Dropout
 * torch.unsqueeze() and torch.Tensor.unsqueeze()
 * torch.chunk() and torch.Tensor.chunk()
 
-### Unsupported Situation #2
+## Unsupported Situation2
 
 Subclassing from the subclasses of nn.Module
 
 e.g. (code snip from torchvision.models.mobilenet)
-
 ```python
 from torch import nn
 

mindinsight/mindconverter/README_CN.md

@@ -0,0 +1,80 @@
+# MindConverter 文档
+
+[View English](./README.md)
+
+## 介绍
+
+MindConverter是一款用于将PyTorch脚本转换到MindSpore脚本的工具。结合转换报告的信息，用户只需对转换后的脚本进行微小的改动，即可快速将PyTorch框架的模型迁移到MindSpore。
+
+## 安装
+
+此工具是MindInsight的一部分，安装MindInsight即可使用此工具，无需其他操作。
+
+## 命令行用法
+
+```buildoutcfg
+mindconverter [-h] [--version] --in_file IN_FILE [--output OUTPUT]
+              [--report REPORT]
+
+optional arguments:
+  -h, --help         show this help message and exit
+  --version          show program's version number and exit
+  --in_file IN_FILE  Specify path for script file.
+  --output OUTPUT    Specify path for converted script file directory. Default
+                     is output directory in the current working directory.
+  --report REPORT    Specify report directory. Default is the current working
+                     directorys
+```
+
+## 示例
+
+有如下一系列PyTorch模型的脚本，
+```buildoutcfg
+~$ ls
+models
+~$ ls models
+lenet.py resnet.py vgg.py
+```
+
+转换lenet.py这个脚本，
+```buildoutcfg
+~$ mindconverter --in_file models/lenet.py
+```
+
+可以看到生成了一个转换报告，输出了一个转换后的MindSpore脚本。
+```buildoutcfg
+~$ ls
+lenet_report.txt models output
+~$ ls output
+lenet.py
+```
+
+执行该示例时，请确认分别将[models/lenet.py](../../tests/st/func/mindconverter/data/lenet_script.py)和[output/lenet.py](../../tests/st/func/mindconverter/data/lenet_converted.py)作为输入和输出。
+由于工具转换并非100%完美，若转换后的脚本存在问题，建议用户参考转换报告对其进行修正。
+
+## 不支持的情形1
+
+部分类和方法目前无法转换：
+* 使用```torch.Tensor```的```shape```，```ndim```和```dtype```成员
+* ```torch.nn.AdaptiveXXXPoolXd```和```torch.nn.functional.adaptive_XXX_poolXd()```
+* ```torch.nn.functional.Dropout```
+* ```torch.unsqueeze()```和```torch.Tensor.unsqueeze()```
+* ```torch.chunk()```和```torch.Tensor.chunk()```
+
+## 不支持的情形2
+
+继承的父类是nn.Module的子类。
+
+例如：(如下代码片段摘自torchvision.models.mobilenet)
+```python
+from torch import nn
+
+class ConvBNReLU(nn.Sequential):
+    def __init__(self, in_planes, out_planes, kernel_size=3, stride=1, groups=1):
+        padding = (kernel_size - 1) // 2
+        super(ConvBNReLU, self).__init__(
+            nn.Conv2d(in_planes, out_planes, kernel_size, stride, padding, groups=groups, bias=False),
+            nn.BatchNorm2d(out_planes),
+            nn.ReLU6(inplace=True)
+        )
+```