diff --git a/templates/2023/project/README.md b/templates/2023/project/README.md index a3fe67b..bf77619 100644 --- a/templates/2023/project/README.md +++ b/templates/2023/project/README.md @@ -3,8 +3,7 @@ No repositório do projeto, deve haver um arquivo com dados básicos do projeto e da equipe na raiz, uma pasta para cada etapa de entrega, conforme templates a seguir: * [Projeto 1](project-1/) -* [Projeto 2](project-2/) -* [Projeto Final](project-final/) +* [Projeto Final](project-2-final/) A seguir é apresentada a estrutura de pastas esperada no repositório do projeto: @@ -13,9 +12,7 @@ A seguir é apresentada a estrutura de pastas esperada no repositório do projet │ ├── project-1 <- primeira entrega - modelo conceitual e lógico │ -├── project-2 <- segunda entrega - implementação e consultas parciais -│ -└── project-final <- entrega final +└── project-2-final <- entrega final ~~~ # Modelo para Apresentação do Grupo e Trabalho @@ -24,9 +21,13 @@ A seguir é apresentada a estrutura de pastas esperada no repositório do projet # Projeto `` # Equipe `` + +# Subgrupo `` * `` - `` * `` - `` * `` - `` + +# Subgrupo `` * `` - `` * `` - `` * `` - `` diff --git a/templates/2023/project/project-2-final/README.md b/templates/2023/project/project-2-final/README.md new file mode 100644 index 0000000..3d0e1fb --- /dev/null +++ b/templates/2023/project/project-2-final/README.md @@ -0,0 +1,177 @@ +# Modelo de Apresentação da Final + +# Estrutura de Arquivos e Pastas + +A estrutura aqui apresentada é uma simplificação daquela proposta pelo [Cookiecutter Data Science](https://drivendata.github.io/cookiecutter-data-science/). Também será aceito que o projeto adote a estrutura completa do Cookiecutter Data Science e isso será considerado um diferencial. A estrutura geral é a seguinte e será detalhada a seguir: + +~~~ +├── README.md <- arquivo apresentando a proposta +│ +├── data +│ ├── external <- dados de terceiros em formato usado para entrada na transformação +│ ├── interim <- dados intermediários, e.g., resultado de transformação +│ ├── processed <- dados finais usados para a publicação +│ └── raw <- dados originais sem modificações +│ +├── notebooks <- Jupyter notebooks ou equivalentes +│ +├── slides <- arquivo de slides em formato PDF +│ +├── src <- fonte em linguagem de programação ou sistema (e.g., Orange, Cytoscape) +│ └── README.md <- instruções básicas de instalação/execução +│ +└── assets <- mídias usadas no projeto +~~~ + +Na raiz deve haver um arquivo de nome `README.md` contendo a apresentação do projeto, como detalhado na seção seguinte. + +## `data` + +Arquivos de dados usados no projeto, quando isso ocorrer. + +## `notebooks` + +Testes ou prototipos relacionados ao projeto que tenham sido executados no Jupyter. Se for SQL, deve ser colocado no notebook através do BeakerX. + +## `src` + +Projeto na linguagem escolhida caso não seja usado o notebook, incluindo todos os arquivos de dados e bibliotecas necessários para a sua execução. Só coloque código Pyhton ou Java aqui se ele não rodar dentro do notebook. + + Acrescente na raiz um arquivo `README.md` com as instruções básicas de instalação e execução. + +## `assets` + +Qualquer mídia usada no seu projeto: vídeo, imagens, animações, slides etc. Coloque os arquivos aqui (mesmo que você mantenha uma cópia no diretório do código). + +# Modelo para Apresentação da Entrega Final do Projeto + +## Motivação e Contexto + +> Descrição do tema do projeto, incluindo motivação e contexto gerador. + +## Slides + +### Apresentação Prévia +> Coloque aqui o link para o PDF da apresentação prévia + +### Apresentação Final +> Coloque aqui o link para o PDF da apresentação final + +## Modelo Conceitual + +> Coloque aqui a imagem do modelo conceitual final em ER ou UML, como o exemplo a seguir: +> ![ER Taxi](images/er-taxi.png) + +## Modelos Lógicos + +> Coloque aqui o modelo lógico relacional dos bancos de dados relacionados ao modelos conceitual. Sugere-se o formato a seguir. + +> Exemplo de modelo lógico relacional +~~~ +PESSOA(_Código_, Nome, Telefone) +ARMÁRIO(_Código_, Tamanho, Ocupante) + Ocupante chave estrangeira -> PESSOA(Código) +~~~ + +> Para o modelo de grafos de propriedades, utilize este +> [modelo de base](https://docs.google.com/presentation/d/10RN7bDKUka_Ro2_41WyEE76Wxm4AioiJOrsh6BRY3Kk/edit?usp=sharing) para construir o seu. +> Coloque a imagem do PNG do seu modelo lógico como ilustrado abaixo (a imagem estará na pasta `image`): +> +> ![Modelo Lógico de Grafos](images/modelo-logico-grafos.png) + +## Dataset Publicado +> Se ao tratar e integrar os dados originais foram produzidas novas bases relacionais ou de grafos, elencar essas bases. + +título do arquivo/base | link | breve descrição +----- | ----- | ----- +`` | `` | `` + +> Os arquivos finais do dataset publicado devem ser colocados na pasta `data`, em subpasta `processed`. Outros arquivos serão colocados em subpastas conforme seu papel (externo, interim, raw). A diferença entre externo e raw é que o raw é em formato não adaptado para uso. A pasta `raw` é opcional, pois pode ser substituída pelo link para a base original da seção anterior. +> Coloque arquivos que não estejam disponíveis online e sejam acessados pelo notebook. Relacionais (usualmente CSV), XML, JSON e CSV ou triplas para grafos. +> Este é o conjunto mínimo de informações que deve constar na disponibilização do Dataset, mas a equipe pode enriquecer esta seção. + +## Bases de Dados +> Elencar as bases de dados fonte utilizadas no projeto. + +título da base | link | breve descrição +----- | ----- | ----- +`` | `` | `` + +## Detalhamento do Projeto +> Apresente aqui detalhes do processo de construção do dataset e análise. Nesta seção ou na seção de Perguntas podem aparecer destaques de código como indicado a seguir. Note que foi usada uma técnica de highlight de código, que envolve colocar o nome da linguagem na abertura de um trecho com `~~~`, tal como `~~~python`. +> Os destaques de código devem ser trechos pequenos de poucas linhas, que estejam diretamente ligados a alguma explicação. Não utilize trechos extensos de código. Se algum código funcionar online (tal como um Jupyter Notebook), aqui pode haver links. No caso do Jupyter, preferencialmente para o Binder abrindo diretamente o notebook em questão. + +~~~python +df = pd.read_excel("/content/drive/My Drive/Colab Notebooks/dataset.xlsx"); +sns.set(color_codes=True); +sns.distplot(df.Hemoglobin); +plt.show(); +~~~ + +> Se usar Orange para alguma análise, você pode apresentar uma captura do workflow, como o exemplo a seguir e descrevê-lo: +![Workflow no Orange](images/orange-zombie-meals-prediction.png) + +> Coloque um link para o arquivo do notebook, programas ou workflows que executam as operações que você apresentar. + +> Aqui devem ser apresentadas as operações de construção do dataset: +* extração de dados de fontes não estruturadas como, por exemplo, páginas Web +* agregação de dados fragmentados obtidos a partir de API +* integração de dados de múltiplas fontes +* tratamento de dados +* transformação de dados para facilitar análise e pesquisa + +> Se for notebook, ele estará dentro da pasta `notebook`. Se por alguma razão o código não for executável no Jupyter, coloque na pasta `src` (por exemplo, arquivos do Orange ou Cytoscape). Se as operações envolverem queries executadas atraves de uma interface de um SGBD não executável no Jupyter, como o Cypher, apresente na forma de markdown. + +## Evolução do Projeto +> Relatório de evolução, descrevendo as evoluções na modelagem do projeto, dificuldades enfrentadas, mudanças de rumo, melhorias e lições aprendidas. Referências aos diagramas, modelos e recortes de mudanças são bem-vindos. +> Podem ser apresentados destaques na evolução dos modelos conceitual e lógico. O modelo inicial e intermediários (quando relevantes) e explicação de refinamentos, mudanças ou evolução do projeto que fundamentaram as decisões. +> Relatar o processo para se alcançar os resultados é tão importante quanto os resultados. + +## Perguntas de Pesquisa/Análise Combinadas e Respectivas Análises + +> Apresente os resultados da forma mais rica possível, com gráficos e tabelas. Mesmo que o seu código rode online em um notebook, copie para esta parte a figura estática. A referência a código e links para execução online pode ser feita aqui ou na seção de detalhamento do projeto (o que for mais pertinente). + +> Liste aqui as perguntas de pesquisa/análise e respectivas análises. Nem todas as perguntas precisam de queries que as implementam. É possível haver perguntas em que a solução é apenas descrita para demonstrar o potencial da base. Abaixo são ilustradas três perguntas, mas pode ser um número maior a critério da equipe. +> +### Perguntas/Análise com Resposta Implementada + +> As respostas às perguntas podem devem ser ilustradas da forma mais rica possível com tabelas resultantes, grafos ou gráficos que apresentam os resultados. Os resultados podem ser analisados e comentados. Veja um exemplo de figura ilustrando uma comunidade detectada no Cytoscape: + +> ![Comunidade no Cytoscape](images/cytoscape-comunidade.png) + +#### Pergunta/Análise 1 +> * Pergunta 1 +> +> * Explicação sucinta da análise que será feita e conjunto de queries que +> responde à pergunta. + +#### Pergunta/Análise 2 +> * Pergunta 2 +> +> * Explicação sucinta da análise que será feita e conjunto de queries que +> responde à pergunta. + +#### Pergunta/Análise 3 +> * Pergunta 3 +> +> * Explicação sucinta da análise que será feita e conjunto de queries que +> responde à pergunta. + +### Perguntas/Análise Propostas mas Não Implementadas + +#### Pergunta/Análise 1 +> * Pergunta 1 +> +> * Explicação em linhas gerais de como a base pode ser usada para responder esta pergunta e a sua relevância. + +#### Pergunta/Análise 2 +> * Pergunta 2 +> +> * Explicação em linhas gerais de como a base pode ser usada para responder esta pergunta e a sua relevância. + +#### Pergunta/Análise 3 +> * Pergunta 3 +> +> * Explicação em linhas gerais de como a base pode ser usada para responder esta pergunta e a sua relevância. + +> Coloque um link para o arquivo do notebook que executa o conjunto de queries. Ele estará dentro da pasta `notebook`. Se por alguma razão o código não for executável no Jupyter, coloque na pasta `src`. Se as queries forem executadas atraves de uma interface de um SGBD não executável no Jupyter, como o Cypher, apresente na forma de markdown. diff --git a/templates/2023/project/project-2-final/images/cytoscape-comunidade.png b/templates/2023/project/project-2-final/images/cytoscape-comunidade.png new file mode 100644 index 0000000..504c2c8 Binary files /dev/null and b/templates/2023/project/project-2-final/images/cytoscape-comunidade.png differ diff --git a/templates/2023/project/project-2-final/images/er-taxi.png b/templates/2023/project/project-2-final/images/er-taxi.png new file mode 100644 index 0000000..3572c75 Binary files /dev/null and b/templates/2023/project/project-2-final/images/er-taxi.png differ diff --git a/templates/2023/project/project-2-final/images/grafo-conhecimento-classes.png b/templates/2023/project/project-2-final/images/grafo-conhecimento-classes.png new file mode 100644 index 0000000..1dc880a Binary files /dev/null and b/templates/2023/project/project-2-final/images/grafo-conhecimento-classes.png differ diff --git a/templates/2023/project/project-2-final/images/grafo-conhecimento-exemplo.png b/templates/2023/project/project-2-final/images/grafo-conhecimento-exemplo.png new file mode 100644 index 0000000..6c3c1b0 Binary files /dev/null and b/templates/2023/project/project-2-final/images/grafo-conhecimento-exemplo.png differ diff --git a/templates/2023/project/project-2-final/images/modelo-logico-grafos.png b/templates/2023/project/project-2-final/images/modelo-logico-grafos.png new file mode 100644 index 0000000..3e25a42 Binary files /dev/null and b/templates/2023/project/project-2-final/images/modelo-logico-grafos.png differ diff --git a/templates/2023/project/project-2-final/images/modelo-logico-hierarquico.png b/templates/2023/project/project-2-final/images/modelo-logico-hierarquico.png new file mode 100644 index 0000000..79194ae Binary files /dev/null and b/templates/2023/project/project-2-final/images/modelo-logico-hierarquico.png differ diff --git a/templates/2023/project/project-2-final/images/orange-zombie-meals-prediction.png b/templates/2023/project/project-2-final/images/orange-zombie-meals-prediction.png new file mode 100644 index 0000000..924a3d5 Binary files /dev/null and b/templates/2023/project/project-2-final/images/orange-zombie-meals-prediction.png differ