[Docs] Docs review.

[274869388]

Thanks for your error report and we appreciate it a lot.

Checklist

1. I have searched related issues but cannot get the expected help.
2. I have read the FAQ documentation but cannot get the expected help.
3. The bug has not been fixed in the latest version.

Describe the bug

1. 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) 格式"
2. 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)" 和在配置文件中跨库继承配置文件用法不同，这里不包含文件后缀名，是否会使用户感到混淆？

[274869388]

3. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/evaluation.md#%E6%A8%A1%E5%9E%8B%E7%B2%BE%E5%BA%A6%E8%AF%84%E6%B5%8B
   分类正确率指标（Accuracy） 链接无法访问

[274869388]

4. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/fileio.md#%E6%96%87%E4%BB%B6%E8%AF%BB%E5%86%99
   “文件读写模块还支持从多种文件 存储后端读写文件” -> “文件读写模块还支持从多种文件存储后端读写文件” 中间多了个空格

[274869388]

5. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/fileio.md#%E4%BB%8E%E5%85%B6%E5%AE%83%E6%96%87%E4%BB%B6%E5%AD%98%E5%82%A8%E5%90%8E%E7%AB%AF%E8%AF%BB%E5%86%99%E6%96%87%E4%BB%B6
   “将句柄类注册 为对应文件格式的读写句柄。” 中间多了个空格

[274869388]

6. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/evaluation.md#%E4%BD%BF%E7%94%A8%E7%A6%BB%E7%BA%BF%E7%BB%93%E6%9E%9C%E8%BF%9B%E8%A1%8C%E8%AF%84%E6%B5%8B
   这里的例子 test_data 是否可以说明一下来源，或者说直接实例化一个？感觉看到这里不明白要如何获取这个 pkl 文件

[274869388]

7. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/hook.md#checkpointhook
   “这三者用来判断 save_bes 的值是越大越好还是越小越好” 这里 save_best

[274869388]

8. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/logging.md#%E7%81%B5%E6%B4%BB%E7%9A%84%E6%97%A5%E5%BF%97%E7%BB%9F%E8%AE%A1%E6%96%B9%E5%BC%8F
   "处理一个 batch 数据（包括数据加载和模型前向推理）的平局时间" -> "处理一个 batch 数据（包括数据加载和模型前向推理）的平均时间"
   “最近 window_size 次迭代，加载一个 batch 数据的平局时间” -> "最近 window_size 次迭代，加载一个 batch 数据的平均时间"
   平均时间打错了

[274869388]

9. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/logging.md#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BB%9F%E8%AE%A1%E5%86%85%E5%AE%B9
   "调用 add_scalar 接口更新日志内容" -> 代码示例中写的是 update_scalar，但是下面又说用 add_scalar

[274869388]

10. https://github.com/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/data_element.md#3-%E5%B1%9E%E6%80%A7%E7%9A%84%E5%A2%9E%E5%8A%A0%E4%B8%8E%E6%9F%A5%E8%AF%A2
    "考虑到 InstanceData 和 PixelData 支持对数据进行切片操作，为了避免 [] 用法的不一致，同时减少同种需求的不同方法，BaseDataElement 不支持像字典那样访问和设置它的属性，所以类似 BaseDataElement[name] 的取值赋值操作是不被支持的。" 这里 InstanceData 是支持像字典那样访问的，接口里有实现，BaseDataElement 不支持，这里这句话感觉前后有点不搭，很容易混淆，我看完以为是都不支持的，但是在 mmdet 里看到了以字符串访问。

[vansin]

delete the error comment in
#514

[274869388]

https://mmengine.readthedocs.io/zh_CN/latest/get_started/installation.html#docker
mmengine/docker 这里的这个链接打不开，貌似 mmengine 还没有添加 docker 构建的文件夹吧

[274869388]

https://colab.research.google.com/github/open-mmlab/mmengine/blob/main/docs/zh_cn/tutorials/get_started.ipynb
15min 上手 这个文档的 colab 打不开，看 repo 里好像也没有对应的文件

[274869388]

这里是否应该把打印注释放到上面一行，避免用户错误理解代码执行逻辑？

[cir7]

save_best 笔误

[274869388]

也可以在定义类时给定优先级

[274869388]

https://mmengine.readthedocs.io/zh_CN/latest/tutorials/evaluation.html#evaluation
这一节中这个链接打不开

[274869388]

这里的 test_data.pkl 获取方法能不能给个示例，很难理解从哪里获取这个数据

[274869388]

这里的 epoch_length 在配置文件中是不用配置的吗？感觉看起来有点迷惑，是否有语意不一致的感觉

[274869388]

这里应该注释

[274869388]

是否应该提醒大家，我们的 DataElement 的索引操作不会改变内部数据的维度？避免用户万一理解有误，比如 a = [1,2,3]; a[0] = 1 而我们这里 a[0] = [1] ？

[Tau-J]

#516

refine the translation and add a link to scheduler api page

[cir7]

截图中有水印。另外流程图也有点大，不便于阅读

[Tau-J]

这个表里所有链接都无法正常跳转

[Tau-J]

水印+1

[Tau-J]

排版错乱

[xiaoerjason]

https://mmengine.readthedocs.io/zh_CN/latest/tutorials/runner.html
"通过配置文件使用执行器",这一章节中：无法复现文中所示代码。
AttributeError: module 'mmcls.utils' has no attribute 'register_all_modules'