From 0a2bcfbbc97cc32abed9e172a0ca5d0f094d7031 Mon Sep 17 00:00:00 2001 From: huanghaian Date: Mon, 19 Sep 2022 15:46:45 +0800 Subject: [PATCH] fix docs of get_started.md --- demo/featmap_vis_demo.py | 2 ++ docs/en/get_started.md | 2 +- docs/zh_cn/get_started.md | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/demo/featmap_vis_demo.py b/demo/featmap_vis_demo.py index dfdb3a1b..c7b8d6ca 100644 --- a/demo/featmap_vis_demo.py +++ b/demo/featmap_vis_demo.py @@ -190,6 +190,8 @@ def main(args): visualizer.show(shown_imgs) +# Please refer to the usage tutorial: +# https://github.com/open-mmlab/mmyolo/blob/main/docs/zh_cn/user_guides/visualization.md # noqa if __name__ == '__main__': args = parse_args() main(args) diff --git a/docs/en/get_started.md b/docs/en/get_started.md index c19bb1c8..7a5586fa 100644 --- a/docs/en/get_started.md +++ b/docs/en/get_started.md @@ -74,7 +74,7 @@ To verify whether MMYOLO is installed correctly, we provide some sample codes to **Step 1.** We need to download config and checkpoint files. ```shell -mim download mmyolo --config configs/yolov5/yolov5_s-v61_syncbn_8xb16-300e_coco --dest . +mim download mmyolo --config yolov5_s-v61_syncbn_fast_8xb16-300e_coco --dest . ``` The downloading will take several seconds or more, depending on your network environment. When it is done, you will find two files `yolov5_s-v61_syncbn_8xb16-300e_coco.py` and `yolov5_s-v61_syncbn_fast_8xb16-300e_coco_20220918_084700-86e02187.pth` in your current folder. diff --git a/docs/zh_cn/get_started.md b/docs/zh_cn/get_started.md index d1a7d977..be6bf4bb 100644 --- a/docs/zh_cn/get_started.md +++ b/docs/zh_cn/get_started.md @@ -73,7 +73,7 @@ mim install "mmyolo" **步骤 1.** 我们需要下载配置文件和模型权重文件。 ```shell -mim download mmyolo --config configs/yolov5/yolov5_s-v61_syncbn_fast_8xb16-300e_coco --dest . +mim download mmyolo --config yolov5_s-v61_syncbn_fast_8xb16-300e_coco --dest . ``` 载将需要几秒钟或更长时间，这取决于你的网络环境。完成后，你会在当前文件夹中发现两个文件 `yolov5_s-v61_syncbn_fast_8xb16-300e_coco.py` and `yolov5_s-v61_syncbn_fast_8xb16-300e_coco_20220918_084700-86e02187.pth`