Guide.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {
    "editable": true,
    "ulab": {
     "buttons": {
      "ulab-button-a88d4430": {
       "bashCommand": "pip install scikit-learn==0.22 shap pylint autopep8 && clear",
       "filesToOpen": [],
       "isPreviewButton": false,
       "runInBackground": false,
       "style": "primary",
       "text": "INSTALL LIBRARIES",
       "toggleOffText": "HIDE SOLUTION",
       "toggleOnText": "SHOW SOLUTION"
      }
     }
    }
   },
   "source": [
    "# Predict Customer Churn\n",
    "\n",
    "You can make sure the necessary libraries are included herein with the below button.\n",
    "\n",
    "<button id=\"ulab-button-a88d4430\" class=\"ulab-btn--primary\"></button>\n",
    "\n",
    "Alternatively, you can manually install dependencies as:\n",
    "```bash\n",
    "# Workspace run\n",
    "python -m pip install -r requirements_py3.6.txt\n",
    "# Local run\n",
    "python -m pip install -r requirements_py3.8.txt\n",
    "```\n",
    "### Getting Started\n",
    "\n",
    "Click on the folder icon in the top left of this workspace to see the folder and file structure for this project.  \n",
    "\n",
    "We have already provided you the *churn_notebook.ipynb* file containing the solution to identify the customer churn, but without implementing the engineering and software best practices.\n",
    "\n",
    "You need to refactor the given ***churn_notebook.ipynb*** file following the best coding practices to complete these files:\n",
    "\n",
    "1. churn_library.py\n",
    "1. churn_script_logging_and_tests.py\n",
    "1. README.md\n",
    "\n",
    "These three (incomplete) files are already created for you. You will notice all functions  have been provided with document strings in each of these files. These functions have been set up to guide you to a solution (no intended tricks here).  However, if you would like to refactor the notebook in an alternative way to the setup in these files that is also okay, as long as you meet all the requirements in the <a href=\"https://review.udacity.com/#!/rubrics/3094/view\" target=\"_blank\">Rubric</a>.\n",
    "\n",
    "###  Instructions\n",
    "\n",
    "These are the three files you will need to complete after refactoring the *churn_notebook.ipynb* file:\n",
    "\n",
    "1. ***churn_library.py***<br>\n",
    "The *churn_library.py* is a library of functions to find customers who are likely to churn.  You may be able to complete this project by completing each of these functions, but you also have the flexibility to change or add functions to meet the rubric criteria.\n",
    "\n",
    " The document strings have already been created for all the functions in the **churn_library.py** to assist with one potential solution. In addition, for a better understanding of the function call, see the **Sequence diagram** in the classroom. \n",
    " \n",
    " After you have defined all functions in the *churn_library.py*, you may choose to add an `if __name__ == \"__main__\"` block that allows you to run the code below and understand the results for each of the functions and refactored code associated with the original notebook.\n",
    " \n",
    "```bash\n",
    "ipython churn_library.py\n",
    "```\n",
    "\n",
    " \n",
    "\n",
    "\n",
    "2. ***churn_script_logging_and_tests.py***<br> \n",
    "This file should:  \n",
    " - Contain unit tests for the *churn_library.py* functions. You have to write test for *each* input function. Use the basic assert statements that test functions work properly. The goal of test functions is to checking the returned items aren't empty or folders where results should land have results after the function has been run.\n",
    " \n",
    " - Log any errors and INFO messages. You should log the info messages and errors in a .log file, so it can be viewed post the run of the script. The log messages should easily be understood and traceable.\n",
    "\n",
    " Also, ensure that testing and logging can be completed on the command line, meaning, running the below code in the terminal should test each of the functions and provide any errors to a file stored in the */logs* folder.\n",
    " \n",
    "```bash\n",
    "ipython churn_script_logging_and_tests.py\n",
    "```\n",
    "\n",
    " >**Testing framework**: As long as you fulfil all the rubric criteria, the choice of testing framework rests with the student. For instance, you can use [pytest](https://docs.pytest.org/en/7.1.x/getting-started.html#) for writing functional tests.  \n",
    "\n",
    "\n",
    "3. ***README.md***<br>\n",
    "This file will provide an overview of the project, the instructions to use the code, for example, it explains how to test and log the result of each function. For instance, you can have the following detailed sections in the *README.md* file:\n",
    "  - Project description\n",
    "  - Files and data description\n",
    "  - Running the files\n",
    "\n",
    "\n",
    "\n",
    "## Code Quality Considerations\n",
    "- **Style Guide** - Format your refactored code using [PEP 8 – Style Guide](https://peps.python.org/pep-0008/). Running the command below can assist with formatting. To assist with meeting pep 8 guidelines, use `autopep8` via the command line commands below:\n",
    "\n",
    "```bash\n",
    "autopep8 --in-place --aggressive --aggressive churn_script_logging_and_tests.py\n",
    "autopep8 --in-place --aggressive --aggressive churn_library.py\n",
    "```\n",
    "\n",
    "\n",
    "- **Style Checking and Error Spotting** - Use [Pylint](https://pypi.org/project/pylint/) for the code analysis looking for programming errors, and scope for further refactoring. You should check the pylint score using the command below.\n",
    "\n",
    "```bash\n",
    "pylint churn_library.py\n",
    "pylint churn_script_logging_and_tests.py\n",
    "```\n",
    "\n",
    " You should make sure you don't have any errors, and that your code is scoring as high as you can get it!  Shoot for a `pylint` score exceeding 7 for both Python files. \n",
    "\n",
    "\n",
    "- **Docstring** - All functions and files should have document strings that correctly identifies the inputs, outputs, and purpose of the function. All files have a document string that identifies the purpose of the file, the author, and the date the file was created.\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "## Rubric\n",
    "><font color=red>**Important**</font><br>It is good to have a quick look at the <a href=\"https://review.udacity.com/#!/rubrics/3094/view\" target=\"_blank\">rubric</a> before you start refactoring the code. The rubric defines the criteria against which Reviewers will evaluate your submission. In other words, it has details on what is needed for a successful solution."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "editable": true
   },
   "source": [
    "### Troubleshooting\n",
    "\n",
    "Though many of the libraries used in this notebook are a common part of data manipulation and machine learning models, there are a few useful command line installations that might prove to be useful when working in this workspace, as well as if you try to run files on your local machine.\n",
    "\n",
    "**Error**\n",
    "```\n",
    "QXcbConnection: Could not connect to display\n",
    "Aborted\n",
    "```\n",
    "\n",
    "**Solution**\n",
    "```\n",
    "import os\n",
    "os.environ['QT_QPA_PLATFORM']='offscreen'\n",
    "```\n",
    "\n",
    "Install the linter and auto-formatter:\n",
    "```\n",
    "pip install pylint\n",
    "pip install autopep8\n",
    "```"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3.9.12 64-bit",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.12"
  },
  "ulab_nb_type": "guided",
  "vscode": {
   "interpreter": {
    "hash": "aee8b7b246df8f9039afb4144a1f6fd8d2ca17a180786b69acc140d282b71a49"
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}