01-Machine_learning_in_production.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# ML in production\n",
    "\n",
    "**Wine-o-meter** is a future unicorn application. It allows wine producers to predict the quality score of their wine based on physicochemical inputs. The startup behind this innovation is convinced about its ability to disrupt the world of wine. 🍷\n",
    "\n",
    "## Project 🚧\n",
    "\n",
    "The data-science team has worked together on creating the best model predicting the quality score (from 0 to 10) of multiple wines. The next step is to include this model into the mobile application. The development team is expecting an API endpoint in order to request the model and display the result inside the application.\n",
    "\n",
    "Your job is to put the trained model into production. Hopefully, the team provided you their work:\n",
    "\n",
    "- a `model.joblib` which is the trained model pickled (saved using [`joblib`](https://scikit-learn.org/stable/modules/model_persistence.html#python-specific-serialization) library),\n",
    "- the notebook used to train the model (`Model_Training.ipynb`) and the dataset (`winequality.csv`), so you can have a look,\n",
    "- a test notebook (`Test_Endpoint.ipynb`) so you can assert that your endpoint is meeting the requirements.\n",
    "\n",
    "## Goals 🎯\n",
    "\n",
    "Your mission is to put this model into production by **building an API**. To succeed you need to:\n",
    "\n",
    "- provide a `/predict` endpoint,\n",
    "- provide a small documentation for the developer team at the index of your website.\n",
    "\n",
    "In the following text, we describe the technical expectations:\n",
    "\n",
    "###  `/predict` endpoint\n",
    "\n",
    "You should provide at least **one endpoint** `/predict`. The full URL would look like something like this: `https://your-url.com/predict`.\n",
    "\n",
    "This endpoint accepts **POST method** with JSON input data and it should return the predictions. We assume **inputs will be always well formatted**. It means you do not have to manage errors. We leave the error handling as a bonus.\n",
    "\n",
    "Input example:\n",
    "\n",
    "```\n",
    "{\n",
    "  \"input\": [[7.0, 0.27, 0.36, 20.7, 0.045, 45.0, 170.0, 1.001, 3.0, 0.45, 8.8], [7.0, 0.27, 0.36, 20.7, 0.045, 45.0, 170.0, 1.001, 3.0, 0.45, 8.8]]\n",
    "}\n",
    "```\n",
    "\n",
    "The response should be a JSON with one key `prediction` corresponding to the prediction.\n",
    "\n",
    "Response example:\n",
    "\n",
    "```\n",
    "{\n",
    "  \"prediction\":[6,6]\n",
    "}\n",
    "```\n",
    "\n",
    "### Documentation page\n",
    "\n",
    "You need to provide the users with a **small HTML page documentation** about your API.\n",
    "\n",
    "It has to be located at the index of your website. If we take the URL example above, it should be located directly at `https://your-url.com`).\n",
    "\n",
    "This small documentation should at least include:\n",
    "- An h1 title: the title is up to you.\n",
    "- A description of every endpoints the user can call with the endpoint name, the HTTP method, the required input and the expected output (you can give example).\n",
    "\n",
    "You are free to add other any other relevant informations and style your HTML as you wish.\n",
    "\n",
    "### Online production\n",
    "\n",
    "You have to **host your API online**. We recommend you to use [Heroku](https://www.heroku.com/) as it is free of charge. But you are free to choose any other hosting provider.\n",
    "\n",
    "## Helpers 🦮\n",
    "\n",
    "To help you start with this project we provide you with some pieces of advice.\n",
    "\n",
    "### Look at the file your team provided you\n",
    "\n",
    "The training process may reveal some information about the libraries you are going to need in order to run your model in production 😉.\n",
    "\n",
    "### Create a virtual environment\n",
    "\n",
    "Create your virtual environment. If you plan to use Heroku, you can start with a `requirements.txt` as Heroku is using this file to setup the server environment.\n",
    "\n",
    "Do not forget to update this file as you move forward and install more dependencies.\n",
    "\n",
    "### Code the `/predict` endpoint\n",
    "\n",
    "You can use the test notebook provided by the team to assert it works as expected.\n",
    "\n",
    "### Create the HTML documentation\n",
    "\n",
    "Once the endpoint is working, you can create the documentation.\n",
    "\n",
    "### Deploy to online server\n",
    "\n",
    "It's time to show up your work and push your code to online server.\n",
    "\n",
    "### Share your code\n",
    "\n",
    "In order to get evaluation, do not forget to share your code on a [Github](https://github.com/) repository. You can create a [`README.md`](https://guides.github.com/features/mastering-markdown/) file with a quick description about this project, how to setup locally and the online URL.\n",
    "\n",
    "## Deliverable 📬\n",
    "\n",
    "To complete this project, you should deliver:\n",
    "\n",
    "- The **whole code** stored in a Github repository. You will include the repository's URL.\n",
    "- An **online API** on Heroku server (or any other provider you choose) with an **HTML page documentation** at the website index and **one `/predict` endpoint** at least that respect the technical description above. We should be able to request the API endpoint `/predict` using `curl`:\n",
    "\n",
    "```shell\n",
    "$ curl -i -H \"Content-Type: application/json\" -X POST -d '{\"input\": [[7.0, 0.27, 0.36, 20.7, 0.045, 45.0, 170.0, 1.001, 3.0, 0.45, 8.8]]}' http://your-url/predict\n",
    "```\n",
    "\n",
    "Or Python:\n",
    "\n",
    "```python\n",
    "import requests\n",
    "\n",
    "response = requests.post(\"https://your-url/predict\", json={\n",
    "    \"input\": [[7.0, 0.27, 0.36, 20.7, 0.045, 45.0, 170.0, 1.001, 3.0, 0.45, 8.8]]\n",
    "})\n",
    "print(response.json())\n",
    "```"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "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.8.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}