🏠

1

2

3

4

5

6

7

8

Design documents

• requirments.txt
  • Video tutorial
  • conda list -e > requirements.txt # Anaconda command line
  • pip freeze > requirements.txt # pipenv command line
  • Using requirements.txt to create an environment here
• Google
  • Document the data - Google’s The Data Cards Playbook
  • Overview of technical writing courses
• ML Document Template
• LaTeX - math markup
• Sphinx - code documentation automation
  • Documenting Python code with Sphinx
  • Write Beautiful Python Documentation with Sphinx
  • Documentation
• Is the problem statement complete; does it include why and how ML is to be used to solve it?
• Did you clarify your EDA process?
  • Is EDA complete or are their future steps?
• Did you document the dependencies and environment to run the notebook and scripts?
• Did you document the steps to run the ML application?
• Did you include the scripts and files needed?
  • Is there an ML file (.py or other) to create outside of the notebook?
  • Are containerization files included?
• Did you document the deployment process?
• Code review:

*click the image to enlarge: