open-mmlab/mmdetection

[Docs] Request to supply some comment or documentation

Open

#9,581 opened on Jan 6, 2023

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Python (9,174 forks)batch import
Docgood first issue

Repository metrics

Stars
 (27,554 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Branch

master branch https://mmdetection.readthedocs.io/en/latest/

📚 The doc issue

I found no comment or documentations about config files, which is inconvient. For example, what's the main difference between files in configs/common?

Suggest a potential alternative/fix

A short summary in this directory as readme.md is fine. If the information is maintained at other places, it will be appreciated to indicate where it is.

Contributor guide

Research direction
Examine the config files in the configs/common directory to identify key differences, then write a README.md summarizing those differences.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90