open-mmlab / mmdetection

OpenMMLab Detection Toolbox and Benchmark
https://mmdetection.readthedocs.io
Apache License 2.0
28.5k stars 9.28k forks source link

[Docs] Request to supply some comment or documentation #9581

Open DarkerDreamer opened 1 year ago

DarkerDreamer commented 1 year ago

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.

BIGWangYuDong commented 1 year ago

The comments of the config file can be found at here: https://mmdetection.readthedocs.io/en/latest/tutorials/config.html

as for common, it is some common setting for multi-scale 3x or some other comment settings.

DarkerDreamer commented 1 year ago

Thanks for your reply. I'm still confused with what do "lsj"、“ms”、“ssj” represent for. (in directory configs/common, branch 3.x) It seems they're config files about dataset. What's their difference?

BIGWangYuDong commented 1 year ago

lsj -> Large Scale Jittering ms -> multi Scale ssj -> Standard Scale Jittering

These meanings are always shown in config/xx/README

DarkerDreamer commented 1 year ago

The READMEs are supposed to be in each directory. But acutally, at least for this case, it does not. image image


Thanks for your patience.