[Docs] Add README for examples (open-mmlab#1295)

Author: zhouzaida

.pre-commit-config-zh-cn.yaml

@@ -58,4 +58,8 @@ repos:
     rev: v0.812
     hooks:
       - id: mypy
-        exclude: "docs"
+        exclude: |-
+          (?x)(
+              ^examples
+              | ^docs
+          )

.pre-commit-config.yaml

@@ -58,4 +58,8 @@ repos:
     rev: v0.812
     hooks:
       - id: mypy
-        exclude: "docs"
+        exclude: |-
+          (?x)(
+              ^examples
+              | ^docs
+          )

examples/segmentation/README.md

@@ -20,16 +20,16 @@ odl get CamVid -d data
 tar -xzvf data/CamVid/raw/CamVid.tar.gz.00 -C ./data
 ```
 
-## Run the example
+## Run the Example
 
 Single device training
 
 ```bash
-python examples/segmentation/segmentation_training.py
+python examples/segmentation/train.py
 ```
 
 Distributed data parallel training
 
 ```bash
-tochrun -nnodes 1 -nproc_per_node 8 examples/segmentation/segmentation_training.py --launcher pytorch
+tochrun -nnodes 1 -nproc_per_node 8 examples/segmentation/train.py --launcher pytorch
 ```

examples/segmentation/train.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Segmentation Task Example\n",
+    "# Train a Segmentation Model\n",
     "\n",
     "This segmentation task example will be divided into the following steps:\n",
     "\n",

examples/text_classification/README.md

@@ -0,0 +1,31 @@
+# Train a Text Classification Model
+
+## Install Dependencies
+
+- Build MMEngine from Source
+
+  ```bash
+  git clone https://github.com/open-mmlab/mmengine.git
+  cd mmengine
+  pip install -e . -v
+  ```
+
+- Install thirty-party libraries
+
+  ```bash
+  pip install datasets transformers
+  ```
+
+## Run the Example
+
+- Single device training
+
+  ```bash
+  python examples/text_classification/train.py
+  ```
+
+- Distributed data parallel training
+
+  ```bash
+  tochrun -nnodes 1 -nproc_per_node 8 examples/text_classification/train.py --launcher pytorch
+  ```

examples/text_classification.py renamed to examples/text_classification/train.py

@@ -0,0 +1,31 @@
+# Train a Text Translation Model
+
+## Install Dependencies
+
+- Build MMEngine from Source
+
+  ```bash
+  git clone https://github.com/open-mmlab/mmengine.git
+  cd mmengine
+  pip install -e . -v
+  ```
+
+- Install thirty-party libraries
+
+  ```bash
+  pip install datasets transformers torchtext
+  ```
+
+## Run the Example
+
+- Single device training
+
+  ```bash
+  python examples/text_translation/train.py
+  ```
+
+- Distributed data parallel training
+
+  ```bash
+  tochrun -nnodes 1 -nproc_per_node 8 examples/text_translation/train.py --launcher pytorch
+  ```