Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caefleury/cis-ieee-difusion-model
Repositório teste para códigos do projeto de Modelo de Difusão do branch CIS-IEEE
https://github.com/caefleury/cis-ieee-difusion-model
docker docker-compose numpy python3 tensorflow
Last synced: 4 days ago
JSON representation
Repositório teste para códigos do projeto de Modelo de Difusão do branch CIS-IEEE
- Host: GitHub
- URL: https://github.com/caefleury/cis-ieee-difusion-model
- Owner: caefleury
- Created: 2024-10-15T00:33:59.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-12T20:16:00.000Z (6 days ago)
- Last Synced: 2024-11-12T21:24:09.343Z (6 days ago)
- Topics: docker, docker-compose, numpy, python3, tensorflow
- Language: Jupyter Notebook
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CIS - IEEE Difusion Model
## Tecnologias Utilizadas
- [Docker](hhttps://www.docker.com/)
- [Tensforflow](https://www.tensorflow.org/)
## Pré-Requisitos
- Ter o docker instalado
- Ajustar direção do volume no arquivo `docker-compose.yml` para o diretório onde se encontra o modelo de difusão
## Estrutura do projeto (draft)
```bash
├── src
│ └── main-cpu.py # Script principal para execução do modelo de difusão (para o tensor flow rodar em CPU)
├── docs
│ ├── bib.md # Referências bibliográficas
│ └── main-cpu.md # Documentação do script main-cpu.py
```
## Como rodar o projeto
```bash
docker-compose up
```
## Branchs principais
### Dev
Branch de ambiente de desenvolvimento da equipe.
Toda nova funcionalidade ou correção deve primeiro ser implementada na branch `dev`.
### Main
Branch principal do repositório e representa o ambiente de produção do projeto.
## Boas Práticas de GitHub
### Novas branchs
Procure criar branchs a partir da versão dev, caso vá desenvolver alguma alteração visual ou funcional do software.
### Nomenclatura de novas branchs
Ao criar a nova branch, procure trazer significado a ela desde a sua nomeação, e aqui seguem algumas boas práticas:
#### Prefixo
Coloque um prefixo na branch, a fim de esclarecer sua intenção. Alguns exemplos abaixo:
- `feat/`: implementação de uma nova funcionalidade do software;
- `fix/`: implementação de uma correção no software;
- `docs/`: documentação de parte ou trecho do software;
- `refactor/`: refatoração de parte ou trecho do software.
#### Nome
Após o prefixo, coloque um nome declarativo ou explicativo do objetivo da branch, ou seja, um nome que diga
o que será implementado na branch. Procure escrever na convenção "kebab-case".
#### Sufixo
Após o nome, adicione um sufixo numérico, explicitando qual a issue do projeto a que se refere a nova branch.
#### Exemplo
- `feat/data-fetching-23`
- `fix/tensorflow-implementation-12`
- `refactor/extract-component-5`
### Novas issues no Project
É necessário tomar algumas atenções quanto às issues do GitHub.
#### Integração Contínua
Focando-se na boa prática de integração contínua, faz-se necessário particionar pendências e novas funcionalidades
o máximo possível, enquanto houver sentido, afim de se criar issues com menores responsabilidades, promovendo
branchs menores, PRs menores, merges mais frequentes e um código-fonte com atualizações constantes.