Skip to content

udacity/cd0580-project-starter

Repository files navigation

Predict Customer Churn

  • Project Predict Customer Churn of ML DevOps Engineer Nanodegree (Udacity)

Project Description

TODO: Describe the purpose of this project in your own words.

You should include:

  • What problem this project solves
  • What the machine learning pipeline does
  • What models are used

Files and Data Description

TODO: Describe the main files and dataset used in this project.

Main Files

  • churn_library.py

    TODO: Explain what this file does

  • churn_script_logging_and_tests.py

    TODO: Explain what this file does

  • churn_notebook.ipynb

    TODO: Explain the role of this notebook


Data

  • data/bank_data.csv

    TODO: Describe the dataset (features, target, etc.)


Output Directories

After running the project, outputs will be saved to:

  • EDA images → images/eda/
  • Model results → images/results/
  • Models → models/
  • Logs → logs/churn_library.log

Running the Files

1. Run the Pipeline

python churn_library.py

TODO: Briefly describe what happens when this script runs


2. Run Tests and Logging

python churn_script_logging_and_tests.py

TODO: Explain what the test script does and what is logged


Expected Outputs

TODO: List and describe the expected outputs of the project

Minimum expected outputs:

  • Models:

    • models/rfc_model.pkl
    • models/logistic_model.pkl
  • Images:

    • EDA plots in images/eda/
    • Model evaluation plots in images/results/
  • Logs:

    • logs/churn_library.log

Notes

TODO: Add any additional notes or assumptions about your implementation

Examples:

  • How logging is handled
  • Any assumptions about the dataset
  • Any limitations of the model

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors