diff --git a/docs/zh_cn/tutorials/config.md b/docs/zh_cn/tutorials/config.md index d961d6f011868356ea96559aa776506e40cce346..92ebbd74be1081bd5f6422986337959d16a578b2 100644 --- a/docs/zh_cn/tutorials/config.md +++ b/docs/zh_cn/tutorials/config.md @@ -5,22 +5,22 @@ MMEngine 实现了抽象的é…置类(Config),为用户æä¾›ç»Ÿä¸€çš„é… åœ¨å¼€å§‹æ•™ç¨‹ä¹‹å‰ï¼Œæˆ‘们先将教程ä¸éœ€è¦ç”¨åˆ°çš„é…置文件下载到本地(建议在临时目录下执行,方便åŽç»åˆ 除示例é…置文件): ```bash -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/config_sgd.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/cross_repo.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/custom_imports.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/demo_train.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/example.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/learn_read_config.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/my_module.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/optimizer_cfg.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/predefined_var.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/refer_base_var.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/resnet50_delete_key.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/resnet50_lr0.01.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/resnet50_runtime.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/resnet50.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/runtime_cfg.py -wget https://raw.githubusercontent.com/open-mmlab/mmengine/HAOCHENY/config_docs/docs/resources/config/modify_base_var.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/config_sgd.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/cross_repo.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/custom_imports.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/demo_train.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/example.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/learn_read_config.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/my_module.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/optimizer_cfg.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/predefined_var.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/refer_base_var.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/resnet50_delete_key.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/resnet50_lr0.01.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/resnet50_runtime.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/resnet50.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/runtime_cfg.py +wget https://raw.githubusercontent.com/open-mmlab/mmengine/main/docs/resources/config/modify_base_var.py ``` ## é…ç½®æ–‡ä»¶è¯»å– diff --git a/mmengine/hub/hub.py b/mmengine/hub/hub.py index 0f57f743a9ce9b69b6190e4259523c7cad2d39d7..29897380cafcdf5393d6a492dad2c184a71c9e5e 100644 --- a/mmengine/hub/hub.py +++ b/mmengine/hub/hub.py @@ -21,10 +21,9 @@ def get_config(cfg_path: str, pretrained: bool = False) -> Config: by ``cfg.model_path``. Defaults to False. Examples: - >>> cfg = get_config('mmdet::faster_rcnn/faster_rcnn_r50_fpn_1x_coco', - >>> pretrained=True) + >>> cfg = get_config('mmdet::faster_rcnn/faster_rcnn_r50_fpn_1x_coco.py', pretrained=True) >>> # Equivalent to - >>> Config.fromfile('/path/to/faster_rcnn_r50_fpn_1x_coco.py') + >>> # cfg = Config.fromfile('/path/to/faster_rcnn_r50_fpn_1x_coco.py') >>> cfg.model_path https://download.openmmlab.com/mmdetection/v2.0/faster_rcnn/faster_rcnn_r50_fpn_1x_coco/faster_rcnn_r50_fpn_1x_coco_20200130-047c8118.pth @@ -65,9 +64,14 @@ def get_model(cfg_path: str, pretrained: bool = False, **kwargs): pretrained (bool): Whether to load pretrained model. Defaults to False. kwargs (dict): Default arguments to build model. + Examples: + >>> model = get_model('mmdet::faster_rcnn/faster-rcnn_r50_fpn_1x_coco.py', pretrained=True) + >>> type(model) + <class 'mmdet.models.detectors.faster_rcnn.FasterRCNN'> + Returns: nn.Module: Built model. - """ + """ # noqa E301 package = cfg_path.split('::')[0] with DefaultScope.overwrite_default_scope(package): # type: ignore cfg = get_config(cfg_path, pretrained)