open-mmlab / open-mmlab/mmengine
[Docs] Docs review.
Open
@HAOCHENYE is already working on this.
Since Sep 2, 2022.
P0
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 464
- PR merge metrics
- No merged PRs in 30d
Description
Thanks for your error report and we appreciate it a lot.
Checklist
- I have searched related issues but cannot get the expected help.
- I have read the FAQ documentation but cannot get the expected help.
- The bug has not been fixed in the latest version.
Describe the bug
- https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/basedataset.md#%E6%95%B0%E6%8D%AE%E6%A0%87%E6%B3%A8%E6%96%87%E4%BB%B6%E8%A7%84%E8%8C%83
"标注文件必须为 json 或 yaml,yml 或 pickle,pkl 格式" -> "标注文件必须为 json 或 yaml(yml) 或 pickle(pkl) 格式" - https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/config.md#%E8%B7%A8%E9%A1%B9%E7%9B%AE%E4%BD%BF%E7%94%A8%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6
"model = get_model('mmdet::faster_rcnn/faster_rcnn_r50_fpn_1x_coco', pretrained=True)" 和在配置文件中跨库继承配置文件用法不同,这里不包含文件后缀名,是否会使用户感到混淆?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.