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 (27,554 stars) (9,174 forks)batch import
Docgood first issue

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

Tech stack
pythonpytorch
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests documentation for config files, specifically a README in configs/common. Go to the repository's configs/common directory and review the existing config files. Identify the key differences between files like retinanet, faster rcnn, etc. Write a short summary explaining the purpose of each file and how they differ. Check if there are any existing READMEs elsewhere for reference. The deliverable is a simple markdown file added to that directory.