Fix README.md (open-mmlab#329)

bowenroom · Jan 5, 2021 · 7c4e505 · 7c4e505
1 parent 5eafe8f
commit 7c4e505
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -89,15 +89,29 @@ Supported methods:
 
 ## Installation
 
-Please refer to [INSTALL.md](docs/install.md) for installation and dataset preparation.
+Please refer to [get_started.md](docs/get_started.md#installation) for installation and dataset preparation.
 
 ## Get Started
 
-Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMSegmentation.
-There are also tutorials for [adding new dataset](docs/tutorials/new_dataset.md), [designing data pipeline](docs/tutorials/data_pipeline.md), and [adding new modules](docs/tutorials/new_modules.md).
+Please see [train.md](docs/train.md) and [inference.md](docs/inference.md) for the basic usage of MMSegmentation.
+There are also tutorials for [customizing dataset](docs/tutorials/customize_datasets.md), [designing data pipeline](docs/tutorials/data_pipeline.md), [customizing modules](docs/tutorials/customize_models.md), and [customizing runtime](docs/tutorials/customize_runtime.md).
+We also provide many [training tricks](docs/tutorials/training_tricks.md).
 
 A Colab tutorial is also provided. You may preview the notebook [here](demo/MMSegmentation_Tutorial.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmsegmentation/blob/master/demo/MMSegmentation_Tutorial.ipynb) on Colab.
 
+## Citation
+
+If you find this project useful in your research, please consider cite:
+
+```latex
+@misc{mmseg2020,
+    title={MMSegmentation, an Open Source Semantic Segmentation Toolbox},
+    author={MMSegmentation Contributors},
+    howpublished = {\url{https://github.com/open-mmlab/mmsegmentation}},
+    year={2020}
+}
+```
+
 ## Contributing
 
 We appreciate all contributions to improve MMSegmentation. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -13,7 +13,7 @@
 
 **New Features**
 
-- Add ResNet18V1b, ResNet18V1c, ResNet50V1b OS16 models ([#316](https://github.com/open-mmlab/mmsegmentation/pull/316))
+- Add ResNet18V1b, ResNet18V1c, ResNet50V1b, ResNet101V1b models ([#316](https://github.com/open-mmlab/mmsegmentation/pull/316))
 - Support MobileNetV3 ([#268](https://github.com/open-mmlab/mmsegmentation/pull/268))
 - Add 4 retinal vessel segmentation benchmark  ([#315](https://github.com/open-mmlab/mmsegmentation/pull/315))
 - Support DMNet ([#313](https://github.com/open-mmlab/mmsegmentation/pull/313))