Skip to content

Project Structure

πŸ“‚ TelcoRetentionAI                                βœ… Root directory of the project
β”œβ”€β”€ πŸ“‚ .git                                        πŸ”’ Git repository configuration
β”œβ”€β”€ πŸ“‚ data                                        πŸ“Š Raw and processed datasets
β”‚   └── WA_Fn-UseC_-Telco-Customer-Churn.csv       πŸ“Œ Original dataset (Telco Customer Churn)
β”œβ”€β”€ πŸ“‚ notebook                                    🧠 Jupyter notebooks following CRISP-DM steps
β”‚   β”œβ”€β”€ 01_business_understanding.ipynb
β”‚   β”œβ”€β”€ 02_data_understanding.ipynb
β”‚   └── 03_data_preparation_modeling_evaluation.ipynb
β”œβ”€β”€ πŸ“‚ docs                                        πŸ“š MkDocs-based documentation
β”‚   β”œβ”€β”€ πŸ“‚ assets                                  πŸ“Ž Markdown files by CRISP-DM phase
β”‚   β”‚   β”œβ”€β”€ πŸ“‚ images                              πŸ–ΌοΈ Images supporting documentation
β”‚   β”‚   β”‚   β”œβ”€β”€ πŸ“‚ 02_data_understanding
β”‚   β”‚   β”‚   β”œβ”€β”€ πŸ“‚ 05_evaluation
β”‚   β”‚   β”‚   └── πŸ“‚ 06_project_objectives
β”‚   β”‚   β”œβ”€β”€ πŸ“„01_business_understanding.md
β”‚   β”‚   β”œβ”€β”€ πŸ“„02_data_understanding.md
β”‚   β”‚   β”œβ”€β”€ πŸ“„03_data_preparation.md
β”‚   β”‚   β”œβ”€β”€ πŸ“„04_modeling.md
β”‚   β”‚   β”œβ”€β”€ πŸ“„05_evaluation.md
β”‚   β”‚   β”œβ”€β”€ πŸ“„06_project_objectives.md
β”‚   β”‚   β”œβ”€β”€ πŸ“„07_project_goals.md
β”‚   β”‚   β”œβ”€β”€ πŸ“„08_business_recommendations.md
β”‚   β”‚   └── πŸ“„09_conclusions.md
β”‚   β”œβ”€β”€ πŸ“„changelog.md                             πŸ“ Version history
β”‚   β”œβ”€β”€ πŸ“„contributing.md                          πŸ™Œ How to contribute
β”‚   β”œβ”€β”€ πŸ“„index.md                                 🏠 Homepage for documentation
β”‚   β”œβ”€β”€ πŸ“„installation.md                          πŸ’‘ Setup and install instructions
β”‚   β”œβ”€β”€ πŸ“„project_structure.md                     🧱 This file (project layout)
β”‚   └── πŸ“„usage.md                                 πŸš€ How to use the project
β”œβ”€β”€ .gitignore                                     πŸ“Œ Ignored files
β”œβ”€β”€ .pre-commit-config.yaml                        βœ… Pre-commit hooks (quality checks)
β”œβ”€β”€ .python-version                                πŸ“Œ Python version control
β”œβ”€β”€ bumpversion.cfg                                πŸ” Semantic versioning config
β”œβ”€β”€ Makefile                                       βš™οΈ  Automation commands
β”œβ”€β”€ mkdocs.yml                                     πŸ—‚οΈ MkDocs site configuration
β”œβ”€β”€ pyproject.toml                                 πŸ“¦ Poetry build system and dependencies
└── README.md                                      πŸ“˜ Project overview and summary

β¬… Voltar para a PΓ‘gina Inicial