open-mmlab / open-mmlab/mmengine

Config 文档说明不同格式 config 之间功能性上的差异

Open
#26 0 comments 0 reactions 1 assignee View on GitHub

@HAOCHENYE is already working on this.

Since Feb 17, 2022.

documentation P2
Dominant language
Python
Stars
1.5k
Forks
464
No merged PRs in 30d

Description

YAML/JSON/PY 格式支持的 config 内容范围是不一样的，例如 JSON 格式中不支持 tuple，因此 PY config 中的 tuple 在dump 到 JSON 以后会变成 list。
除此之外，还有一些功能性接口是针对 python config 支持的，这种情况下，接口和文档应当予以说明。
在 API 文档或者 config 教程中，应当清晰地列出对不同格式 config 的支持程度，以及不同格式 config 的局限性/差异性。

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.