diff --git a/README.md b/README.md index a1d6a5e..274bb62 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,27 @@ Repositorio de trabalho para organizacao, processamento e documentacao das analises de classificacao de imagens RGB com SVM no contexto dos dados CEAO 2026. O projeto reune apresentacoes, artigos, referencias bibliograficas, resultados gerados e arquivos Quarto/LaTeX relacionados ao desenvolvimento metodologico e a comunicacao dos resultados. +## Estrutura atual + + sensoriamento-rgb-svm/ + outputs/ + trabalho_svm_rgb_files/ + trabalho_svm_rgb_completo_files/ + docs/ + README.md + +* `outputs/`: artefatos de processamento, bases de atributos, modelos, resultados e imagens extraidas. +* `trabalho_svm_rgb.qmd`: versao principal do trabalho em Quarto. +* `trabalho_svm_rgb_completo.qmd`: versao completa do trabalho em Quarto. +* `artigo_svm_rgb.tex`: artigo em LaTeX relacionado ao experimento SVM/RGB. +* `docs/`: documentacao tecnica, autoria e historico resumido de versoes. + +## Documentacao + +* `docs/about.md`: descricao tecnica do projeto, fluxo de trabalho, dados e limitacoes. +* `docs/authors.md`: autoria, colaboradores e orientacoes de contribuicao. +* `docs/changelog.md`: historico resumido de mudancas significativas. + +## Dados brutos + +A pasta `RGB/` e o arquivo `RGB.zip` nao sao versionados por tamanho. Eles devem permanecer localmente e ser tratados como dados brutos de entrada. diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 0000000..29f67c8 --- /dev/null +++ b/docs/about.md @@ -0,0 +1,89 @@ +# Documentacao Tecnica - Sensoriamento RGB SVM + +## O que e + +Este repositorio organiza o trabalho de classificacao de imagens RGB de sensoriamento remoto com SVM, usando atributos extraidos diretamente das imagens e atributos derivados por transferencia de aprendizado. + +O objetivo e manter em um unico lugar os arquivos de analise, resultados, apresentacoes, referencias e textos academicos produzidos durante o desenvolvimento do trabalho CEAO 2026. + +Nesta fase, o projeto contem: + +* arquivos Quarto com o trabalho principal e versao completa; +* artigo em LaTeX sobre classificacao RGB com SVM; +* apresentacoes em HTML, PDF e PPTX; +* resultados em CSV e RDS; +* imagens extraidas de PDFs e figuras geradas; +* referencias bibliograficas em BibTeX; +* dados brutos RGB mantidos fora do Git por tamanho. + +## Fontes de dados + +A principal fonte de dados e a base RGB local, armazenada em `RGB/` e compactada em `RGB.zip`. Esses itens estao no `.gitignore` e nao devem ser enviados ao Gitea. + +Arquivos de apoio e referencia atualmente versionados incluem: + +| Arquivo | Conteudo | +| --- | --- | +| `datasets_2026.pdf` | Material de apoio sobre datasets | +| `galoa-proceedings--sbsr-2023--156515.pdf` | Artigo de referencia | +| `Referencias.bib` | Referencias gerais | +| `Referencias_SVM.bib` | Referencias especificas do trabalho SVM | + +## Como funciona + +O fluxo atual do projeto e: + +1. Manter os dados brutos RGB apenas localmente. +2. Extrair atributos das imagens RGB e/ou por transferencia de aprendizado. +3. Treinar e avaliar modelos SVM. +4. Registrar resultados em `outputs/`. +5. Gerar tabelas, figuras e relatorios em Quarto/HTML. +6. Consolidar a discussao no artigo e nas apresentacoes. + +## Artefatos principais + +| Caminho | Funcao | +| --- | --- | +| `trabalho_svm_rgb.qmd` | Trabalho principal em Quarto | +| `trabalho_svm_rgb.html` | Saida HTML do trabalho principal | +| `trabalho_svm_rgb_completo.qmd` | Trabalho completo em Quarto | +| `trabalho_svm_rgb_completo.html` | Saida HTML da versao completa | +| `artigo_svm_rgb.tex` | Artigo em LaTeX | +| `apresentacao_svm_rgb.qmd` | Fonte da apresentacao | +| `outputs/` | Resultados, modelos e artefatos derivados | + +## Resultados + +Os resultados estao separados entre execucoes parciais, completas e arquivos consolidados: + +* `outputs/parcial/`: resultados e modelos de uma execucao parcial. +* `outputs/completo/`: resultados e modelos da execucao completa. +* `outputs/pdf_images/`: imagens extraidas ou usadas no material. +* `outputs/resultados_modelos_rgb.csv`: resultados consolidados dos modelos RGB. +* `outputs/resultados_kfold_rgb.csv`: resultados de validacao k-fold. + +## Convencoes + +* Dados brutos volumosos devem ficar fora do Git. +* Resultados derivados podem ser versionados quando forem necessarios para reproducao do trabalho. +* Arquivos fonte de texto (`.qmd`, `.tex`, `.bib`) devem ser priorizados sobre artefatos gerados. +* Mudancas relevantes devem ser registradas em `docs/changelog.md`. + +## Limitacoes conhecidas + +1. Os dados brutos RGB nao estao no repositorio remoto. +2. A reproducao completa depende da disponibilidade local da pasta `RGB/`. +3. Algumas saidas HTML carregam pastas auxiliares geradas pelo Quarto. +4. O repositorio ainda nao possui scripts organizados em uma pasta propria de software ou processamento. +5. A organizacao fisica dos arquivos na raiz ainda pode ser melhorada em uma etapa posterior. + +## Oportunidades de melhoria + +| Prioridade | Melhoria | +| --- | --- | +| Alta | Separar arquivos em `data/`, `docs/`, `reports/`, `presentations/` e `references/` | +| Alta | Criar uma pasta `scripts/` ou `software/` para processamento reprodutivel | +| Media | Documentar comandos para regenerar os arquivos em `outputs/` | +| Media | Criar um manifesto dos dados brutos esperados | +| Baixa | Adicionar exemplos pequenos de entrada para teste | + diff --git a/docs/authors.md b/docs/authors.md new file mode 100644 index 0000000..b4e4328 --- /dev/null +++ b/docs/authors.md @@ -0,0 +1,40 @@ +# Autoria e Contribuicoes + +## Colaboradores + +| Tag | Nome | Papel inicial | +| --- | --- | --- | +| VTO | Vitor Cesa | Organizacao do repositorio, estrutura inicial, documentacao e consolidacao do trabalho SVM/RGB | + +## Instituicao e contexto + +Projeto desenvolvido no contexto do CEAO 2026 para organizar materiais, resultados e documentacao de classificacao de imagens RGB de sensoriamento remoto com SVM. + +## Como contribuir + +Ao modificar ou estender este projeto: + +1. Atualize sua copia com `git pull` antes de comecar. +2. Nao adicione `RGB/`, `RGB.zip`, `.claude/` ou materiais explicitamente ignorados. +3. Preserve os arquivos fonte editaveis (`.qmd`, `.tex`, `.bib`) sempre que alterar materiais gerados. +4. Registre mudancas relevantes em `docs/changelog.md`. +5. Use mensagens de commit curtas e objetivas. +6. Identifique o autor usando a tag do colaborador, quando houver mais pessoas no projeto. + +## Formato sugerido para mudancas de versao + + ## v - - + + ### Adicionado / Alterado / Corrigido / Removido + + - Descricao objetiva da mudanca. + +## Historico de contribuicoes + +| Versao | Autor | Data | Descricao resumida | +| --- | --- | --- | --- | +| v0.2 | VTO | 2026-06 | Criacao da pasta `docs/` com documentacao tecnica, autoria e changelog | +| v0.1 | VTO | 2026-06 | Estrutura inicial do repositorio, README e regras de `.gitignore` | + +Contribuidores futuros devem adicionar uma linha nesta tabela e criar a entrada correspondente em `docs/changelog.md`. + diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..e23acd1 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,43 @@ +# Changelog + +Todas as versoes significativas do projeto Sensoriamento RGB SVM devem ser registradas aqui. Este arquivo resume mudancas importantes de estrutura, dados, resultados e documentacao. + +Formato: + + ## v - - + + ### Adicionado / Alterado / Corrigido / Removido + + - Descricao objetiva. + +--- + +## v0.2 - VTO - 2026-06 + +### Adicionado + +* Pasta `docs/` inspirada no padrao documental do repositorio `arara_oarmp`. +* `docs/about.md` com descricao tecnica, fluxo de trabalho, artefatos, limitacoes e melhorias futuras. +* `docs/authors.md` com autoria, regras de contribuicao e historico de contribuicoes. +* `docs/changelog.md` para registro resumido de mudancas significativas. + +### Alterado + +* `README.md` atualizado com secao de estrutura, documentacao e dados brutos. + +--- + +## v0.1 - VTO - 2026-06 + +### Adicionado + +* Repositorio Git inicial. +* `README.md` com descricao do projeto. +* `.gitignore` com exclusao de `RGB/`, `RGB.zip`, `.claude/`, `artigo_KC390*` e `artigo_promethee*`. +* Primeiro commit publicado no Gitea em `main`. + +### Observacoes + +* Dados brutos RGB permanecem fora do Git por tamanho. +* Materiais dos artigos KC-390 e PROMETHEE foram mantidos fora do escopo deste repositorio. +