Insira aqui um resumo do projeto que será construído. Tente apresentar uma justificativa para o projeto. É desejável que também se insira um graphical abstract.
Nota: todo o texto abaixo é somente para entendimento do usuário do template. Por favor remova-o quando for atualizar este
README.md
.
Esse template foi inicialmente baseado no template de ciência de dados do cookiecutter, mas ao longo do tempo várias modificações foram sendo realizadas. Atualmente o template tem as seguintes características:
pyproject.toml
como centralizador de dependências;streamlit
;Para utilizar este template, você precisará de um ambiente com os seguintes softwares:
1.1.13
ou superiorÉ aconselhável o uso do pyenv
para o gerenciamento de versões do Python.
Para iniciar um novo projeto você precisa ter instalado na sua máquina as aplicações citadas na seção anterior, depois disso basta:
Pronto, acaba de criar um repositório a partir deste modelo. Para mais informações sobre o uso de templates, acesse a documentação oficial.
Depois de criar o repositório, para começar a modificá-lo e/ou contribuir com repositórios já criados, você precisa cloná-lo. Para isso, siga os seguintes passos:
git clone
e cole a URL que você copiou anteriormente:git clone git@github.com:NOME-DE-USUARIO/REPOSITORIO.git
Proto, com isso você acaba de clonar um repositório. Para mais informações sobre a clonagem de arquivos, acesse a documentação oficial.
Com o repositório clonado, você precisa navegar até a pasta local, usando o comando :
cd REPOSITORIO
Estando na pasta do repositório, basta instalar as dependências do projeto utilizando o comando:
poetry install
Ele irá instalar todas as dependências contidas no arquivo pyproject.toml
. Depois disso basta ativar o ambiente virtual criado pelo Poetry utilizando o comando:
poetry shell
Para mais informações sobre os comandos do Poetry, visite a documentação oficial.
Para contribuir com um projeto, tente utilizar uma metodologia adequada. Utilize este artigo para obter mais informações.
.
├── data/ # Diretório contendo todos os arquivos de dados
│ ├── external/ # Arquivos de dados de fontes externas
│ ├── interim/ # Arquivos de dados intermediários
│ ├── processed/ # Arquivos de dados processados
│ └── raw/ # Arquivos de dados originais, imutáveis
├── docs/ # Documentação gerada através da biblioteca mkdocs
├── models/ # Modelos treinados e serializados, predições ou resumos de modelos
├── notebooks/ # Diretório contendo todos os notebooks utilizados nos passos
├── references/ # Dicionários de dados, manuais e todo o material exploratório
├── src/ # Código fonte utilizado nesse projeto
│ ├── data/ # Classes e funções utilizadas para download e processamento de dados
│ ├── deployment/ # Classes e funções utilizadas para implantação do modelo
│ └── model/ # Classes e funções utilizadas para modelagem
├── app.py # Arquivo com o código da aplicação do streamlit
├── Procfile # Arquivo de configuração do heroku
├── pyproject.toml # Arquivo de dependências para reprodução do projeto
├── poetry.lock # Arquivo com sub-dependências do projeto principal
├── README.md # Informações gerais do projeto
└── tasks.py # Arquivo com funções para criação de tarefas utilizadas pelo invoke