Update docs (open-mmlab#3549)

* Update usage and trouble shooting links * update support for pt1.6
MauroCamporeale · Aug 13, 2020 · 2e3f90c · 2e3f90c
1 parent b97322e
commit 2e3f90c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Documentation: https://mmdetection.readthedocs.io/
 MMDetection is an open source object detection toolbox based on PyTorch. It is
 a part of the OpenMMLab project developed by [Multimedia Laboratory, CUHK](http://mmlab.ie.cuhk.edu.hk/).
 
-The master branch works with **PyTorch 1.3 to 1.5**.
+The master branch works with **PyTorch 1.3 to 1.6**.
 The old v1.x branch works with PyTorch 1.1 to 1.4, but v2.0 is strongly recommended for faster speed, higher performance, better design and more friendly usage.
 
 ![demo image](resources/coco_test_12510.jpg)
@@ -111,6 +111,8 @@ Please see [getting_started.md](docs/getting_started.md) for the basic usage of
 We provide [colab tutorial](demo/MMDet_Tutorial.ipynb) for beginners.
 There are also tutorials for [finetuning models](docs/tutorials/finetune.md), [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).
 
+For trouble shooting, please refer to [trouble_shooting.md](docs/trouble_shooting.md)
+
 ## Contributing
 
 We appreciate all contributions to improve MMDetection. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -280,9 +280,10 @@ Optional arguments are:
 - `--resume-from ${CHECKPOINT_FILE}`: Resume from a previous checkpoint file.
 - `--options 'Key=value'`: Overide some settings in the used config.
 
-Difference between `resume-from` and `load-from`:
-`resume-from` loads both the model weights and optimizer status, and the epoch is also inherited from the specified checkpoint. It is usually used for resuming the training process that is interrupted accidentally.
-`load-from` only loads the model weights and the training epoch starts from 0. It is usually used for finetuning.
+**Note**:
+
+- `resume-from` loads both the model weights and optimizer status, and the epoch is also inherited from the specified checkpoint. It is usually used for resuming the training process that is interrupted accidentally.
+- For more clear usage, the original `load-from` is deprecated and you can use `--options 'load_from="path/to/you/model"'` instead. It only loads the model weights and the training epoch starts from 0 which is usually used for finetuning.
 
 ### Train with multiple machines