open-mmlab/mmdetection

[Docs] Request to supply some comment or documentation

Aberta

#9.581 aberto em 6 de jan. de 2023

Ver no GitHubGuia do colaborador
 (4 comentários) (0 reação) (1 responsável)Python (9.820 forks)batch import
Docgood first issue

Métricas do repositório

Stars
 (32.889 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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.

Guia do colaborador

Direção de pesquisa
Examine os arquivos de configuração no diretório configs/common para identificar as principais diferenças e, em seguida, escreva um README.md resumindo essas diferenças.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90