From d2daa8517fa5e41fa091485f1b41979e97fda010 Mon Sep 17 00:00:00 2001 From: Kenny Date: Thu, 10 Jun 2021 22:44:45 +0800 Subject: [PATCH] change order --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 07abe92..0fa5a1a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,15 @@ MIM provides a unified API for launching and installing OpenMMLab projects and t You can call training scripts, testing scripts and any other scripts under the `tools` directory of a specific codebase conveniently at anywhere. Besides, you can use `gridsearch` command for vanilla hyper-parameter search. Calling scripts via MIM is more flexible and efficient (The command will be much shorter, check [abbreviation.md](docs/abbreviation.md)). +## Build custom projects with MIM + +We provide some examples about how to build custom projects based on OpenMMLAB codebases and MIM in [MIM-Example](https://github.com/open-mmlab/mim-example). In [mmcls_custom_backbone](https://github.com/open-mmlab/mim-example/tree/master/mmcls_custom_backbone), we define a custom backbone and a classification config file that uses the backbone. To train this model, you can use the command: + +```python +# The working directory is `mim-example/mmcls_custom_backbone` +PYTHONPATH=$PWD:$PYTHONPATH mim train mmcls custom_net_config.py --work-dir tmp --gpus 1 +``` + ## Installation Please refer to [installation.md](docs/installation.md) for installation. @@ -399,16 +408,6 @@ Please refer to [installation.md](docs/installation.md) for installation. -## Build custom projects with MIM - -We provide some examples about how to build custom projects based on OpenMMLAB codebases and MIM in [MIM-Example](https://github.com/open-mmlab/mim-example). In [mmcls_custom_backbone](https://github.com/open-mmlab/mim-example/tree/master/mmcls_custom_backbone), we define a custom backbone and a classification config file that uses the backbone. To train this model, you can use the command: - -```python -# The working directory is `mim-example/mmcls_custom_backbone` -PYTHONPATH=$PWD:$PYTHONPATH mim train mmcls custom_net_config.py --work-dir tmp --gpus 1 -``` - - ## Contributing We appreciate all contributions to improve mim. Please refer to [CONTRIBUTING.md](https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md) for the contributing guideline.