Merge pull request #15 from atlantico-academy/developer

Finalização do milestone: Entrega #1: Análise exploratória de dados
atlantico-academy · May 14, 2024 · 744a672 · 744a672
2 parents 148dd6f + 763d519
commit 744a672
Show file tree

Hide file tree

Showing 15 changed files with 32,218 additions and 363 deletions.
diff --git a/README.md b/README.md
@@ -1,95 +1,41 @@
-# <Título do projeto>
+<div align="center">
+
+  `D20 Dragons`
+
+  <img src="https://github.com/atlantico-academy/equipe1-2024.1/assets/94808306/a4a86016-0f78-451a-869f-d8e267fe9e3d" width="300">
+</div>
+<hr>
 
-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](https://www.elsevier.com/authors/tools-and-resources/visual-abstract).
-
-## Desenvolvedores
- - [Nome do desenvolvedor #1](url-do-github-do-desenvolvedor-#1)
- - [Nome do desenvolvedor #2](url-do-github-do-desenvolvedor-#2)
- - [Nome do desenvolvedor #3](url-do-github-do-desenvolvedor-#3)
- - [Nome do desenvolvedor #4](url-do-github-do-desenvolvedor-#4)
- - ...
-
----
-
-> **Nota**: todo o texto abaixo é somente para entendimento do usuário do template. Por favor remova-o quando for atualizar este `README.md`.
-
-## Funcionalidades
-
-Esse template foi inicialmente baseado no [template de ciência de dados do cookiecutter](https://drivendata.github.io/cookiecutter-data-science/), mas ao longo do tempo várias modificações foram sendo realizadas. Atualmente o template tem as seguintes características:
- - Utilização do arquivo `pyproject.toml` como centralizador de dependências;
- - Configuração para criação de aplicação `streamlit`;
- - Utilização de [jupyter notebooks](https://jupyter.org/) para arquivos de análise;
- - Documentação com o [mkdocs](https://www.mkdocs.org/) ([material design](https://squidfunk.github.io/mkdocs-material/) theme)
-
-## Instruções
-
-### Requisitos
-
-Para utilizar este template, você precisará de um ambiente com os seguintes softwares:
- - git
- - Python 3.8
- - Poetry `1.1.13` ou superior
-
-É aconselhável o uso do `pyenv` para o gerenciamento de versões do Python.
-
-### Iniciando um novo projeto
-
-Para iniciar um novo projeto você precisa ter instalado na sua máquina as aplicações citadas na seção anterior, depois disso basta:
-
-1. clicar no botão **Use this template** (ou "Usar este modelo").
-2. Digitar um nome para seu repositório e uma descrição opcional.
-3. Escolher a visibilidade do projeto (Publica ou privada).
-4. Clicar em **Create repository from template** (Criar repositório a partir do modelo).
-
-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](https://docs.github.com/pt/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
+# Análise de Churn de Clientes Bancários
 
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)![Matplotlib](https://img.shields.io/badge/Matplotlib-%23ffffff.svg?style=for-the-badge&logo=Matplotlib&logoColor=black)![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white)![Plotly](https://img.shields.io/badge/Plotly-%233F4F75.svg?style=for-the-badge&logo=plotly&logoColor=white)![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white)![scikit-learn](https://img.shields.io/badge/scikit--learn-%23F7931E.svg?style=for-the-badge&logo=scikit-learn&logoColor=white)
 
-### Contribuindo com um repositório já criado
+![GitHub](https://img.shields.io/github/license/atlantico-academy/equipe1-2024.1.svg) [![PyPI](https://img.shields.io/pypi/v/atlantico-academy-equipe1-2024.1.svg)](http://pypi.org/project/atlantico-academy-equipe1-2024.1/) [![GitHub last commit](https://img.shields.io/github/last-commit/atlantico-academy/equipe1-2024.1.svg)](https://github.com/atlantico-academy/equipe1-2024.1/commit/developer)
 
-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:
+**[Documentação](./docs/index.md)** | **[Dados](./docs/data.md)** | **[Execução](./docs/code.md)** | **[Insights](./docs/insight.md)**
 
-1. Acima da lista de arquivos, clique no botão **Code** (em verde).
-2. Copie a URL para o repositório.
-    - Tente clonar utilizando uma chave **SSH**. Para isso, clique na aba **SSH** e em seguida clique no ícone de cópia.
-3. Abra o terminal.
-4. Altere o diretório de trabalho atual para o local que deseja ter o diretório clonado.
-5. Digite `git clone` e cole a URL que você copiou anteriormente:
+## Contexto
 
-```
-git clone [email protected]:NOME-DE-USUARIO/REPOSITORIO.git
-```
-6. Pressione **Enter** para criar seu clone local.
-
-Proto, com isso você acaba de clonar um repositório. Para mais informações sobre a clonagem de arquivos, acesse a [documentação oficial](https://docs.github.com/pt/repositories/creating-and-managing-repositories/cloning-a-repository).
-
-Com o repositório clonado, você precisa navegar até a pasta local, usando o comando :
-
-```
-cd REPOSITORIO
-```
+Este projeto foca na análise de [churn de clientes de um banco, usando um dataset disponível no Kaggle](https://www.kaggle.com/datasets/saurabhbadole/bank-customer-churn-prediction-dataset). O objetivo é identificar padrões e fatores que influenciam os clientes a deixar o banco, utilizando técnicas de ciência de dados para processar e analisar os dados. A análise ajudará a entender melhor as necessidades dos clientes e a melhorar as estratégias de retenção.
 
-Estando na pasta do repositório, basta instalar as dependências do projeto utilizando o comando:
+## Justificativa
 
-```
-poetry install
-```
+A justificativa para este projeto se baseia na importância de manter uma base de clientes sólida para a sustentabilidade financeira do banco. Reduzir o churn pode significar maior lucratividade e satisfação do cliente, crucial em um mercado competitivo.
 
-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:
+## Graphical Abstract
 
-```
-poetry shell
-```
+![graphical-abstract-d20-dragons (2)](https://github.com/atlantico-academy/equipe1-2024.1/assets/94808306/91929679-5c3e-4da1-a552-15e85eedc700)
 
-Para mais informações sobre os comandos do Poetry, visite a [documentação oficial](https://python-poetry.org/docs/).
 
-Para contribuir com um projeto, tente utilizar uma metodologia adequada. Utilize [este artigo](https://omadson.github.io/site/blog/2022/software-development-workflow/) para obter mais informações.
+## Desenvolvedores
 
+[<img src="https://github.com/atlantico-academy/equipe1-2024.1/assets/94808306/e1af5396-1b27-46f2-9e67-bcc13049ce73"  width="150" height="150">](https://github.com/claralimasilva) | [<img src="https://github.com/atlantico-academy/equipe1-2024.1/assets/94808306/aa965a52-2d5f-4836-9ac9-ab117f913b31"  width="150" height="150">](https://github.com/matheusvazdata) |  [<img src="https://github.com/atlantico-academy/equipe1-2024.1/assets/94808306/1187a373-0dba-4430-b35b-00e2901b3bf6"  width="150" height="150">](https://github.com/matt-balda) | [<img src="https://github.com/atlantico-academy/equipe1-2024.1/assets/94808306/6023d7fa-71fa-4bf1-ab29-9b439d63e7e0"  width="150" height="150">](https://github.com/uSilas) 
+--- | --- | --- | --- 
+[Clara Lima Silva](https://github.com/claralimasilva) | [Francisco Matheus Vaz dos Santos](https://github.com/matheusvazdata) |  [Mateus Balda Mota](https://github.com/matt-balda) | [Silas Eufrásio da Silva](https://github.com/uSilas) 
 
 ### Organização de diretórios
 
-
 ```
-.
 ├── data/              # Diretório contendo todos os arquivos de dados
 │   ├── external/      # Arquivos de dados de fontes externas
 │   ├── interim/       # Arquivos de dados intermediários
@@ -109,5 +55,4 @@ Para contribuir com um projeto, tente utilizar uma metodologia adequada. Utilize
 ├── 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
-
 ```
diff --git a/data/external/dictionary.csv b/data/external/dictionary.csv
@@ -0,0 +1,13 @@
+variavel,descricao,tipo,subtipo
+Surname,O sobrenome do cliente,qualitativa,nominal
+CreditScore,O score de crédito do cliente,quantitativa,discreta
+Geography,"A localização geográfica do cliente (por exemplo, país ou região)",qualitativa,nominal
+Gender,O gênero do cliente,qualitativa,nominal
+Age,A idade do cliente,quantitativa,discreta
+Tenure,O número de anos que o cliente está no banco,quantitativa,discreta
+Balance,O saldo da conta do cliente,quantitativa,continua
+NumOfProducts,O número de produtos bancários que o cliente possui,quantitativa,discreta
+HasCrCard,Indica se o cliente possui cartão de crédito (binário: sim/não),qualitativa,nominal
+IsActiveMember,Indica se o cliente é um membro ativo (binário: sim/não),qualitativa,nominal
+EstimatedSalary,O salário estimado do cliente,quantitativa,continua
+Exited,Indica se o cliente saiu do banco (binário: sim/não),qualitativa,nominal
diff --git a/data/raw/Churn_Modelling.csv b/data/raw/Churn_Modelling.csv
@@ -5,7 +5,7 @@ RowNumber,CustomerId,Surname,CreditScore,Geography,Gender,Age,Tenure,Balance,Num
 4,15701354,Boni,699,France,Female,39,1,0,2,0,0,93826.63,0
 5,15737888,Mitchell,850,Spain,Female,43,2,125510.82,1,1,1,79084.1,0
 6,15574012,Chu,645,Spain,Male,44,8,113755.78,2,1,0,149756.71,1
-7,15592531,Bartlett,822,France,Male,50,7,0,2,1,1,10062.8,0
+7,15647311,Bartlett,822,France,Male,50,7,0,2,1,1,10062.8,0
 8,15656148,Obinna,376,Germany,Female,29,4,115046.74,4,1,0,119346.88,1
 9,15792365,He,501,France,Male,44,4,142051.07,2,0,1,74940.5,0
 10,15592389,H?,684,France,Male,27,2,134603.88,1,1,1,71725.73,0

diff --git a/docs/code.md b/docs/code.md
@@ -0,0 +1,40 @@
+# Início
+
+## Funcionalidades
+
+Essa template foi inicialmente baseado no [template de ciência de dados do cookiecutter](https://drivendata.github.io/cookiecutter-data-science/), a template tem as seguintes características:
+
+- Utilização do arquivo `pyproject.toml` como centralizador de dependências;
+- Configuração para criação de aplicação `streamlit`;
+- Utilização de [jupyter notebooks](https://jupyter.org/) para arquivos de análise;
+- Documentação com o [mkdocs](https://www.mkdocs.org/) ([material design](https://squidfunk.github.io/mkdocs-material/) theme)
+
+## Instruções
+
+### Requisitos
+
+- git
+- Python 3.10.*
+- Poetry `1.1.13` ou superior
+
+É aconselhável o uso do `pyenv` para o gerenciamento de versões do Python.
+
+### Execução
+
+Navegar até a pasta local, usando o comando :
+
+```
+cd equipe1-2024.1
+```
+
+Instalar as dependências do projeto utilizando o comando:
+
+```
+poetry install
+```
+
+Ativar o ambiente virtual criado pelo Poetry utilizando o comando:
+
+```
+poetry shell
+```
diff --git a/docs/data.md b/docs/data.md
@@ -0,0 +1,44 @@
+#Início
+
+## Conjunto de dados
+
+[Banking Customer Churn Prediction Dataset](https://www.kaggle.com/datasets/saurabhbadole/bank-customer-churn-prediction-dataset)
+
+## Variáveis
+
+#### Catacterísticas do dataset:
+
+1. **RowNumber:** o número sequencial atribuído a cada linha no conjunto de dados.
+2. **CustomerId:** um identificador exclusivo para cada cliente.
+3. **Surname:** O sobrenome do cliente.
+4. **CreditScore:** A pontuação de crédito do cliente.
+5. **Geography:** A localização geográfica do cliente (por exemplo, país ou região).
+6. **Gender:** O gênero do cliente.
+7. **Age:** A idade do cliente.
+8. **Tenure:** O número de anos que o cliente está no banco.
+9. **Balance:** O saldo da conta do cliente.
+10. **NumOfProducts:** A quantidade de produtos bancários que o cliente possui.
+11. **HasCrCard:** Indica se o cliente possui cartão de crédito (binário: sim/não).
+12. **IsActiveMember:** Indica se o cliente é um membro ativo (binário: sim/não).
+13. **EstimatedSalary:** O salário estimado do cliente.
+14. **Exited:** Indica se o cliente saiu do banco (binário: sim/não).
+
+## Dicionário
+
+| variavel        | descricao                                                | tipo         | subtipo   |
+|-----------------|----------------------------------------------------------|--------------|-----------|
+| Surname         | O sobrenome do cliente                                   | qualitativa  | nominal   |
+| CreditScore     | O score de crédito do cliente                           | quantitativa | discreta  |
+| Geography       | A localização geográfica do cliente (por exemplo, país ou região) | qualitativa  | nominal   |
+| Gender          | O gênero do cliente                                      | qualitativa  | nominal   |
+| Age             | A idade do cliente                                       | quantitativa | discreta  |
+| Tenure          | O número de anos que o cliente está no banco             | quantitativa | discreta  |
+| Balance         | O saldo da conta do cliente                              | quantitativa | contínua  |
+| NumOfProducts   | O número de produtos bancários que o cliente possui     | quantitativa | discreta  |
+| HasCrCard       | Indica se o cliente possui cartão de crédito (binário: sim/não) | qualitativa  | nominal   |
+| IsActiveMember  | Indica se o cliente é um membro ativo (binário: sim/não)| qualitativa  | nominal   |
+| EstimatedSalary | O salário estimado do cliente                            | quantitativa | contínua  |
+| Exited          | Indica se o cliente saiu do banco (binário: sim/não)     | qualitativa  | nominal   |
+
+São 12 variáveis, com 6 qualitativas nominais, 2 quantitativas contínuas e 4 quantitativas discretas.
+
diff --git a/docs/index.md b/docs/index.md
@@ -1,22 +1,22 @@
 # Início
 
-
-
 ## Contextualização
+Este [conjunto de dados](https://www.kaggle.com/datasets/saurabhbadole/bank-customer-churn-prediction-dataset) contém informações sobre os clientes do banco e seu status de rotatividade, que indica se eles saíram do banco ou não. É adequado para explorar e analisar fatores que influenciam a rotatividade de clientes em instituições bancárias e para construir modelos preditivos para identificar clientes em risco de rotatividade.
 
-Contexto necessário para entender o problema a ser abordado.
+- Pode ser usado para análise exploratória de dados 
+- Pode ser usado para construir modelos de aprendizado de máquina para prever a rotatividade de clientes
 
 ## Problema
 
-O real problema que será abordado no projeto.
+A taxa de rotatividade de clientes em instituições bancárias é um desafio significativo que afeta diretamente a estabilidade financeira e a lucratividade do negócio. A falta de compreensão dos motivos que levam os clientes a deixarem o banco dificulta a implementação de estratégias eficazes de retenção.
 
 ## Proposta
 
-Informações sobre o que será criado como solução tecnológica ao final do projeto.
+Propomos desenvolver uma solução tecnológica baseada em análise de dados e modelos preditivos para ajudar as instituições bancárias a entenderem melhor os padrões de rotatividade de clientes. 
 
 ## Equipe
 
- - [Nome do desenvolvedor #1](url-do-github-do-desenvolvedor-#1)
- - [Nome do desenvolvedor #2](url-do-github-do-desenvolvedor-#2)
- - [Nome do desenvolvedor #3](url-do-github-do-desenvolvedor-#3)
- - [Nome do desenvolvedor #4](url-do-github-do-desenvolvedor-#4)
+ - [Clara Lima Silva](https://github.com/claralimasilva)
+ - [Francisco Matheus Vaz dos Santos](https://github.com/matheusvazdata)
+ - [Mateus Balda Mota](https://github.com/matt-balda)
+ - [Silas Eufrásio da Silva](https://github.com/uSilas)