Update README.md

Added to troubleshooting section and fixed paths

00.configuration.ipynb

@@ -1,223 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 00. Installation and configuration\n",
-    "\n",
-    "## Prerequisites:\n",
-    "\n",
-    "### 1. Install Azure ML SDK\n",
-    "Follow [SDK installation instructions](https://docs.microsoft.com/azure/machine-learning/service/how-to-configure-environment).\n",
-    "\n",
-    "### 2. Install some additional packages\n",
-    "This Notebook requires some additional libraries. In the conda environment, run below commands: \n",
-    "```shell\n",
-    "(myenv) $ conda install -y matplotlib tqdm scikit-learn\n",
-    "```\n",
-    "\n",
-    "### 3. Make sure your subscription is registered to use ACI.\n",
-    "This Notebook makes use of Azure Container Instance (ACI). You need to ensure your subscription has been registered to use ACI in order be able to deploy a dev/test web service.\n",
-    "```shell\n",
-    "# check to see if ACI is already registered\n",
-    "(myenv) $ az provider show -n Microsoft.ContainerInstance -o table\n",
-    "\n",
-    "# if ACI is not registered, run this command.\n",
-    "# note you need to be the subscription owner in order to execute this command successfully.\n",
-    "(myenv) $ az provider register -n Microsoft.ContainerInstance\n",
-    "```\n",
-    "\n",
-    "In this example you will optionally create an Azure Machine Learning Workspace and initialize your notebook directory to easily use this workspace.  Typically you will only need to run this once per notebook directory, and all other notebooks in this directory or any sub-directories will automatically use the settings you indicate here.\n",
-    "\n",
-    "This notebook also contains optional cells to install and update the require Azure Machine Learning libraries."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "install"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "# Check core SDK version number for debugging purposes\n",
-    "import azureml.core\n",
-    "\n",
-    "print(\"SDK Version:\", azureml.core.VERSION)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Initialize an Azure ML Workspace\n",
-    "### What is an Azure ML Workspace and why do I need one?\n",
-    "\n",
-    "An AML Workspace is an Azure resource that organaizes and coordinates the actions of many other Azure resources to assist in executing and sharing machine learning workflows.  In particular, an AML Workspace coordinates storage, databases, and compute resources providing added functionality for machine learning experimentation, operationalization, and the monitoring of operationalized models.\n",
-    "\n",
-    "### What do I need\n",
-    "\n",
-    "In order to use an AML Workspace, first you need access to an Azure Subscription.  You can [create your own](https://azure.microsoft.com/en-us/free/) or get your existing subscription information from the [Azure portal](https://portal.azure.com).  Inside your subscription, you will need access to a _resource group_, which organizes Azure resources and provides a default region for the resources in a group.  You can see what resource groups to which you have access, or create a new one in the [Azure portal](https://portal.azure.com)\n",
-    "\n",
-    "You can also easily create a new resource group using azure-cli.\n",
-    "\n",
-    "```sh\n",
-    "(myenv) $ az group create -n my_resource_group -l eastus2\n",
-    "```\n",
-    "\n",
-    "To create or access an Azure ML Workspace, you will need to import the AML library and the following information:\n",
-    "* A name for your workspace\n",
-    "* Your subscription id\n",
-    "* The resource group name\n",
-    "\n",
-    "**Note**: As with other Azure services, there are limits on certain resources (for eg. BatchAI cluster size) associated with the Azure Machine Learning service. Please read [this article](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-manage-quotas) on the default limits and how to request more quota."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Supported Azure Regions\n",
-    "Please specify the Azure subscription Id, resource group name, workspace name, and the region in which you want to create the workspace, for example \"eastus2\". "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "subscription_id = os.environ.get(\"SUBSCRIPTION_ID\", \"<my-subscription-id>\")\n",
-    "resource_group = os.environ.get(\"RESOURCE_GROUP\", \"<my-rg>\")\n",
-    "workspace_name = os.environ.get(\"WORKSPACE_NAME\", \"<my-workspace>\")\n",
-    "workspace_region = os.environ.get(\"WORKSPACE_REGION\", \"eastus2\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Creating a workspace\n",
-    "If you already have access to an AML Workspace you want to use, you can skip this cell.  Otherwise, this cell will create an AML workspace for you in a subscription provided you have the correct permissions.\n",
-    "\n",
-    "This will fail when:\n",
-    "1. You do not have permission to create a workspace in the resource group\n",
-    "2. You are not a subscription owner or contributor and no Azure ML workspaces have ever been created in this subscription\n",
-    "\n",
-    "If workspace creation fails, please work with your IT admin to provide you with the appropriate permissions or to provision the required resources."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "create workspace"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "# import the Workspace class and check the azureml SDK version\n",
-    "from azureml.core import Workspace\n",
-    "\n",
-    "ws = Workspace.create(name = workspace_name,\n",
-    "                      subscription_id = subscription_id,\n",
-    "                      resource_group = resource_group, \n",
-    "                      location = workspace_region,\n",
-    "                      exist_ok = True)\n",
-    "ws.get_details()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Configuring your local environment\n",
-    "You can validate that you have access to the specified workspace and write a configuration file to the default configuration location, `./aml_config/config.json`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "create workspace"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "ws = Workspace(workspace_name = workspace_name,\n",
-    "               subscription_id = subscription_id,\n",
-    "               resource_group = resource_group)\n",
-    "\n",
-    "# persist the subscription id, resource group name, and workspace name in aml_config/config.json.\n",
-    "ws.write_config()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can then load the workspace from this config file from any notebook in the current directory."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "create workspace"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "# load workspace configuratio from ./aml_config/config.json file.\n",
-    "my_workspace = Workspace.from_config()\n",
-    "my_workspace.get_details()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Success!\n",
-    "Great, you are ready to move on to the rest of the sample notebooks."
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.4"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

01.getting-started/01.train-within-notebook/01.train-within-notebook.ipynb

@@ -1,810 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 01. Train in the Notebook & Deploy Model to ACI\n",
-    "\n",
-    "* Load workspace\n",
-    "* Train a simple regression model directly in the Notebook python kernel\n",
-    "* Record run history\n",
-    "* Find the best model in run history and download it.\n",
-    "* Deploy the model as an Azure Container Instance (ACI)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Prerequisites\n",
-    "1. Make sure you go through the [00. Installation and Configuration](00.configuration.ipynb) Notebook first if you haven't. \n",
-    "\n",
-    "2. Install following pre-requisite libraries to your conda environment and restart notebook.\n",
-    "```shell\n",
-    "(myenv) $ conda install -y matplotlib tqdm scikit-learn\n",
-    "```\n",
-    "\n",
-    "3. Check that ACI is registered for your Azure Subscription.  "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!az provider show -n Microsoft.ContainerInstance -o table"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "If ACI is not registered, run following command to register it. Note that you have to be a subscription owner, or this command will fail."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!az provider register -n Microsoft.ContainerInstance"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Validate Azure ML SDK installation and get version number for debugging purposes"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "install"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "from azureml.core import Experiment, Run, Workspace\n",
-    "import azureml.core\n",
-    "\n",
-    "# Check core SDK version number\n",
-    "print(\"SDK version:\", azureml.core.VERSION)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Initialize Workspace\n",
-    "\n",
-    "Initialize a workspace object from persisted configuration."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "create workspace"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "ws = Workspace.from_config()\n",
-    "print('Workspace name: ' + ws.name, \n",
-    "      'Azure region: ' + ws.location, \n",
-    "      'Subscription id: ' + ws.subscription_id, \n",
-    "      'Resource group: ' + ws.resource_group, sep='\\n')"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Set experiment name\n",
-    "Choose a name for experiment."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "experiment_name = 'train-in-notebook'"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Start a training run in local Notebook"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# load diabetes dataset, a well-known small dataset that comes with scikit-learn\n",
-    "from sklearn.datasets import load_diabetes\n",
-    "from sklearn.linear_model import Ridge\n",
-    "from sklearn.metrics import mean_squared_error\n",
-    "from sklearn.model_selection import train_test_split\n",
-    "from sklearn.externals import joblib\n",
-    "\n",
-    "X, y = load_diabetes(return_X_y = True)\n",
-    "columns = ['age', 'gender', 'bmi', 'bp', 's1', 's2', 's3', 's4', 's5', 's6']\n",
-    "X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=0)\n",
-    "data = {\n",
-    "    \"train\":{\"X\": X_train, \"y\": y_train},        \n",
-    "    \"test\":{\"X\": X_test, \"y\": y_test}\n",
-    "}"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Train a simple Ridge model\n",
-    "Train a very simple Ridge regression model in scikit-learn, and save it as a pickle file."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "reg = Ridge(alpha = 0.03)\n",
-    "reg.fit(X=data['train']['X'], y=data['train']['y'])\n",
-    "preds = reg.predict(data['test']['X'])\n",
-    "print('Mean Squared Error is', mean_squared_error(data['test']['y'], preds))\n",
-    "joblib.dump(value=reg, filename='model.pkl');"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Add experiment tracking\n",
-    "Now, let's add Azure ML experiment logging, and upload persisted model into run record as well."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "local run",
-     "outputs upload"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "experiment = Experiment(workspace=ws, name=experiment_name)\n",
-    "run = experiment.start_logging()\n",
-    "\n",
-    "run.tag(\"Description\",\"My first run!\")\n",
-    "run.log('alpha', 0.03)\n",
-    "reg = Ridge(alpha=0.03)\n",
-    "reg.fit(data['train']['X'], data['train']['y'])\n",
-    "preds = reg.predict(data['test']['X'])\n",
-    "run.log('mse', mean_squared_error(data['test']['y'], preds))\n",
-    "joblib.dump(value=reg, filename='model.pkl')\n",
-    "run.upload_file(name='outputs/model.pkl', path_or_stream='./model.pkl')\n",
-    "\n",
-    "run.complete()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "We can browse to the recorded run. Please make sure you use Chrome to navigate the run history page."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "run"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Simple parameter sweep\n",
-    "Sweep over alpha values of a sklearn ridge model, and capture metrics and trained model in the Azure ML experiment."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import numpy as np\n",
-    "import os\n",
-    "from tqdm import tqdm\n",
-    "\n",
-    "model_name = \"model.pkl\"\n",
-    "\n",
-    "# list of numbers from 0 to 1.0 with a 0.05 interval\n",
-    "alphas = np.arange(0.0, 1.0, 0.05)\n",
-    "\n",
-    "# try a bunch of alpha values in a Linear Regression (Ridge) model\n",
-    "for alpha in tqdm(alphas):\n",
-    "    # create a bunch of runs, each train a model with a different alpha value\n",
-    "    with experiment.start_logging() as run:\n",
-    "        # Use Ridge algorithm to build a regression model\n",
-    "        reg = Ridge(alpha=alpha)\n",
-    "        reg.fit(X=data[\"train\"][\"X\"], y=data[\"train\"][\"y\"])\n",
-    "        preds = reg.predict(X=data[\"test\"][\"X\"])\n",
-    "        mse = mean_squared_error(y_true=data[\"test\"][\"y\"], y_pred=preds)\n",
-    "\n",
-    "        # log alpha, mean_squared_error and feature names in run history\n",
-    "        run.log(name=\"alpha\", value=alpha)\n",
-    "        run.log(name=\"mse\", value=mse)\n",
-    "        run.log_list(name=\"columns\", value=columns)\n",
-    "\n",
-    "        with open(model_name, \"wb\") as file:\n",
-    "            joblib.dump(value=reg, filename=file)\n",
-    "        \n",
-    "        # upload the serialized model into run history record\n",
-    "        run.upload_file(name=\"outputs/\" + model_name, path_or_stream=model_name)\n",
-    "\n",
-    "        # now delete the serialized model from local folder since it is already uploaded to run history \n",
-    "        os.remove(path=model_name)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# now let's take a look at the experiment in Azure portal.\n",
-    "experiment"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Select best model from the experiment\n",
-    "Load all experiment run metrics recursively from the experiment into a dictionary object."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "runs = {}\n",
-    "run_metrics = {}\n",
-    "\n",
-    "for r in tqdm(experiment.get_runs()):\n",
-    "    metrics = r.get_metrics()\n",
-    "    if 'mse' in metrics.keys():\n",
-    "        runs[r.id] = r\n",
-    "        run_metrics[r.id] = metrics"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Now find the run with the lowest Mean Squared Error value"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "best_run_id = min(run_metrics, key = lambda k: run_metrics[k]['mse'])\n",
-    "best_run = runs[best_run_id]\n",
-    "print('Best run is:', best_run_id)\n",
-    "print('Metrics:', run_metrics[best_run_id])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can add tags to your runs to make them easier to catalog"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "query history"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "best_run.tag(key=\"Description\", value=\"The best one\")\n",
-    "best_run.get_tags()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Plot MSE over alpha\n",
-    "\n",
-    "Let's observe the best model visually by plotting the MSE values over alpha values:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%matplotlib inline\n",
-    "import matplotlib\n",
-    "import matplotlib.pyplot as plt\n",
-    "\n",
-    "best_alpha = run_metrics[best_run_id]['alpha']\n",
-    "min_mse = run_metrics[best_run_id]['mse']\n",
-    "\n",
-    "alpha_mse = np.array([(run_metrics[k]['alpha'], run_metrics[k]['mse']) for k in run_metrics.keys()])\n",
-    "sorted_alpha_mse = alpha_mse[alpha_mse[:,0].argsort()]\n",
-    "\n",
-    "plt.plot(sorted_alpha_mse[:,0], sorted_alpha_mse[:,1], 'r--')\n",
-    "plt.plot(sorted_alpha_mse[:,0], sorted_alpha_mse[:,1], 'bo')\n",
-    "\n",
-    "plt.xlabel('alpha', fontsize = 14)\n",
-    "plt.ylabel('mean squared error', fontsize = 14)\n",
-    "plt.title('MSE over alpha', fontsize = 16)\n",
-    "\n",
-    "# plot arrow\n",
-    "plt.arrow(x = best_alpha, y = min_mse + 39, dx = 0, dy = -26, ls = '-', lw = 0.4,\n",
-    "          width = 0, head_width = .03, head_length = 8)\n",
-    "\n",
-    "# plot \"best run\" text\n",
-    "plt.text(x = best_alpha - 0.08, y = min_mse + 50, s = 'Best Run', fontsize = 14)\n",
-    "plt.show()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Register the best model"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Find the model file saved in the run record of best run."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "query history"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "for f in best_run.get_file_names():\n",
-    "    print(f)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Now we can register this model in the model registry of the workspace"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "register model from history"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "model = best_run.register_model(model_name='best_model', model_path='outputs/model.pkl')"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Verify that the model has been registered properly. If you have done this several times you'd see the version number auto-increases each time."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "register model from history"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "models = ws.models(name='best_model')\n",
-    "for m in models:\n",
-    "    print(m.name, m.version)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can also download the registered model. Afterwards, you should see a `model.pkl` file in the current directory. You can then use it for local testing if you'd like."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "download file"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "# remove the model file if it is already on disk\n",
-    "if os.path.isfile('model.pkl'): \n",
-    "    os.remove('model.pkl')\n",
-    "# download the model\n",
-    "model.download(target_dir=\"./\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Scoring script\n",
-    "\n",
-    "Now we are ready to build a Docker image and deploy the model in it as a web service. The first step is creating the scoring script. For convenience, we have created the scoring script for you. It is printed below as text, but you can also run `%pfile ./score.py` in a cell to show the file.\n",
-    "\n",
-    "Tbe scoring script consists of two functions: `init` that is used to load the model to memory when starting the container, and `run` that makes the prediction when web service is called. Please pay special attention to how the model is loaded in the `init()` function. When Docker image is built for this model, the actual model file is downloaded and placed on disk, and `get_model_path` function returns the local path where the model is placed."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with open('./score.py', 'r') as scoring_script:\n",
-    "    print(scoring_script.read())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create environment dependency file\n",
-    "\n",
-    "We need a environment dependency file `myenv.yml` to specify which libraries are needed by the scoring script when building the Docker image for web service deployment. We can manually create this file, or we can use the `CondaDependencies` API to automatically create this file."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core.conda_dependencies import CondaDependencies \n",
-    "\n",
-    "myenv = CondaDependencies()\n",
-    "myenv.add_conda_package(\"scikit-learn\")\n",
-    "print(myenv.serialize_to_string())\n",
-    "\n",
-    "with open(\"myenv.yml\",\"w\") as f:\n",
-    "    f.write(myenv.serialize_to_string())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Deploy web service into an Azure Container Instance\n",
-    "The deployment process takes the registered model and your scoring scrip, and builds a Docker image. It then deploys the Docker image into Azure Container Instance as a running container with an HTTP endpoint readying for scoring calls. Read more about [Azure Container Instance](https://azure.microsoft.com/en-us/services/container-instances/).\n",
-    "\n",
-    "Note ACI is great for quick and cost-effective dev/test deployment scenarios. For production workloads, please use [Azure Kubernentes Service (AKS)](https://azure.microsoft.com/en-us/services/kubernetes-service/) instead. Please follow in struction in [this notebook](11.production-deploy-to-aks.ipynb) to see how that can be done from Azure ML.\n",
-    " \n",
-    "** Note: ** The web service creation can take 6-7 minutes."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "from azureml.core.webservice import AciWebservice, Webservice\n",
-    "\n",
-    "aciconfig = AciWebservice.deploy_configuration(cpu_cores=1, \n",
-    "                                               memory_gb=1, \n",
-    "                                               tags={'sample name': 'AML 101'}, \n",
-    "                                               description='This is a great example.')"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Note the below `WebService.deploy_from_model()` function takes a model object registered under the workspace. It then bakes the model file in the Docker image so it can be looked-up using the `Model.get_model_path()` function in `score.py`. \n",
-    "\n",
-    "If you have a local model file instead of a registered model object, you can also use the `WebService.deploy()` function which would register the model and then deploy."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "from azureml.core.image import ContainerImage\n",
-    "image_config = ContainerImage.image_configuration(execution_script=\"score.py\", \n",
-    "                                    runtime=\"python\", \n",
-    "                                    conda_file=\"myenv.yml\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "%%time\n",
-    "# this will take 5-10 minutes to finish\n",
-    "# you can also use \"az container list\" command to find the ACI being deployed\n",
-    "service = Webservice.deploy_from_model(name='my-aci-svc',\n",
-    "                                       deployment_config=aciconfig,\n",
-    "                                       models=[model],\n",
-    "                                       image_config=image_config,\n",
-    "                                       workspace=ws)\n",
-    "\n",
-    "service.wait_for_deployment(show_output=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "## Test web service"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "print('web service is hosted in ACI:', service.scoring_uri)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Use the `run` API to call the web service with one row of data to get a prediction."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "import json\n",
-    "# score the first row from the test set.\n",
-    "test_samples = json.dumps({\"data\": X_test[0:1, :].tolist()})\n",
-    "service.run(input_data = test_samples)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Feed the entire test set and calculate the errors (residual values)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "# score the entire test set.\n",
-    "test_samples = json.dumps({'data': X_test.tolist()})\n",
-    "\n",
-    "result = json.loads(service.run(input_data = test_samples))['result']\n",
-    "residual = result - y_test"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can also send raw HTTP request to test the web service."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "import requests\n",
-    "import json\n",
-    "\n",
-    "# 2 rows of input data, each with 10 made-up numerical features\n",
-    "input_data = \"{\\\"data\\\": [[1, 2, 3, 4, 5, 6, 7, 8, 9, 10], [10, 9, 8, 7, 6, 5, 4, 3, 2, 1]]}\"\n",
-    "\n",
-    "headers = {'Content-Type':'application/json'}\n",
-    "\n",
-    "# for AKS deployment you'd need to the service key in the header as well\n",
-    "# api_key = service.get_key()\n",
-    "# headers = {'Content-Type':'application/json',  'Authorization':('Bearer '+ api_key)} \n",
-    "\n",
-    "resp = requests.post(service.scoring_uri, input_data, headers = headers)\n",
-    "print(resp.text)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Residual graph\n",
-    "Plot a residual value graph to chart the errors on the entire test set. Observe the nice bell curve."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "f, (a0, a1) = plt.subplots(1, 2, gridspec_kw={'width_ratios':[3, 1], 'wspace':0, 'hspace': 0})\n",
-    "f.suptitle('Residual Values', fontsize = 18)\n",
-    "\n",
-    "f.set_figheight(6)\n",
-    "f.set_figwidth(14)\n",
-    "\n",
-    "a0.plot(residual, 'bo', alpha=0.4);\n",
-    "a0.plot([0,90], [0,0], 'r', lw=2)\n",
-    "a0.set_ylabel('residue values', fontsize=14)\n",
-    "a0.set_xlabel('test data set', fontsize=14)\n",
-    "\n",
-    "a1.hist(residual, orientation='horizontal', color='blue', bins=10, histtype='step');\n",
-    "a1.hist(residual, orientation='horizontal', color='blue', alpha=0.2, bins=10);\n",
-    "a1.set_yticklabels([])\n",
-    "\n",
-    "plt.show()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Delete ACI to clean up"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Deleting ACI is super fast!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "deploy service",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "%%time\n",
-    "service.delete()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.4"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

01.getting-started/03.train-on-aci/03.train-on-aci.ipynb

@@ -1,284 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 03. Train on Azure Container Instance\n",
-    "\n",
-    "* Create Workspace\n",
-    "* Create `train.py` in the project folder.\n",
-    "* Configure an ACI (Azure Container Instance) run\n",
-    "* Execute in ACI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Prerequisites\n",
-    "Make sure you go through the [00. Installation and Configuration](00.configuration.ipynb) Notebook first if you haven't."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Check core SDK version number\n",
-    "import azureml.core\n",
-    "\n",
-    "print(\"SDK version:\", azureml.core.VERSION)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Initialize Workspace\n",
-    "\n",
-    "Initialize a workspace object from persisted configuration"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "create workspace"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "from azureml.core import Workspace\n",
-    "\n",
-    "ws = Workspace.from_config()\n",
-    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create An Experiment\n",
-    "\n",
-    "**Experiment** is a logical container in an Azure ML Workspace. It hosts run records which can include run metrics and output artifacts from your experiments."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core import Experiment\n",
-    "experiment_name = 'train-on-aci'\n",
-    "experiment = Experiment(workspace = ws, name = experiment_name)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Remote execution on ACI\n",
-    "\n",
-    "The training script `train.py` is already created for you. Let's have a look."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with open('./train.py', 'r') as f:\n",
-    "    print(f.read())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Configure for using ACI\n",
-    "Linux-based ACI is available in `West US`, `East US`, `West Europe`, `North Europe`, `West US 2`, `Southeast Asia`, `Australia East`, `East US 2`, and `Central US` regions. See details [here](https://docs.microsoft.com/en-us/azure/container-instances/container-instances-quotas#region-availability)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "configure run"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "from azureml.core.runconfig import RunConfiguration\n",
-    "from azureml.core.conda_dependencies import CondaDependencies\n",
-    "\n",
-    "# create a new runconfig object\n",
-    "run_config = RunConfiguration()\n",
-    "\n",
-    "# signal that you want to use ACI to execute script.\n",
-    "run_config.target = \"containerinstance\"\n",
-    "\n",
-    "# ACI container group is only supported in certain regions, which can be different than the region the Workspace is in.\n",
-    "run_config.container_instance.region = 'eastus2'\n",
-    "\n",
-    "# set the ACI CPU and Memory \n",
-    "run_config.container_instance.cpu_cores = 1\n",
-    "run_config.container_instance.memory_gb = 2\n",
-    "\n",
-    "# enable Docker \n",
-    "run_config.environment.docker.enabled = True\n",
-    "\n",
-    "# set Docker base image to the default CPU-based image\n",
-    "run_config.environment.docker.base_image = azureml.core.runconfig.DEFAULT_CPU_IMAGE\n",
-    "\n",
-    "# use conda_dependencies.yml to create a conda environment in the Docker image for execution\n",
-    "run_config.environment.python.user_managed_dependencies = False\n",
-    "\n",
-    "# auto-prepare the Docker image when used for execution (if it is not already prepared)\n",
-    "run_config.auto_prepare_environment = True\n",
-    "\n",
-    "# specify CondaDependencies obj\n",
-    "run_config.environment.python.conda_dependencies = CondaDependencies.create(conda_packages=['scikit-learn'])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Submit the Experiment\n",
-    "Finally, run the training job on the ACI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "remote run",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "%%time \n",
-    "from azureml.core.script_run_config import ScriptRunConfig\n",
-    "\n",
-    "script_run_config = ScriptRunConfig(source_directory='./',\n",
-    "                                    script='train.py',\n",
-    "                                    run_config=run_config)\n",
-    "\n",
-    "run = experiment.submit(script_run_config)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "query history"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "# Show run details\n",
-    "run"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "remote run",
-     "aci"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "%%time\n",
-    "# Shows output of the run on stdout.\n",
-    "run.wait_for_completion(show_output=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "tags": [
-     "get metrics"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "# get all metris logged in the run\n",
-    "run.get_metrics()\n",
-    "metrics = run.get_metrics()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import numpy as np\n",
-    "print('When alpha is {1:0.2f}, we have min MSE {0:0.2f}.'.format(\n",
-    "    min(metrics['mse']), \n",
-    "    metrics['alpha'][np.argmin(metrics['mse'])]\n",
-    "))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# show all the files stored within the run record\n",
-    "run.get_file_names()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Now you can take a model produced here, register it and then deploy as a web service."
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

01.getting-started/03.train-on-aci/train.py

@@ -1,44 +0,0 @@
-# Copyright (c) Microsoft. All rights reserved.
-# Licensed under the MIT license.
-
-from sklearn.datasets import load_diabetes
-from sklearn.linear_model import Ridge
-from sklearn.metrics import mean_squared_error
-from sklearn.model_selection import train_test_split
-from azureml.core.run import Run
-from sklearn.externals import joblib
-import os
-import numpy as np
-
-os.makedirs('./outputs', exist_ok=True)
-
-X, y = load_diabetes(return_X_y=True)
-
-run = Run.get_submitted_run()
-
-X_train, X_test, y_train, y_test = train_test_split(X, y,
-                                                    test_size=0.2,
-                                                    random_state=0)
-data = {"train": {"X": X_train, "y": y_train},
-        "test": {"X": X_test, "y": y_test}}
-
-# list of numbers from 0.0 to 1.0 with a 0.05 interval
-alphas = np.arange(0.0, 1.0, 0.05)
-
-for alpha in alphas:
-    # Use Ridge algorithm to create a regression model
-    reg = Ridge(alpha=alpha)
-    reg.fit(data["train"]["X"], data["train"]["y"])
-
-    preds = reg.predict(data["test"]["X"])
-    mse = mean_squared_error(preds, data["test"]["y"])
-    run.log('alpha', alpha)
-    run.log('mse', mse)
-
-    model_file_name = 'ridge_{0:.2f}.pkl'.format(alpha)
-    # save model in the outputs folder so it automatically get uploaded
-    with open(model_file_name, "wb") as file:
-        joblib.dump(value=reg, filename=os.path.join('./outputs/',
-                                                     model_file_name))
-
-    print('alpha is {0:.2f}, and mse is {1:0.2f}'.format(alpha, mse))

01.getting-started/04.train-on-remote-vm/04.train-on-remote-vm.ipynb

@@ -1,321 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 04. Train in a remote VM (MLC managed DSVM)\n",
-    "* Create Workspace\n",
-    "* Create Project\n",
-    "* Create `train.py` file\n",
-    "* Create DSVM as Machine Learning Compute (MLC) resource\n",
-    "* Configure & execute a run in a conda environment in the default miniconda Docker container on DSVM"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Prerequisites\n",
-    "Make sure you go through the [00. Installation and Configuration](00.configuration.ipynb) Notebook first if you haven't."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Check core SDK version number\n",
-    "import azureml.core\n",
-    "\n",
-    "print(\"SDK version:\", azureml.core.VERSION)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Initialize Workspace\n",
-    "\n",
-    "Initialize a workspace object from persisted configuration."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core import Workspace\n",
-    "\n",
-    "ws = Workspace.from_config()\n",
-    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create Experiment\n",
-    "\n",
-    "**Experiment** is a logical container in an Azure ML Workspace. It hosts run records which can include run metrics and output artifacts from your experiments."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "experiment_name = 'train-on-remote-vm'\n",
-    "\n",
-    "from azureml.core import Experiment\n",
-    "\n",
-    "exp = Experiment(workspace = ws, name = experiment_name)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## View `train.py`\n",
-    "\n",
-    "For convenience, we created a training script for you. It is printed below as a text, but you can also run `%pfile ./train.py` in a cell to show the file."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with open('./train.py', 'r') as training_script:\n",
-    "    print(training_script.read())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create Linux DSVM as a compute target\n",
-    "\n",
-    "**Note**: If creation fails with a message about Marketplace purchase eligibilty, go to portal.azure.com, start creating DSVM there, and select \"Want to create programmatically\" to enable programmatic creation. Once you've enabled it, you can exit without actually creating VM.\n",
-    " \n",
-    "**Note**: By default SSH runs on port 22 and you don't need to specify it. But if for security reasons you switch to a different port (such as 5022), you can append the port number to the address like the example below."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core.compute import DsvmCompute\n",
-    "from azureml.core.compute_target import ComputeTargetException\n",
-    "\n",
-    "compute_target_name = 'mydsvm'\n",
-    "\n",
-    "try:\n",
-    "    dsvm_compute = DsvmCompute(workspace = ws, name = compute_target_name)\n",
-    "    print('found existing:', dsvm_compute.name)\n",
-    "except ComputeTargetException:\n",
-    "    print('creating new.')\n",
-    "    dsvm_config = DsvmCompute.provisioning_configuration(vm_size = \"Standard_D2_v2\")\n",
-    "    dsvm_compute = DsvmCompute.create(ws, name = compute_target_name, provisioning_configuration = dsvm_config)\n",
-    "    dsvm_compute.wait_for_completion(show_output = True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Attach an existing Linux DSVM as a compute target\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "'''\n",
-    " from azureml.core.compute import RemoteCompute \n",
-    " # if you want to connect using SSH key instead of username/password you can provide parameters private_key_file and private_key_passphrase \n",
-    " dsvm_compute = RemoteCompute.attach(ws,name=\"attach-from-sdk6\",username=<username>,address=<ipaddress>,ssh_port=22,password=<password>)\n",
-    "'''"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Configure & Run"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Configure a Docker run with new conda environment on the VM\n",
-    "You can execute in a Docker container in the VM. If you choose this route, you don't need to install anything on the VM yourself. Azure ML execution service will take care of it for you."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core.runconfig import RunConfiguration\n",
-    "from azureml.core.conda_dependencies import CondaDependencies\n",
-    "\n",
-    "\n",
-    "# Load the \"cpu-dsvm.runconfig\" file (created by the above attach operation) in memory\n",
-    "run_config = RunConfiguration(framework = \"python\")\n",
-    "\n",
-    "# Set compute target to the Linux DSVM\n",
-    "run_config.target = compute_target_name\n",
-    "\n",
-    "# Use Docker in the remote VM\n",
-    "run_config.environment.docker.enabled = True\n",
-    "\n",
-    "# Use CPU base image from DockerHub\n",
-    "run_config.environment.docker.base_image = azureml.core.runconfig.DEFAULT_CPU_IMAGE\n",
-    "print('Base Docker image is:', run_config.environment.docker.base_image)\n",
-    "\n",
-    "# Ask system to provision a new one based on the conda_dependencies.yml file\n",
-    "run_config.environment.python.user_managed_dependencies = False\n",
-    "\n",
-    "# Prepare the Docker and conda environment automatically when executingfor the first time.\n",
-    "run_config.prepare_environment = True\n",
-    "\n",
-    "# specify CondaDependencies obj\n",
-    "run_config.environment.python.conda_dependencies = CondaDependencies.create(conda_packages=['scikit-learn'])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Submit the Experiment\n",
-    "Submit script to run in the Docker image in the remote VM. If you run this for the first time, the system will download the base image, layer in packages specified in the `conda_dependencies.yml` file on top of the base image, create a container and then execute the script in the container."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core import Run\n",
-    "from azureml.core import ScriptRunConfig\n",
-    "\n",
-    "src = ScriptRunConfig(source_directory = '.', script = 'train.py', run_config = run_config)\n",
-    "run = exp.submit(src)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### View run history details"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "run"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "run.wait_for_completion(show_output = True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Find the best run"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# get all metris logged in the run\n",
-    "run.get_metrics()\n",
-    "metrics = run.get_metrics()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import numpy as np\n",
-    "print('When alpha is {1:0.2f}, we have min MSE {0:0.2f}.'.format(\n",
-    "    min(metrics['mse']), \n",
-    "    metrics['alpha'][np.argmin(metrics['mse'])]\n",
-    "))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Clean up compute resource"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "dsvm_compute.delete()"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.5"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

01.getting-started/05.train-in-spark/05.train-in-spark.ipynb

@@ -1,257 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 05. Train in Spark\n",
-    "* Create Workspace\n",
-    "* Create Experiment\n",
-    "* Copy relevant files to the script folder\n",
-    "* Configure and Run"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Prerequisites\n",
-    "Make sure you go through the [00. Installation and Configuration](00.configuration.ipynb) Notebook first if you haven't."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Check core SDK version number\n",
-    "import azureml.core\n",
-    "\n",
-    "print(\"SDK version:\", azureml.core.VERSION)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Initialize Workspace\n",
-    "\n",
-    "Initialize a workspace object from persisted configuration."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core import Workspace\n",
-    "\n",
-    "ws = Workspace.from_config()\n",
-    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create Experiment\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "experiment_name = 'train-on-spark'\n",
-    "\n",
-    "from azureml.core import Experiment\n",
-    "\n",
-    "exp = Experiment(workspace = ws, name = experiment_name)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## View `train-spark.py`\n",
-    "\n",
-    "For convenience, we created a training script for you. It is printed below as a text, but you can also run `%pfile ./train-spark.py` in a cell to show the file."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with open('train-spark.py', 'r') as training_script:\n",
-    "    print(training_script.read())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Configure & Run"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Attach an HDI cluster\n",
-    "To use HDI commpute target:\n",
-    " 1. Create an Spark for HDI cluster in Azure. Here is some [quick instructions](https://docs.microsoft.com/en-us/azure/machine-learning/desktop-workbench/how-to-create-dsvm-hdi). Make sure you use the Ubuntu flavor, NOT CentOS.\n",
-    " 2. Enter the IP address, username and password below"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core.compute import HDInsightCompute\n",
-    "\n",
-    "try:\n",
-    "    # if you want to connect using SSH key instead of username/password you can provide parameters private_key_file and private_key_passphrase\n",
-    "    hdi_compute_new = HDInsightCompute.attach(ws, \n",
-    "                             name=\"hdi-attach\", \n",
-    "                             address=\"hdi-ignite-demo-ssh.azurehdinsight.net\", \n",
-    "                             ssh_port=22, \n",
-    "                             username='<username>', \n",
-    "                             password='<password>')\n",
-    "\n",
-    "except UserErrorException as e:\n",
-    "    print(\"Caught = {}\".format(e.message))\n",
-    "    print(\"Compute config already attached.\")\n",
-    "    \n",
-    "    \n",
-    "hdi_compute_new.wait_for_completion(show_output=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Configure HDI run"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core.runconfig import RunConfiguration\n",
-    "from azureml.core.conda_dependencies import CondaDependencies\n",
-    "\n",
-    "\n",
-    "# Load the \"cpu-dsvm.runconfig\" file (created by the above attach operation) in memory\n",
-    "run_config = RunConfiguration(framework = \"python\")\n",
-    "\n",
-    "# Set compute target to the Linux DSVM\n",
-    "run_config.target = hdi_compute.name\n",
-    "\n",
-    "# Use Docker in the remote VM\n",
-    "# run_config.environment.docker.enabled = True\n",
-    "\n",
-    "# Use CPU base image from DockerHub\n",
-    "# run_config.environment.docker.base_image = azureml.core.runconfig.DEFAULT_CPU_IMAGE\n",
-    "# print('Base Docker image is:', run_config.environment.docker.base_image)\n",
-    "\n",
-    "# Ask system to provision a new one based on the conda_dependencies.yml file\n",
-    "run_config.environment.python.user_managed_dependencies = False\n",
-    "\n",
-    "# Prepare the Docker and conda environment automatically when executingfor the first time.\n",
-    "# run_config.prepare_environment = True\n",
-    "\n",
-    "# specify CondaDependencies obj\n",
-    "# run_config.environment.python.conda_dependencies = CondaDependencies.create(conda_packages=['scikit-learn'])\n",
-    "# load the runconfig object from the \"myhdi.runconfig\" file generated by the attach operaton above."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Submit the script to HDI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "script_run_config = ScriptRunConfig(source_directory = '.',\n",
-    "                                    script= 'train-spark.py',\n",
-    "                                    run_config = run_config)\n",
-    "run = experiment.submit(script_run_config)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# get the URL of the run history web page\n",
-    "run"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "run.wait_for_completion(show_output = True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# get all metris logged in the run\n",
-    "metrics = run.get_metrics()\n",
-    "print(metrics)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.5"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

01.getting-started/05.train-in-spark/iris.csv

@@ -1,150 +0,0 @@
-5.1,3.5,1.4,0.2,Iris-setosa
-4.9,3.0,1.4,0.2,Iris-setosa
-4.7,3.2,1.3,0.2,Iris-setosa
-4.6,3.1,1.5,0.2,Iris-setosa
-5.0,3.6,1.4,0.2,Iris-setosa
-5.4,3.9,1.7,0.4,Iris-setosa
-4.6,3.4,1.4,0.3,Iris-setosa
-5.0,3.4,1.5,0.2,Iris-setosa
-4.4,2.9,1.4,0.2,Iris-setosa
-4.9,3.1,1.5,0.1,Iris-setosa
-5.4,3.7,1.5,0.2,Iris-setosa
-4.8,3.4,1.6,0.2,Iris-setosa
-4.8,3.0,1.4,0.1,Iris-setosa
-4.3,3.0,1.1,0.1,Iris-setosa
-5.8,4.0,1.2,0.2,Iris-setosa
-5.7,4.4,1.5,0.4,Iris-setosa
-5.4,3.9,1.3,0.4,Iris-setosa
-5.1,3.5,1.4,0.3,Iris-setosa
-5.7,3.8,1.7,0.3,Iris-setosa
-5.1,3.8,1.5,0.3,Iris-setosa
-5.4,3.4,1.7,0.2,Iris-setosa
-5.1,3.7,1.5,0.4,Iris-setosa
-4.6,3.6,1.0,0.2,Iris-setosa
-5.1,3.3,1.7,0.5,Iris-setosa
-4.8,3.4,1.9,0.2,Iris-setosa
-5.0,3.0,1.6,0.2,Iris-setosa
-5.0,3.4,1.6,0.4,Iris-setosa
-5.2,3.5,1.5,0.2,Iris-setosa
-5.2,3.4,1.4,0.2,Iris-setosa
-4.7,3.2,1.6,0.2,Iris-setosa
-4.8,3.1,1.6,0.2,Iris-setosa
-5.4,3.4,1.5,0.4,Iris-setosa
-5.2,4.1,1.5,0.1,Iris-setosa
-5.5,4.2,1.4,0.2,Iris-setosa
-4.9,3.1,1.5,0.1,Iris-setosa
-5.0,3.2,1.2,0.2,Iris-setosa
-5.5,3.5,1.3,0.2,Iris-setosa
-4.9,3.1,1.5,0.1,Iris-setosa
-4.4,3.0,1.3,0.2,Iris-setosa
-5.1,3.4,1.5,0.2,Iris-setosa
-5.0,3.5,1.3,0.3,Iris-setosa
-4.5,2.3,1.3,0.3,Iris-setosa
-4.4,3.2,1.3,0.2,Iris-setosa
-5.0,3.5,1.6,0.6,Iris-setosa
-5.1,3.8,1.9,0.4,Iris-setosa
-4.8,3.0,1.4,0.3,Iris-setosa
-5.1,3.8,1.6,0.2,Iris-setosa
-4.6,3.2,1.4,0.2,Iris-setosa
-5.3,3.7,1.5,0.2,Iris-setosa
-5.0,3.3,1.4,0.2,Iris-setosa
-7.0,3.2,4.7,1.4,Iris-versicolor
-6.4,3.2,4.5,1.5,Iris-versicolor
-6.9,3.1,4.9,1.5,Iris-versicolor
-5.5,2.3,4.0,1.3,Iris-versicolor
-6.5,2.8,4.6,1.5,Iris-versicolor
-5.7,2.8,4.5,1.3,Iris-versicolor
-6.3,3.3,4.7,1.6,Iris-versicolor
-4.9,2.4,3.3,1.0,Iris-versicolor
-6.6,2.9,4.6,1.3,Iris-versicolor
-5.2,2.7,3.9,1.4,Iris-versicolor
-5.0,2.0,3.5,1.0,Iris-versicolor
-5.9,3.0,4.2,1.5,Iris-versicolor
-6.0,2.2,4.0,1.0,Iris-versicolor
-6.1,2.9,4.7,1.4,Iris-versicolor
-5.6,2.9,3.6,1.3,Iris-versicolor
-6.7,3.1,4.4,1.4,Iris-versicolor
-5.6,3.0,4.5,1.5,Iris-versicolor
-5.8,2.7,4.1,1.0,Iris-versicolor
-6.2,2.2,4.5,1.5,Iris-versicolor
-5.6,2.5,3.9,1.1,Iris-versicolor
-5.9,3.2,4.8,1.8,Iris-versicolor
-6.1,2.8,4.0,1.3,Iris-versicolor
-6.3,2.5,4.9,1.5,Iris-versicolor
-6.1,2.8,4.7,1.2,Iris-versicolor
-6.4,2.9,4.3,1.3,Iris-versicolor
-6.6,3.0,4.4,1.4,Iris-versicolor
-6.8,2.8,4.8,1.4,Iris-versicolor
-6.7,3.0,5.0,1.7,Iris-versicolor
-6.0,2.9,4.5,1.5,Iris-versicolor
-5.7,2.6,3.5,1.0,Iris-versicolor
-5.5,2.4,3.8,1.1,Iris-versicolor
-5.5,2.4,3.7,1.0,Iris-versicolor
-5.8,2.7,3.9,1.2,Iris-versicolor
-6.0,2.7,5.1,1.6,Iris-versicolor
-5.4,3.0,4.5,1.5,Iris-versicolor
-6.0,3.4,4.5,1.6,Iris-versicolor
-6.7,3.1,4.7,1.5,Iris-versicolor
-6.3,2.3,4.4,1.3,Iris-versicolor
-5.6,3.0,4.1,1.3,Iris-versicolor
-5.5,2.5,4.0,1.3,Iris-versicolor
-5.5,2.6,4.4,1.2,Iris-versicolor
-6.1,3.0,4.6,1.4,Iris-versicolor
-5.8,2.6,4.0,1.2,Iris-versicolor
-5.0,2.3,3.3,1.0,Iris-versicolor
-5.6,2.7,4.2,1.3,Iris-versicolor
-5.7,3.0,4.2,1.2,Iris-versicolor
-5.7,2.9,4.2,1.3,Iris-versicolor
-6.2,2.9,4.3,1.3,Iris-versicolor
-5.1,2.5,3.0,1.1,Iris-versicolor
-5.7,2.8,4.1,1.3,Iris-versicolor
-6.3,3.3,6.0,2.5,Iris-virginica
-5.8,2.7,5.1,1.9,Iris-virginica
-7.1,3.0,5.9,2.1,Iris-virginica
-6.3,2.9,5.6,1.8,Iris-virginica
-6.5,3.0,5.8,2.2,Iris-virginica
-7.6,3.0,6.6,2.1,Iris-virginica
-4.9,2.5,4.5,1.7,Iris-virginica
-7.3,2.9,6.3,1.8,Iris-virginica
-6.7,2.5,5.8,1.8,Iris-virginica
-7.2,3.6,6.1,2.5,Iris-virginica
-6.5,3.2,5.1,2.0,Iris-virginica
-6.4,2.7,5.3,1.9,Iris-virginica
-6.8,3.0,5.5,2.1,Iris-virginica
-5.7,2.5,5.0,2.0,Iris-virginica
-5.8,2.8,5.1,2.4,Iris-virginica
-6.4,3.2,5.3,2.3,Iris-virginica
-6.5,3.0,5.5,1.8,Iris-virginica
-7.7,3.8,6.7,2.2,Iris-virginica
-7.7,2.6,6.9,2.3,Iris-virginica
-6.0,2.2,5.0,1.5,Iris-virginica
-6.9,3.2,5.7,2.3,Iris-virginica
-5.6,2.8,4.9,2.0,Iris-virginica
-7.7,2.8,6.7,2.0,Iris-virginica
-6.3,2.7,4.9,1.8,Iris-virginica
-6.7,3.3,5.7,2.1,Iris-virginica
-7.2,3.2,6.0,1.8,Iris-virginica
-6.2,2.8,4.8,1.8,Iris-virginica
-6.1,3.0,4.9,1.8,Iris-virginica
-6.4,2.8,5.6,2.1,Iris-virginica
-7.2,3.0,5.8,1.6,Iris-virginica
-7.4,2.8,6.1,1.9,Iris-virginica
-7.9,3.8,6.4,2.0,Iris-virginica
-6.4,2.8,5.6,2.2,Iris-virginica
-6.3,2.8,5.1,1.5,Iris-virginica
-6.1,2.6,5.6,1.4,Iris-virginica
-7.7,3.0,6.1,2.3,Iris-virginica
-6.3,3.4,5.6,2.4,Iris-virginica
-6.4,3.1,5.5,1.8,Iris-virginica
-6.0,3.0,4.8,1.8,Iris-virginica
-6.9,3.1,5.4,2.1,Iris-virginica
-6.7,3.1,5.6,2.4,Iris-virginica
-6.9,3.1,5.1,2.3,Iris-virginica
-5.8,2.7,5.1,1.9,Iris-virginica
-6.8,3.2,5.9,2.3,Iris-virginica
-6.7,3.3,5.7,2.5,Iris-virginica
-6.7,3.0,5.2,2.3,Iris-virginica
-6.3,2.5,5.0,1.9,Iris-virginica
-6.5,3.0,5.2,2.0,Iris-virginica
-6.2,3.4,5.4,2.3,Iris-virginica
-5.9,3.0,5.1,1.8,Iris-virginica

01.getting-started/05.train-in-spark/train-spark.py

@@ -1,94 +0,0 @@
-# Copyright (c) Microsoft. All rights reserved.
-# Licensed under the MIT license.
-
-import numpy as np
-import pyspark
-import os
-import urllib
-import sys
-
-from pyspark.sql.functions import *
-from pyspark.ml.classification import *
-from pyspark.ml.evaluation import *
-from pyspark.ml.feature import *
-from pyspark.sql.types import StructType, StructField
-from pyspark.sql.types import DoubleType, IntegerType, StringType
-
-
-from azureml.core.run import Run
-
-# initialize logger
-run = Run.get_submitted_run()
-
-# start Spark session
-spark = pyspark.sql.SparkSession.builder.appName('Iris').getOrCreate()
-
-# print runtime versions
-print('****************')
-print('Python version: {}'.format(sys.version))
-print('Spark version: {}'.format(spark.version))
-print('****************')
-
-# load iris.csv into Spark dataframe
-schema = StructType([
-    StructField("sepal-length", DoubleType()),
-    StructField("sepal-width", DoubleType()),
-    StructField("petal-length", DoubleType()),
-    StructField("petal-width", DoubleType()),
-    StructField("class", StringType())
-])
-
-data = spark.read.csv('iris.csv', header=False, schema=schema)
-print("First 10 rows of Iris dataset:")
-data.show(10)
-
-# vectorize all numerical columns into a single feature column
-feature_cols = data.columns[:-1]
-assembler = pyspark.ml.feature.VectorAssembler(
-    inputCols=feature_cols, outputCol='features')
-data = assembler.transform(data)
-
-# convert text labels into indices
-data = data.select(['features', 'class'])
-label_indexer = pyspark.ml.feature.StringIndexer(
-    inputCol='class', outputCol='label').fit(data)
-data = label_indexer.transform(data)
-
-# only select the features and label column
-data = data.select(['features', 'label'])
-print("Reading for machine learning")
-data.show(10)
-
-# change regularization rate and you will likely get a different accuracy.
-reg = 0.01
-# load regularization rate from argument if present
-if len(sys.argv) > 1:
-    reg = float(sys.argv[1])
-
-# log regularization rate
-run.log("Regularization Rate", reg)
-
-# use Logistic Regression to train on the training set
-train, test = data.randomSplit([0.70, 0.30])
-lr = pyspark.ml.classification.LogisticRegression(regParam=reg)
-model = lr.fit(train)
-
-# predict on the test set
-prediction = model.transform(test)
-print("Prediction")
-prediction.show(10)
-
-# evaluate the accuracy of the model using the test set
-evaluator = pyspark.ml.evaluation.MulticlassClassificationEvaluator(
-    metricName='accuracy')
-accuracy = evaluator.evaluate(prediction)
-
-print()
-print('#####################################')
-print('Regularization rate is {}'.format(reg))
-print("Accuracy is {}".format(accuracy))
-print('#####################################')
-print()
-
-# log accuracy
-run.log('Accuracy', accuracy)

NBSETUP.md

@@ -0,0 +1,34 @@
+# Notebook setup
+
+---
+
+To run the notebooks in this repository use one of these methods:
+
+## Use Azure Notebooks - Jupyter based notebooks in the Azure cloud
+
+1. [![Azure Notebooks](https://notebooks.azure.com/launch.png)](https://aka.ms/aml-clone-azure-notebooks)
+[Import sample notebooks ](https://aka.ms/aml-clone-azure-notebooks) into Azure Notebooks
+1. Follow the instructions in the [Configuration](configuration.ipynb) notebook to create and connect to a workspace
+1. Open one of the sample notebooks
+
+    **Make sure the Azure Notebook kernel is set to `Python 3.6`** when you open a notebook
+
+    ![set kernel to Python 3.6](images/python36.png)
+
+## **Use your own notebook server**
+
+Video walkthrough:
+
+[![Get Started video](images/yt_cover.png)](https://youtu.be/VIsXeTuW3FU)
+
+1. Setup a Jupyter Notebook server and [install the Azure Machine Learning SDK](https://docs.microsoft.com/en-us/azure/machine-learning/service/quickstart-create-workspace-with-python)
+1. Clone [this repository](https://aka.ms/aml-notebooks)
+1. You may need to install other packages for specific notebook
+    - For example, to run the Azure Machine Learning Data Prep notebooks, install the extra dataprep SDK:
+    ```bash
+     pip install azureml-dataprep
+    ```
+
+1. Start your notebook server
+1. Follow the instructions in the [Configuration](configuration.ipynb) notebook to create and connect to a workspace
+1. Open one of the sample notebooks

README.md

@@ -1,45 +1,40 @@
-# Sample notebooks for Azure Machine Learning service
+# Azure Machine Learning service sample notebooks
 
-To run the notebooks in this repository use one of these methods:
+---
 
-## Use Azure Notebooks - Jupyter based notebooks in the Azure cloud
+This repository contains example notebooks demonstrating the [Azure Machine Learning](https://azure.microsoft.com/en-us/services/machine-learning-service/) Python SDK
+which allows you to build, train, deploy and manage machine learning solutions using Azure.  The AML SDK
+allows you the choice of using local or cloud compute resources, while managing
+and maintaining the complete data science workflow from the cloud.
 
-1. [![Azure Notebooks](https://notebooks.azure.com/launch.png)](https://aka.ms/aml-clone-azure-notebooks)
-[Import sample notebooks ](https://aka.ms/aml-clone-azure-notebooks) into Azure Notebooks if they are not already there.
-1.  Create a workspace and its configuration file (**config.json**) using [these instructions](https://aka.ms/aml-how-to-configure-environment).
-1. Select `+New` in the Azure Notebook toolbar to add your **config.json** file to the imported folder.
-    ![upload config file to notebook folder](images/additems.png)
-1. Open the notebook.
+You can find instructions on setting up notebooks [here](./NBSETUP.md)
 
-    **Make sure the Azure Notebook kernal is set to `Python 3.6`** when you open a notebook. 
+You can find full documentation for Azure Machine Learning [here](https://aka.ms/aml-docs)
 
-    ![set kernal to Python 3.6](images/python36.png)
+## Getting Started
 
+These examples will provide you with an effective way to get started using AML.  Once you're familiar with
+some of the capabilities, explore the repository for specific topics.
 
-## **Use your own notebook server**
+- [Configuration](./configuration.ipynb) configures your notebook library to easily connect to an
+    Azure Machine Learning workspace, and sets up your workspace to be used by many of the other examples.  You should
+    always run this first when setting up a notebook library on a new machine or in a new environment
+- [Train in notebook](./how-to-use-azureml/training/train-within-notebook) shows how to create a model directly in a notebook while recording
+    metrics and deploy that model to a test service
+- [Train on remote](./how-to-use-azureml/training/train-on-remote-vm) takes the previous example and shows how to create the model on a cloud compute target
+- [Production deploy to AKS](./how-to-use-azureml/deployment/production-deploy-to-aks) shows how to create a production grade inferencing webservice
 
-1. Use [these instructions](https://aka.ms/aml-how-to-configure-environment) to:
-    * Create a workspace and its configuration file (**config.json**).
-    * Configure your notebook server.
-1. Clone [this repository](https://aka.ms/aml-notebooks).
-1. Add your **config.json** file to the cloned folder
-1. You may need to install other packages for specific notebooks
-1. Start your notebook server.
-1. Open the notebook you want to run.
+## Tutorials
 
-> Note: **Looking for automated machine learning samples?**
-> For your convenience, you can use an installation script instead of the steps below for the automated ML notebooks. Go to the [automl folder README](automl/README.md) and follow the instructions.  The script installs all  packages needed for notebooks in that folder.
+The [Tutorials](./tutorials) folder contains notebooks for the tutorials described in the [Azure Machine Learning documentation](https://aka.ms/aml-docs)
   
-# Contributing
+## How to use AML
 
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.microsoft.com.
+The [How to use AML](./how-to-use-azureml) folder contains specific examples demonstrating the features of the Azure Machine Learning SDK
 
-When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
-
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+- [Training](./how-to-use-azureml/training) - Examples of how to build models using Azure ML's logging and execution capabilities on local and remote compute targets.
+- [Training with Deep Learning](./how-to-use-azureml/training-with-deep-learning) - Examples demonstrating how to build deep learning models using estimators and parameter sweeps
+- [Automated Machine Learning](./how-to-use-azureml/automated-machine-learning) - Examples using Automated Machine Learning to automatically generate optimal machine learning pipelines and models
+- [Machine Learning Pipelines](./how-to-use-azureml/machine-learning-pipelines) - Examples showing how to create and use reusable pipelines for training and batch scoring
+- [Deployment](./how-to-use-azureml/deployment) - Examples showing how to deploy and manage machine learning models and solutions
+- [Azure Databricks](./how-to-use-azureml/azure-databricks) - Examples showing how to use Azure ML with Azure Databricks

automl/00.configuration.ipynb

@@ -1,265 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# AutoML 00. configuration\n",
-    "\n",
-    "In this example you will create an Azure Machine Learning Workspace and initialize your notebook directory to easily use this workspace.  Typically you will only need to run this once per notebook directory, and all other notebooks in this directory or any sub-directories will automatically use the settings you indicate here.\n",
-    "\n",
-    "\n",
-    "## Prerequisites:\n",
-    "\n",
-    "Before running this notebook, run the automl_setup script described in README.md.\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Connect to your Azure Subscription\n",
-    "\n",
-    "In order to use an AML Workspace, first you need access to an Azure Subscription.  You can [create your own](https://azure.microsoft.com/en-us/free/) or get your existing subscription information from the [Azure portal](https://portal.azure.com).\n",
-    "\n",
-    "First login to azure and follow prompts to authenticate. Then check that your subscription is correct"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!az login"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!az account show"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "If you have multiple subscriptions and need to change the active one, you can use a command\n",
-    "```shell\n",
-    "az account set -s <subscription-id>\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Register Machine Learning Services Resource Provider\n",
-    "\n",
-    "This step is required to use the Azure ML services backing the SDK."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# register the new RP\n",
-    "!az provider register -n Microsoft.MachineLearningServices\n",
-    "\n",
-    "# check the registration status\n",
-    "!az provider show -n Microsoft.MachineLearningServices"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Check core SDK version number for validate your installation and for debugging purposes"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import azureml.core\n",
-    "\n",
-    "print(\"SDK Version:\", azureml.core.VERSION)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Initialize an Azure ML Workspace\n",
-    "### What is an Azure ML Workspace and why do I need one?\n",
-    "\n",
-    "An AML Workspace is an Azure resource that organaizes and coordinates the actions of many other Azure resources to assist in executing and sharing machine learning workflows.  In particular, an AML Workspace coordinates storage, databases, and compute resources providing added functionality for machine learning experimentation, operationalization, and the monitoring of operationalized models.\n",
-    "\n",
-    "\n",
-    "### What do I need\n",
-    "\n",
-    "To create or access an Azure ML Workspace, you will need to import the AML library and specify following information:\n",
-    "* A name for your workspace. You can choose one.\n",
-    "* Your subscription id. Use *id* value from *az account show* output above. \n",
-    "* The resource group name. Resource group organizes Azure resources and provides default region for the resources in the group. You can either specify a new one, in which case it gets created for your Workspace, or use an existing one or create a new one from [Azure portal](https://portal.azure.com)\n",
-    "* Supported regions include `eastus2`, `eastus`,`westcentralus`, `southeastasia`, `westeurope`, `australiaeast`, `westus2`, `southcentralus`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "subscription_id = \"<subscription_id>\"\n",
-    "resource_group = \"myrg\"\n",
-    "workspace_name = \"myws\"\n",
-    "workspace_region = \"eastus2\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Creating a workspace\n",
-    "If you already have access to an AML Workspace you want to use, you can skip this cell.  Otherwise, this cell will create an AML workspace for you in a subscription provided you have the correct permissions for the given `subscription_id`.\n",
-    "\n",
-    "This will fail when:\n",
-    "1. The workspace already exists\n",
-    "2. You do not have permission to create a workspace in the resource group\n",
-    "3. You are not a subscription owner or contributor and no Azure ML workspaces have ever been created in this subscription\n",
-    "\n",
-    "If workspace creation fails for any reason other than already existing, please work with your IT admin to provide you with the appropriate permissions or to provision the required resources.\n",
-    "\n",
-    "**Note** The workspace creation can take several minutes."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# import the Workspace class and check the azureml SDK version\n",
-    "from azureml.core import Workspace\n",
-    "\n",
-    "ws = Workspace.create(name = workspace_name,\n",
-    "                      subscription_id = subscription_id,\n",
-    "                      resource_group = resource_group, \n",
-    "                      location = workspace_region)\n",
-    "ws.get_details()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Configuring your local environment\n",
-    "You can validate that you have access to the specified workspace and write a configuration file to the default configuration location, `./aml_config/config.json`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core import Workspace\n",
-    "\n",
-    "ws = Workspace(workspace_name = workspace_name,\n",
-    "               subscription_id = subscription_id,\n",
-    "               resource_group = resource_group)\n",
-    "\n",
-    "# persist the subscription id, resource group name, and workspace name in aml_config/config.json.\n",
-    "ws.write_config()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can then load the workspace from this config file from any notebook in the current directory."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# load workspace configuratio from ./aml_config/config.json file.\n",
-    "my_workspace = Workspace.from_config()\n",
-    "my_workspace.get_details()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create a folder to host all sample projects\n",
-    "Lastly, create a folder where all the sample projects will be hosted."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "sample_projects_folder = './sample_projects'\n",
-    "\n",
-    "if not os.path.isdir(sample_projects_folder):\n",
-    "    os.mkdir(sample_projects_folder)\n",
-    "    \n",
-    "print('Sample projects will be created in {}.'.format(sample_projects_folder))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Success!\n",
-    "Great, you are ready to move on to the rest of the sample notebooks."
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

automl/04.auto-ml-remote-execution-text-data-blob-store.ipynb

@@ -1,495 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Auto ML : Remote Execution with Text data from Blobstorage\n",
-    "\n",
-    "In this example we use the [Burning Man 2016 dataset](https://innovate.burningman.org/datasets-page/) to showcase how you can use AutoML to handle text data from a Azure blobstorage.\n",
-    "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
-    "\n",
-    "In this notebook you would see\n",
-    "1. Creating an Experiment using an existing Workspace\n",
-    "2. Attaching an existing DSVM to a workspace\n",
-    "3. Instantiating AutoMLConfig \n",
-    "4. Training the Model using the DSVM\n",
-    "5. Exploring the results\n",
-    "6. Testing the fitted model\n",
-    "\n",
-    "In addition this notebook showcases the following features\n",
-    "- **Parallel** Executions for iterations\n",
-    "- Asyncronous tracking of progress\n",
-    "- **Cancelling** individual iterations or the entire run\n",
-    "- Retrieving models for any iteration or logged metric\n",
-    "- specify automl settings as **kwargs**\n",
-    "- handling **text** data with **preprocess** flag\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create Experiment\n",
-    "\n",
-    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import logging\n",
-    "import os\n",
-    "import random\n",
-    "\n",
-    "from matplotlib import pyplot as plt\n",
-    "from matplotlib.pyplot import imshow\n",
-    "import numpy as np\n",
-    "import pandas as pd\n",
-    "from sklearn import datasets\n",
-    "\n",
-    "import azureml.core\n",
-    "from azureml.core.experiment import Experiment\n",
-    "from azureml.core.workspace import Workspace\n",
-    "from azureml.train.automl import AutoMLConfig\n",
-    "from azureml.train.automl.run import AutoMLRun"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "ws = Workspace.from_config()\n",
-    "\n",
-    "# choose a name for the run history container in the workspace\n",
-    "experiment_name = 'automl-remote-dsvm-blobstore'\n",
-    "# project folder\n",
-    "project_folder = './sample_projects/automl-remote-dsvm-blobstore'\n",
-    "\n",
-    "experiment = Experiment(ws, experiment_name)\n",
-    "\n",
-    "output = {}\n",
-    "output['SDK version'] = azureml.core.VERSION\n",
-    "output['Subscription ID'] = ws.subscription_id\n",
-    "output['Workspace'] = ws.name\n",
-    "output['Resource Group'] = ws.resource_group\n",
-    "output['Location'] = ws.location\n",
-    "output['Project Directory'] = project_folder\n",
-    "output['Experiment Name'] = experiment.name\n",
-    "pd.set_option('display.max_colwidth', -1)\n",
-    "pd.DataFrame(data=output, index=['']).T"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Diagnostics\n",
-    "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Attach a Remote Linux DSVM\n",
-    "To use remote docker commpute target:\n",
-    "1. Create a Linux DSVM in Azure. Here is some [quick instructions](https://docs.microsoft.com/en-us/azure/machine-learning/desktop-workbench/how-to-create-dsvm-hdi). Make sure you use the Ubuntu flavor, NOT CentOS.  Make sure that disk space is available under /tmp because AutoML creates files under /tmp/azureml_runs. The DSVM should have more cores than the number of parallel runs that you plan to enable. It should also have at least 4Gb per core.\n",
-    "2. Enter the IP address, username and password below\n",
-    "\n",
-    "**Note**: By default SSH runs on port 22 and you don't need to specify it. But if for security reasons you can switch to a different port (such as 5022), you can append the port number to the address. [Read more](https://render.githubusercontent.com/documentation/sdk/ssh-issue.md) on this."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.core.compute import RemoteCompute\n",
-    "\n",
-    "# Add your VM information below\n",
-    "dsvm_name     = 'mydsvm1'\n",
-    "dsvm_ip_addr  = '<<ip_addr>>'\n",
-    "dsvm_username = '<<username>>'\n",
-    "dsvm_password = '<<password>>'\n",
-    "\n",
-    "dsvm_compute = RemoteCompute.attach(workspace=ws, name=dsvm_name, address=dsvm_ip_addr, username=dsvm_username, password=dsvm_password, ssh_port=22)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create Get Data File\n",
-    "For remote executions you should author a get_data.py file containing a get_data() function. This file should be in the root directory of the project. You can encapsulate code to read data either from a blob storage or local disk in this file.\n",
-    "\n",
-    "The *get_data()* function returns a [dictionary](README.md#getdata)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "if not os.path.exists(project_folder):\n",
-    "    os.makedirs(project_folder)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%writefile $project_folder/get_data.py\n",
-    "\n",
-    "import pandas as pd\n",
-    "from sklearn.model_selection import train_test_split\n",
-    "from sklearn.preprocessing import LabelEncoder\n",
-    "\n",
-    "def get_data():\n",
-    "    # Burning man 2016 data\n",
-    "    df = pd.read_csv(\"https://automldemods.blob.core.windows.net/datasets/PlayaEvents2016,_1.6MB,_3.4k-rows.cleaned.2.tsv\",\n",
-    "                     delimiter=\"\\t\", quotechar='\"')\n",
-    "    # get integer labels\n",
-    "    le = LabelEncoder()\n",
-    "    le.fit(df[\"Label\"].values)\n",
-    "    y = le.transform(df[\"Label\"].values)\n",
-    "    df = df.drop([\"Label\"], axis=1)\n",
-    "\n",
-    "    df_train, _, y_train, _ = train_test_split(df, y, test_size=0.1, random_state=42)\n",
-    "\n",
-    "    return { \"X\" : df, \"y\" : y }"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### View data\n",
-    "\n",
-    "You can execute the *get_data()* function locally to view the *train* data"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%run  $project_folder/get_data.py\n",
-    "data_dict = get_data()\n",
-    "df = data_dict[\"X\"]\n",
-    "y = data_dict[\"y\"]\n",
-    "pd.set_option('display.max_colwidth', 15)\n",
-    "df['Label'] = pd.Series(y, index=df.index)\n",
-    "df.head()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Instantiate AutoML <a class=\"anchor\" id=\"Instatiate-AutoML-Remote-DSVM\"></a>\n",
-    "\n",
-    "You can specify automl_settings as **kwargs** as well. Also note that you can use the get_data() symantic for local excutions too. \n",
-    "\n",
-    "<i>Note: For Remote DSVM and Batch AI you cannot pass Numpy arrays directly to the fit method.</i>\n",
-    "\n",
-    "|Property|Description|\n",
-    "|-|-|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data|\n",
-    "|**n_cross_validations**|Number of cross validation splits|\n",
-    "|**concurrent_iterations**|Max number of iterations that would be executed in parallel.  This should be less than the number of cores on the DSVM\n",
-    "|**preprocess**| *True/False* <br>Setting this to *True* enables AutoML to perform preprocessing <br>on the input to handle *missing data*, and perform some common *feature extraction*|\n",
-    "|**max_cores_per_iteration**| Indicates how many cores on the compute target would be used to train a single pipeline.<br> Default is *1*, you can set it to *-1* to use all cores|"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "automl_settings = {\n",
-    "    \"max_time_sec\": 3600,\n",
-    "    \"iterations\": 10,\n",
-    "    \"n_cross_validations\": 5,\n",
-    "    \"primary_metric\": 'AUC_weighted',\n",
-    "    \"preprocess\": True,\n",
-    "    \"max_cores_per_iteration\": 2\n",
-    "}\n",
-    "\n",
-    "automl_config = AutoMLConfig(task = 'classification',\n",
-    "                             path=project_folder,\n",
-    "                             compute_target = dsvm_compute,\n",
-    "                             data_script = project_folder + \"/get_data.py\",\n",
-    "                             **automl_settings\n",
-    "                            )\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Training the Model <a class=\"anchor\" id=\"Training-the-model-Remote-DSVM\"></a>\n",
-    "\n",
-    "For remote runs the execution is asynchronous, so you will see the iterations get populated as they complete. You can interact with the widgets/models even when the experiment is running to retreive the best model up to that point. Once you are satisfied with the model you can cancel a particular iteration or the whole run."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "remote_run = experiment.submit(automl_config)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Exploring the Results <a class=\"anchor\" id=\"Exploring-the-Results-Remote-DSVM\"></a>\n",
-    "#### Widget for monitoring runs\n",
-    "\n",
-    "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
-    "\n",
-    "You can click on a pipeline to see run properties and output logs. Logs are also available on the DSVM under /tmp/azureml_run/{iterationid}/azureml-logs\n",
-    "\n",
-    "NOTE: The widget displays a link at the bottom. This links to a web-ui to explore the individual run details."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.train.widgets import RunDetails\n",
-    "RunDetails(remote_run).show() "
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "#### Retrieve All Child Runs\n",
-    "You can also use sdk methods to fetch all the child runs and see individual metrics that we log. "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "children = list(remote_run.get_children())\n",
-    "metricslist = {}\n",
-    "for run in children:\n",
-    "    properties = run.get_properties()\n",
-    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
-    "    metricslist[int(properties['iteration'])] = metrics\n",
-    "\n",
-    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
-    "rundata"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Canceling runs\n",
-    "You can cancel ongoing remote runs using the *cancel()* and *cancel_iteration()* functions"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Cancel the ongoing experiment and stop scheduling new iterations\n",
-    "remote_run.cancel()\n",
-    "\n",
-    "# Cancel iteration 1 and move onto iteration 2\n",
-    "# remote_run.cancel_iteration(1)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Retrieve the Best Model\n",
-    "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "best_run, fitted_model = remote_run.get_output()\n",
-    "print(best_run)\n",
-    "print(fitted_model)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Best Model based on any other metric"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# lookup_metric = \"accuracy\"\n",
-    "# best_run, fitted_model = remote_run.get_output(metric=lookup_metric)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Model from a specific iteration"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "iteration = 0\n",
-    "zero_run, zero_model = remote_run.get_output(iteration=iteration)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Register fitted model for deployment"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "description = 'AutoML Model'\n",
-    "tags = None\n",
-    "remote_run.register_model(description=description, tags=tags)\n",
-    "remote_run.model_id # Use this id to deploy the model as a web service in Azure"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Testing the Fitted Model <a class=\"anchor\" id=\"Testing-the-Fitted-Model-Remote-DSVM\"></a>\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import sklearn\n",
-    "from sklearn.model_selection import train_test_split\n",
-    "from sklearn.preprocessing import LabelEncoder\n",
-    "from pandas_ml import ConfusionMatrix\n",
-    "\n",
-    "df = pd.read_csv(\"https://automldemods.blob.core.windows.net/datasets/PlayaEvents2016,_1.6MB,_3.4k-rows.cleaned.2.tsv\",\n",
-    "                     delimiter=\"\\t\", quotechar='\"')\n",
-    "\n",
-    "# get integer labels\n",
-    "le = LabelEncoder()\n",
-    "le.fit(df[\"Label\"].values)\n",
-    "y = le.transform(df[\"Label\"].values)\n",
-    "df = df.drop([\"Label\"], axis=1)\n",
-    "\n",
-    "_, df_test, _, y_test = train_test_split(df, y, test_size=0.1, random_state=42)\n",
-    "\n",
-    "\n",
-    "ypred = fitted_model.predict(df_test.values)\n",
-    "\n",
-    "\n",
-    "ypred_strings = le.inverse_transform(ypred)\n",
-    "ytest_strings = le.inverse_transform(y_test)\n",
-    "\n",
-    "cm = ConfusionMatrix(ytest_strings, ypred_strings)\n",
-    "\n",
-    "print(cm)\n",
-    "\n",
-    "cm.plot()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

automl/05.auto-ml-missing-data-Blacklist-Early-Termination.ipynb

@@ -1,396 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# AutoML 05 : Blacklisting models, Early termination and handling missing data\n",
-    "\n",
-    "In this example we use the scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) to showcase how you can use AutoML for handling missing values in data. We also provide a stopping metric indicating a target for the primary metric so that AutoML can terminate the run without necessarly going through all the iterations. Finally, if you want to avoid a certain pipeline, we allow you to specify a black list of algos that AutoML will ignore for this run.\n",
-    "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
-    "\n",
-    "In this notebook you would see\n",
-    "1. Creating an Experiment using an existing Workspace\n",
-    "2. Instantiating AutoMLConfig\n",
-    "4. Training the Model\n",
-    "5. Exploring the results\n",
-    "6. Testing the fitted model\n",
-    "\n",
-    "In addition this notebook showcases the following features\n",
-    "- **Blacklist** certain pipelines\n",
-    "- Specify a **target metrics** to indicate stopping criteria\n",
-    "- Handling **Missing Data** in the input\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "## Create Experiment\n",
-    "\n",
-    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import logging\n",
-    "import os\n",
-    "import random\n",
-    "\n",
-    "from matplotlib import pyplot as plt\n",
-    "from matplotlib.pyplot import imshow\n",
-    "import numpy as np\n",
-    "import pandas as pd\n",
-    "from sklearn import datasets\n",
-    "\n",
-    "import azureml.core\n",
-    "from azureml.core.experiment import Experiment\n",
-    "from azureml.core.workspace import Workspace\n",
-    "from azureml.train.automl import AutoMLConfig\n",
-    "from azureml.train.automl.run import AutoMLRun"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "ws = Workspace.from_config()\n",
-    "\n",
-    "# choose a name for the experiment\n",
-    "experiment_name = 'automl-local-missing-data'\n",
-    "# project folder\n",
-    "project_folder = './sample_projects/automl-local-missing-data'\n",
-    "\n",
-    "experiment=Experiment(ws, experiment_name)\n",
-    "\n",
-    "output = {}\n",
-    "output['SDK version'] = azureml.core.VERSION\n",
-    "output['Subscription ID'] = ws.subscription_id\n",
-    "output['Workspace'] = ws.name\n",
-    "output['Resource Group'] = ws.resource_group\n",
-    "output['Location'] = ws.location\n",
-    "output['Project Directory'] = project_folder\n",
-    "output['Experiment Name'] = experiment.name\n",
-    "pd.set_option('display.max_colwidth', -1)\n",
-    "pd.DataFrame(data=output, index=['']).T"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Diagnostics\n",
-    "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Creating Missing Data"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from scipy import sparse\n",
-    "\n",
-    "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[10:,:]\n",
-    "y_digits = digits.target[10:]\n",
-    "\n",
-    "# Add missing values in 75% of the lines\n",
-    "missing_rate = 0.75\n",
-    "n_missing_samples = int(np.floor(X_digits.shape[0] * missing_rate))\n",
-    "missing_samples = np.hstack((np.zeros(X_digits.shape[0] - n_missing_samples, dtype=np.bool), np.ones(n_missing_samples, dtype=np.bool)))\n",
-    "rng = np.random.RandomState(0)\n",
-    "rng.shuffle(missing_samples)\n",
-    "missing_features = rng.randint(0, X_digits.shape[1], n_missing_samples)\n",
-    "X_digits[np.where(missing_samples)[0], missing_features] = np.nan"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "df = pd.DataFrame(data=X_digits)\n",
-    "df['Label'] = pd.Series(y_digits, index=df.index)\n",
-    "df.head()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Instantiate Auto ML Config\n",
-    "\n",
-    "\n",
-    "This defines the settings and data used to run the experiment.\n",
-    "\n",
-    "|Property|Description|\n",
-    "|-|-|\n",
-    "|**task**|classification or regression|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains the data with a specific pipeline|\n",
-    "|**n_cross_validations**|Number of cross validation splits|\n",
-    "|**preprocess**| *True/False* <br>Setting this to *True* enables Auto ML to perform preprocessing <br>on the input to handle *missing data*, and perform some common *feature extraction*|\n",
-    "|**exit_score**|*double* value indicating the target for *primary_metric*. <br> Once the target is surpassed the run terminates|\n",
-    "|**blacklist_algos**|*Array* of *strings* indicating pipelines to ignore for Auto ML.<br><br> Allowed values for **Classification**<br><i>LogisticRegression</i><br><i>SGDClassifierWrapper</i><br><i>NBWrapper</i><br><i>BernoulliNB</i><br><i>SVCWrapper</i><br><i>LinearSVMWrapper</i><br><i>KNeighborsClassifier</i><br><i>DecisionTreeClassifier</i><br><i>RandomForestClassifier</i><br><i>ExtraTreesClassifier</i><br><i>LightGBMClassifier</i><br><br>Allowed values for **Regression**<br><i>ElasticNet<i><br><i>GradientBoostingRegressor<i><br><i>DecisionTreeRegressor<i><br><i>KNeighborsRegressor<i><br><i>LassoLars<i><br><i>SGDRegressor<i><br><i>RandomForestRegressor<i><br><i>ExtraTreesRegressor<i>|\n",
-    "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
-    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers. |\n",
-    "|**path**|Relative path to the project folder.  AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder. |"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "automl_config = AutoMLConfig(task = 'classification',\n",
-    "                             debug_log = 'automl_errors.log',\n",
-    "                             primary_metric = 'AUC_weighted',\n",
-    "                             max_time_sec = 3600,\n",
-    "                             iterations = 20,\n",
-    "                             n_cross_validations = 5,\n",
-    "                             preprocess = True,\n",
-    "                             exit_score = 0.994,\n",
-    "                             blacklist_algos = ['KNeighborsClassifier','LinearSVMWrapper'],\n",
-    "                             verbosity = logging.INFO,\n",
-    "                             X = X_digits, \n",
-    "                             y = y_digits,\n",
-    "                             path=project_folder)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Training the Model\n",
-    "\n",
-    "You can call the submit method on the experiment object and pass the run configuration. For Local runs the execution is synchronous. Depending on the data and number of iterations this can run for while.\n",
-    "You will see the currently running iterations printing to the console."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "local_run = experiment.submit(automl_config, show_output=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Exploring the results"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Widget for monitoring runs\n",
-    "\n",
-    "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
-    "\n",
-    "NOTE: The widget will display a link at the bottom. This will not currently work, but will eventually link to a web-ui to explore the individual run details."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.train.widgets import RunDetails\n",
-    "RunDetails(local_run).show() "
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "#### Retrieve All Child Runs\n",
-    "You can also use sdk methods to fetch all the child runs and see individual metrics that we log. "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "children = list(local_run.get_children())\n",
-    "metricslist = {}\n",
-    "for run in children:\n",
-    "    properties = run.get_properties()\n",
-    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
-    "    metricslist[int(properties['iteration'])] = metrics\n",
-    "\n",
-    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
-    "rundata"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Retrieve the Best Model\n",
-    "\n",
-    "Below we select the best pipeline from our iterations. Each pipeline is a tuple of three elements. The first element is the score for the pipeline the second element is the string description of the pipeline and the last element are the pipeline objects used for each fold in the cross-validation."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "best_run, fitted_model = local_run.get_output()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Best Model based on any other metric"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# lookup_metric = \"accuracy\"\n",
-    "# best_run, fitted_model = local_run.get_output(metric=lookup_metric)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Model from a specific iteration"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# iteration = 3\n",
-    "# best_run, fitted_model = local_run.get_output(iteration=iteration)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Register fitted model for deployment"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "description = 'AutoML Model'\n",
-    "tags = None\n",
-    "local_run.register_model(description=description, tags=tags)\n",
-    "local_run.model_id # Use this id to deploy the model as a web service in Azure"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Testing the Fitted Model "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[:10, :]\n",
-    "y_digits = digits.target[:10]\n",
-    "images = digits.images[:10]\n",
-    "\n",
-    "#Randomly select digits and test\n",
-    "for index in np.random.choice(len(y_digits), 2):\n",
-    "    print(index)\n",
-    "    predicted = fitted_model.predict(X_digits[index:index + 1])[0]\n",
-    "    label = y_digits[index]\n",
-    "    title = \"Label value = %d  Predicted value = %d \" % ( label,predicted)\n",
-    "    fig = plt.figure(1, figsize=(3,3))\n",
-    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
-    "    ax1.set_title(title)\n",
-    "    plt.imshow(images[index], cmap=plt.cm.gray_r, interpolation='nearest')\n",
-    "    plt.show()\n"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

automl/10.auto-ml-multi-output-example.ipynb

@@ -1,292 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# AutoML 10: Multi output Example for AutoML"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This notebook shows an example to use AutoML to train the multi output problems by leveraging the correlation between the outputs using indicator vectors."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import logging\n",
-    "import os\n",
-    "import random\n",
-    "\n",
-    "from matplotlib import pyplot as plt\n",
-    "from matplotlib.pyplot import imshow\n",
-    "import numpy as np\n",
-    "import pandas as pd\n",
-    "from sklearn import datasets\n",
-    "\n",
-    "import azureml.core\n",
-    "from azureml.core.experiment import Experiment\n",
-    "from azureml.core.workspace import Workspace\n",
-    "from azureml.train.automl import AutoMLConfig\n",
-    "from azureml.train.automl.run import AutoMLRun"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Diagnostics\n",
-    "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Transformer functions\n",
-    "The transformation of the input are happening for input X and Y as following, e.g. Y = {y_1, y_2}, then X becomes\n",
-    "    \n",
-    "X 1 0\n",
-    "     \n",
-    "X 0 1\n",
-    "\n",
-    "and Y becomes,\n",
-    "\n",
-    "y_1\n",
-    "\n",
-    "y_2"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from scipy import sparse\n",
-    "from scipy import linalg\n",
-    "\n",
-    "#Transformer functions\n",
-    "def multi_output_transform_x_y(X, Y):\n",
-    "    X_new = multi_output_transformer_x(X, Y.shape[1])\n",
-    "    y_new = multi_output_transform_y(Y)\n",
-    "    return X_new, y_new\n",
-    "\n",
-    "def multi_output_transformer_x(X, number_of_columns_Y):\n",
-    "    indicator_vecs = linalg.block_diag(*([np.ones((X.shape[0], 1))] * number_of_columns_Y))\n",
-    "    if sparse.issparse(X):\n",
-    "        X_new = sparse.vstack(np.tile(X, number_of_columns_Y))\n",
-    "        indicator_vecs = sparse.coo_matrix(indicator_vecs)\n",
-    "        X_new = sparse.hstack((X_new, indicator_vecs))\n",
-    "    else:\n",
-    "        X_new = np.tile(X, (number_of_columns_Y, 1))\n",
-    "        X_new = np.hstack((X_new, indicator_vecs))\n",
-    "    return X_new\n",
-    "\n",
-    "def multi_output_transform_y(Y):\n",
-    "    return Y.reshape(-1, order=\"F\")\n",
-    "    \n",
-    "def multi_output_inverse_transform_y(y, number_of_columns_y):\n",
-    "    return y.reshape((-1, number_of_columns_y), order=\"F\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## AutoML experiment set up"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "ws = Workspace.from_config()\n",
-    "\n",
-    "# choose a name for experiment\n",
-    "experiment_name = 'automl-local-multi-output'\n",
-    "# project folder\n",
-    "project_folder = './sample_projects/automl-local-multi-output'\n",
-    "\n",
-    "experiment=Experiment(ws, experiment_name)\n",
-    "\n",
-    "output = {}\n",
-    "output['SDK version'] = azureml.core.VERSION\n",
-    "output['Subscription ID'] = ws.subscription_id\n",
-    "output['Workspace'] = ws.name\n",
-    "output['Resource Group'] = ws.resource_group\n",
-    "output['Location'] = ws.location\n",
-    "output['Project Directory'] = project_folder\n",
-    "output['Experiment Name'] = experiment.name\n",
-    "pd.set_option('display.max_colwidth', -1)\n",
-    "pd.DataFrame(data=output, index=['']).T"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create a random dataset for the test purpose "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "rng = np.random.RandomState(1)\n",
-    "X_train = np.sort(200 * rng.rand(600, 1) - 100, axis=0)\n",
-    "Y_train = np.array([np.pi * np.sin(X_train).ravel(), np.pi * np.cos(X_train).ravel()]).T\n",
-    "Y_train += (0.5 - rng.rand(*Y_train.shape))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Perform X and Y transformation using transformer function"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "X_train_transformed, y_train_transformed = multi_output_transform_x_y(X_train, Y_train)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "automl_config = AutoMLConfig(task = 'regression',\n",
-    "                             debug_log='automl_errors_multi.log',\n",
-    "                             primary_metric='r2_score',\n",
-    "                             iterations=10,\n",
-    "                             n_cross_validations=2,\n",
-    "                             verbosity=logging.INFO,\n",
-    "                             X=X_train_transformed,\n",
-    "                             y=y_train_transformed,\n",
-    "                             path=project_folder)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Fit the transformed data "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "local_run = experiment.submit(automl_config, show_output=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Get the best fit model\n",
-    "best_run, fitted_model = local_run.get_output()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Generate random data set for predicting\n",
-    "X_predict = np.sort(200 * rng.rand(200, 1) - 100, axis=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Transform predict data\n",
-    "X_predict_transformed = multi_output_transformer_x(X_predict, Y_train.shape[1])\n",
-    "# Predict and inverse transform the prediction\n",
-    "y_predict = fitted_model.predict(X_predict_transformed)\n",
-    "Y_predict = multi_output_inverse_transform_y(y_predict, Y_train.shape[1])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "print(Y_predict)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

automl/12.auto-ml-retrieve-the-training-sdk-versions.ipynb

@@ -1,240 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
-    "\n",
-    "Licensed under the MIT License."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# AutoML 12: Retrieving Training SDK Versions"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import logging\n",
-    "import os\n",
-    "import random\n",
-    "\n",
-    "from matplotlib import pyplot as plt\n",
-    "from matplotlib.pyplot import imshow\n",
-    "import numpy as np\n",
-    "import pandas as pd\n",
-    "from sklearn import datasets\n",
-    "\n",
-    "import azureml.core\n",
-    "from azureml.core.experiment import Experiment\n",
-    "from azureml.core.workspace import Workspace\n",
-    "from azureml.train.automl import AutoMLConfig\n",
-    "from azureml.train.automl.run import AutoMLRun\n",
-    "from azureml.train.automl.utilities import get_sdk_dependencies"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Diagnostics\n",
-    "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 1. Retrieve the SDK versions in the current env"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "To retrieve the SDK versions in the current env, simple running get_sdk_dependencies()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "get_sdk_dependencies()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 2. Training Model Using AutoML"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "ws = Workspace.from_config()\n",
-    "\n",
-    "# choose a name for experiment\n",
-    "experiment_name = 'automl-local-classification'\n",
-    "# project folder\n",
-    "project_folder = './sample_projects/automl-local-classification'\n",
-    "\n",
-    "experiment=Experiment(ws, experiment_name)\n",
-    "\n",
-    "output = {}\n",
-    "output['SDK version'] = azureml.core.VERSION\n",
-    "output['Subscription ID'] = ws.subscription_id\n",
-    "output['Workspace'] = ws.name\n",
-    "output['Resource Group'] = ws.resource_group\n",
-    "output['Location'] = ws.location\n",
-    "output['Project Directory'] = project_folder\n",
-    "output['Experiment Name'] = experiment.name\n",
-    "pd.set_option('display.max_colwidth', -1)\n",
-    "pd.DataFrame(data=output, index=['']).T"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[10:,:]\n",
-    "y_digits = digits.target[10:]\n",
-    "\n",
-    "automl_config = AutoMLConfig(task = 'classification',\n",
-    "                             debug_log='automl_errors.log',\n",
-    "                             primary_metric='AUC_weighted',\n",
-    "                             iterations=3,\n",
-    "                             n_cross_validations=2,\n",
-    "                             verbosity=logging.INFO,\n",
-    "                             X = X_digits, \n",
-    "                             y = y_digits,\n",
-    "                             path=project_folder)\n",
-    "\n",
-    "local_run = experiment.submit(automl_config, show_output=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 3. Retrieve the SDK versions from RunHistory"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "To get the SDK versions from RunHistory, first the RunId need to be recorded. This can either be done by copy it from the output message or retieve if after each run."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "run_id = local_run.id\n",
-    "print(run_id)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Initialize a new AutoMLRunClass."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "experiment_name = 'automl-local-classification'\n",
-    "#run_id = 'AutoML_c0585b1f-a0e6-490b-84c7-3a099468b28e'\n",
-    "\n",
-    "experiment = Experiment(ws, experiment_name)\n",
-    "ml_run = AutoMLRun(experiment=experiment, run_id=run_id)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Get parent training SDK versions."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "ml_run.get_run_sdk_dependencies()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Get the traning SDK versions of a specific run."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "ml_run.get_run_sdk_dependencies(iteration=2)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.6",
-   "language": "python",
-   "name": "python36"
-  },
-  "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.6.6"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

automl/README.md

@@ -1,264 +0,0 @@
-# Table of Contents
-1. [Automated ML Introduction](#introduction)
-1. [Running samples in Azure Notebooks](#jupyter)
-1. [Running samples in a Local Conda environment](#localconda)
-1. [Automated ML SDK Sample Notebooks](#samples)
-1. [Documentation](#documentation)
-1. [Running using python command](#pythoncommand)
-1. [Troubleshooting](#troubleshooting)
-
-<a name="introduction"></a>
-# Automated ML introduction 
-Automated machine learning (automated ML) builds high quality machine learning models for you by automating model and hyperparameter selection. Bring a labelled dataset that you want to build a model for, automated ML will give you a high quality machine learning model that you can use for predictions.
-
-
-If you are new to Data Science, AutoML will help you get jumpstarted by simplifying machine learning model building. It abstracts you from needing to perform model selection, hyperparameter selection and in one step creates a high quality trained model for you to use.
-
-If you are an experienced data scientist, AutoML will help increase your productivity by intelligently performing the model and hyperparameter selection for your training and generates high quality models much quicker than manually specifying several combinations of the parameters and running training jobs. AutoML provides visibility and access to all the training jobs and the performance characteristics of the models to help you further tune the pipeline if you desire.
-
- <a name="jupyter"></a>
-## Running samples in Azure Notebooks - Jupyter based notebooks in the Azure cloud
-
-1. [![Azure Notebooks](https://notebooks.azure.com/launch.png)](https://aka.ms/aml-clone-azure-notebooks)
-[Import sample notebooks ](https://aka.ms/aml-clone-azure-notebooks) into Azure Notebooks if they are not already there.
-1.  Create a workspace and its configuration file (**config.json**) using [these instructions](https://aka.ms/aml-how-to-configure-environment).
-1. Select `+New` in the Azure Notebook toolbar to add your **config.json** file to the imported folder.
-    ![upload config file to notebook folder](../images/additems.png)
-1. Open the notebook.
-    
-    **Make sure the Azure Notebook kernal is set to `Python 3.6`** when you open a notebook. 
-    
-    ![set kernal to Python 3.6](../images/python36.png)
-
-<a name="localconda"></a>
-## Running samples in a Local Conda environment 
-
-To run these notebook on your own notebook server, use these installation instructions.
-
-The instructions below will install everything you need and then start a Jupyter notebook.  To start your Jupyter notebook manually, use:
-
-```
-conda activate azure_automl
-jupyter notebook
-```
-
-or on Mac:
-
-```
-source activate azure_automl
-jupyter notebook
-```
-
-
-### 1. Install mini-conda from [here](https://conda.io/miniconda.html), choose Python 3.7 or higher. 
-- **Note**: if you already have conda installed, you can keep using it but it should be version 4.4.10 or later (as shown by: conda -V).  If you have a previous version installed, you can update it using the command: conda update conda.
-There's no need to install mini-conda specifically.
-
-### 2. Downloading the sample notebooks
-- Download the sample notebooks from [GitHub](https://github.com/Azure/MachineLearningNotebooks) as zip and extract the contents to a local directory.  The AutoML sample notebooks are in the "automl" folder.
-
-### 3. Setup a new conda environment
-The **automl/automl_setup** script creates a new conda environment, installs the necessary packages, configures the widget and starts a jupyter notebook.
-It takes the conda environment name as an optional parameter.  The default conda environment name is azure_automl.  The exact command depends on the operating system.  It can take about 30 minutes to execute.
-## Windows
-Start a conda command windows, cd to the **automl** folder where the sample notebooks were extracted and then run: 
-```
-automl_setup
-```
-## Mac
-Install "Command line developer tools" if it is not already installed (you can use the command: `xcode-select --install`).
-
-Start a Terminal windows, cd to the **automl** folder where the sample notebooks were extracted and then run: 
-
-```
-bash automl_setup_mac.sh
-```
-
-## Linux
-cd to the **automl** folder where the sample notebooks were extracted and then run: 
-
-```
-bash automl_setup_linux.sh
-```
-
-### 4. Running configuration.ipynb
-- Before running any samples you next need to run the configuration notebook. Click on 00.configuration.ipynb notebook
-- Execute the cells in the notebook to Register Machine Learning Services Resource Provider and create a workspace. (*instructions in notebook*)
-
-### 5. Running Samples
-- Please make sure you use the Python [conda env:azure_automl] kernel when trying the sample Notebooks.
-- Follow the instructions in the individual notebooks to explore various features in AutoML
-
-<a name="samples"></a>
-# Automated ML SDK Sample Notebooks 
-- [00.configuration.ipynb](00.configuration.ipynb)
-    - Register Machine Learning Services Resource Provider
-    - Create new Azure ML Workspace
-    - Save Workspace configuration file
-
-- [01.auto-ml-classification.ipynb](01.auto-ml-classification.ipynb)
-    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
-    - Simple example of using Auto ML for classification 
-    - Uses local compute for training
-
-- [02.auto-ml-regression.ipynb](02.auto-ml-regression.ipynb)
-    - Dataset: scikit learn's [diabetes dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_diabetes.html)
-    - Simple example of using Auto ML for regression 
-    - Uses local compute for training
-
-- [03.auto-ml-remote-execution.ipynb](03.auto-ml-remote-execution.ipynb)
-    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
-    - Example of using Auto ML for classification using a remote linux DSVM for training
-    - Parallel execution of iterations
-    - Async tracking of progress
-    - Cancelling individual iterations or entire run
-    - Retrieving models for any iteration or logged metric
-    - Specify automl settings as kwargs
-
-- [03b.auto-ml-remote-batchai.ipynb](03b.auto-ml-remote-batchai.ipynb)
-    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
-    - Example of using automated ML for classification using a remote Batch AI compute for training
-    - Parallel execution of iterations
-    - Async tracking of progress
-    - Cancelling individual iterations or entire run
-    - Retrieving models for any iteration or logged metric
-    - Specify automl settings as kwargs
-
-- [04.auto-ml-remote-execution-text-data-blob-store.ipynb](04.auto-ml-remote-execution-text-data-blob-store.ipynb)
-    - Dataset: [Burning Man 2016 dataset](https://innovate.burningman.org/datasets-page/)
-    - handling text data with preprocess flag
-    - Reading data from a blob store for remote executions
-    - using pandas dataframes for reading data    
-
-- [05.auto-ml-missing-data-blacklist-early-termination.ipynb](05.auto-ml-missing-data-blacklist-early-termination.ipynb)
-    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
-    - Blacklist certain pipelines
-    - Specify a target metrics to indicate stopping criteria
-    - Handling Missing Data in the input
-
-- [06.auto-ml-sparse-data-custom-cv-split.ipynb](06.auto-ml-sparse-data-custom-cv-split.ipynb)
-    - Dataset: Scikit learn's [20newsgroup](http://scikit-learn.org/stable/datasets/twenty_newsgroups.html) 
-    - Handle sparse datasets
-    - Specify custom train and validation set
-
-- [07.auto-ml-exploring-previous-runs.ipynb](07.auto-ml-exploring-previous-runs)
-    - List all projects for the workspace
-    - List all AutoML Runs for a given project
-    - Get details for a AutoML Run. (Automl settings, run widget & all metrics)
-    - Downlaod fitted pipeline for any iteration
-
-- [08.auto-ml-remote-execution-with-text-file-on-DSVM](08.auto-ml-remote-execution-with-text-file-on-DSVM.ipynb)
-    - Dataset: scikit learn's [digit dataset](https://innovate.burningman.org/datasets-page/)
-    - Download the data and store it in the DSVM to improve performance.
-
-- [09.auto-ml-classification-with-deployment.ipynb](09.auto-ml-classification-with-deployment.ipynb)
-    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
-    - Simple example of using Auto ML for classification 
-    - Registering the model
-    - Creating Image and creating aci service
-    - Testing the aci service
-
-- [10.auto-ml-multi-output-example.ipynb](10.auto-ml-multi-output-example.ipynb)
-    - Dataset: scikit learn's random example using multi-output pipeline(http://scikit-learn.org/stable/auto_examples/ensemble/plot_random_forest_regression_multioutput.html#sphx-glr-auto-examples-ensemble-plot-random-forest-regression-multioutput-py)
-    - Simple example of using Auto ML for multi output regression
-    - Handle both the dense and sparse metrix
-
-- [11.auto-ml-sample-weight.ipynb](11.auto-ml-sample-weight.ipynb)
-    - How to specifying sample_weight
-    - The difference that it makes to test results
-
-- [12.auto-ml-retrieve-the-training-sdk-versions.ipynb](12.auto-ml-retrieve-the-training-sdk-versions.ipynb)
-    - How to get current and training env SDK versions
-
-- [13.auto-ml-dataprep.ipynb](13.auto-ml-dataprep.ipynb)
-    - Using DataPrep for reading data
-
-<a name="documentation"></a>
-# Documentation 
-## Table of Contents
-1. [Automated ML Settings ](#automlsettings)
-1. [Cross validation split options](#cvsplits)
-1. [Get Data Syntax](#getdata)
-1. [Data pre-processing and featurization](#preprocessing)
-
-<a name="automlsettings"></a>
-## Automated ML Settings 
-
-|Property|Description|Default|
-|-|-|-|
-|**primary_metric**|This is the metric that you want to optimize.<br><br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i><br><br> Regression supports the following primary metrics <br><i>spearman_correlation</i><br><i>normalized_root_mean_squared_error</i><br><i>r2_score</i><br><i>normalized_mean_absolute_error</i><br><i>normalized_root_mean_squared_log_error</i>| Classification: accuracy <br><br> Regression: spearman_correlation
-|**max_time_sec**|Time limit in seconds for each iteration|None|
-|**iterations**|Number of iterations. In each iteration trains the data with a specific pipeline.  To get the best result, use at least 100. |100|
-|**n_cross_validations**|Number of cross validation splits|None|
-|**validation_size**|Size of validation set as percentage of all training samples|None|
-|**concurrent_iterations**|Max number of iterations that would be executed in parallel|1|
-|**preprocess**|*True/False* <br>Setting this to *True* enables preprocessing <br>on the input to handle missing data, and perform some common feature extraction<br>*Note: If input data is Sparse you cannot use preprocess=True*|False|
-|**max_cores_per_iteration**| Indicates how many cores on the compute target would be used to train a single pipeline.<br> You can set it to *-1* to use all cores|1|
-|**exit_score**|*double* value indicating the target for *primary_metric*. <br> Once the target is surpassed the run terminates|None|
-|**blacklist_algos**|*Array* of *strings* indicating pipelines to ignore for Auto ML.<br><br> Allowed values for **Classification**<br><i>LogisticRegression</i><br><i>SGDClassifierWrapper</i><br><i>NBWrapper</i><br><i>BernoulliNB</i><br><i>SVCWrapper</i><br><i>LinearSVMWrapper</i><br><i>KNeighborsClassifier</i><br><i>DecisionTreeClassifier</i><br><i>RandomForestClassifier</i><br><i>ExtraTreesClassifier</i><br><i>gradient boosting</i><br><i>LightGBMClassifier</i><br><br>Allowed values for **Regression**<br><i>ElasticNet</i><br><i>GradientBoostingRegressor</i><br><i>DecisionTreeRegressor</i><br><i>KNeighborsRegressor</i><br><i>LassoLars</i><br><i>SGDRegressor</i><br><i>RandomForestRegressor</i><br><i>ExtraTreesRegressor</i>|None|
-
- <a name="cvsplits"></a>
-## Cross validation split options
-### K-Folds Cross Validation
-Use *n_cross_validations* setting to specify the number of cross validations. The training data set will be randomly split into *n_cross_validations* folds of equal size. During each cross validation round, one of the folds will be used for validation of the model trained on the remaining folds. This process repeats for *n_cross_validations* rounds until each fold is used once as validation set. Finally, the average scores accross all *n_cross_validations* rounds will be reported, and the corresponding model will be retrained on the whole training data set.
-
-### Monte Carlo Cross Validation (a.k.a. Repeated Random Sub-Sampling)
-Use *validation_size* to specify the percentage of the training data set that should be used for validation, and use *n_cross_validations* to specify the number of cross validations. During each cross validation round, a subset of size *validation_size* will be randomly selected for validation of the model trained on the remaining data. Finally, the average scores accross all *n_cross_validations* rounds will be reported, and the corresponding model will be retrained on the whole training data set.
-
-### Custom train and validation set
-You can specify seperate train and validation set either through the get_data() or directly to the fit method.
-
-<a name="getdata"></a>
-## get_data() syntax 
-The *get_data()* function can be used to return a dictionary with these values:
-
-|Key|Type|Dependency|Mutually Exclusive with|Description|
-|:-|:-|:-|:-|:-|
-|X|Pandas Dataframe or Numpy Array|y|data_train, label, columns|All features to train with|
-|y|Pandas Dataframe or Numpy Array|X|label|Label data to train with.  For classification, this should be an array of integers. |
-|X_valid|Pandas Dataframe or Numpy Array|X, y, y_valid|data_train, label|*Optional* All features to validate with.  If this is not specified, X is split between train and validate|
-|y_valid|Pandas Dataframe or Numpy Array|X, y, X_valid|data_train, label|*Optional* The label data to validate with.  If this is not specified, y is split between train and validate|
-|sample_weight|Pandas Dataframe or Numpy Array|y|data_train, label, columns|*Optional* A weight value for each label. Higher values indicate that the sample is more important.|
-|sample_weight_valid|Pandas Dataframe or Numpy Array|y_valid|data_train, label, columns|*Optional* A weight value for each validation label. Higher values indicate that the sample is more important.  If this is not specified, sample_weight is split between train and validate|
-|data_train|Pandas Dataframe|label|X, y, X_valid, y_valid|All data (features+label) to train with|
-|label|string|data_train|X, y, X_valid, y_valid|Which column in data_train represents the label|
-|columns|Array of strings|data_train||*Optional* Whitelist of columns to use for features|
-|cv_splits_indices|Array of integers|data_train||*Optional* List of indexes to split the data for cross validation|
-
-<a name="preprocessing"></a>
-## Data pre-processing and featurization 
-If you use `preprocess=True`, the following data preprocessing steps are performed automatically for you:
-
-1. Dropping high cardinality or no variance features
-    - Features with no useful information are dropped from training and validation sets. These include features with all values missing, same value across all rows or with extremely high cardinality (e.g., hashes, IDs or GUIDs).
-2. Missing value imputation
-    - For numerical features, missing values are imputed with average of values in the column.
-    - For categorical features, missing values are imputed with most frequent value.
-3. Generating additional features
-    - For DateTime features: Year, Month, Day, Day of week, Day of year, Quarter, Week of the year, Hour, Minute, Second.
-    - For Text features: Term frequency based on bi-grams and tri-grams, Count vectorizer.
-4. Transformations and encodings
-    - Numeric features with very few unique values are transformed into categorical features.
-
-<a name="pythoncommand"></a>
-# Running using python command 
-Jupyter notebook provides a File / Download as / Python (.py) option for saving the notebook as a Python file.
-You can then run this file using the python command.
-However, on Windows the file needs to be modified before it can be run.
-The following condition must be added to the main code in the file:
-
-    if __name__ == "__main__":
-
-The main code of the file must be indented so that it is under this condition.
-
-<a name="troubleshooting"></a>
-# Troubleshooting 
-## Iterations fail and the log contains "MemoryError"
-This can be caused by insufficient memory on the DSVM.  AutoML loads all training data into memory.  So, the available memory should be more than the training data size.
-If you are using a remote DSVM, memory is needed for each concurrent iteration.  The concurrent_iterations setting specifies the maximum concurrent iterations.  For example, if the training data size is 8Gb and concurrent_iterations is set to 10, the minimum memory required is at least 80Gb.
-To resolve this issue, allocate a DSVM with more memory or reduce the value specified for concurrent_iterations.
-
-## Iterations show as "Not Responding" in the RunDetails widget.
-This can be caused by too many concurrent iterations for a remote DSVM.  Each concurrent iteration usually takes 100% of a core when it is running.  Some iterations can use multiple cores.  So, the concurrent_iterations setting should always be less than the number of cores of the DSVM.
-To resolve this issue, try reducing the value specified for the concurrent_iterations setting.
-

automl/automl_env.yml

@@ -1,20 +0,0 @@
-name: azure_automl
-dependencies:
-  # The python interpreter version.
-  # Currently Azure ML only supports 3.5.2 and later.
-- python=3.6
-- nb_conda
-- matplotlib
-- numpy>=1.11.0,<1.16.0
-- scipy>=0.19.0,<0.20.0
-- scikit-learn>=0.18.0,<=0.19.1
-- pandas>=0.19.0,<0.23.0
-
-- pip:
-    # Required packages for AzureML execution, history, and data preparation.
-  - --extra-index-url https://pypi.python.org/simple
-  - azureml-sdk[automl]
-  - azureml-train-widgets
-  - azure-cli
-  - pandas_ml
-  

automl/automl_setup.cmd

@@ -1,41 +0,0 @@
-@echo off
-set conda_env_name=%1
-
-IF "%conda_env_name%"=="" SET conda_env_name="azure_automl"
-
-call conda activate %conda_env_name% 2>nul:
-
-if not errorlevel 1 (
-  call conda env update --file automl_env.yml -n %conda_env_name%
-  if errorlevel 1 goto ErrorExit
-) else (
-  call conda env create -f automl_env.yml -n %conda_env_name%
-)
-
-call conda activate %conda_env_name% 2>nul:
-if errorlevel 1 goto ErrorExit
-
-call pip install psutil
-
-call jupyter nbextension install --py azureml.train.widgets
-if errorlevel 1 goto ErrorExit
-
-call jupyter nbextension enable --py azureml.train.widgets
-if errorlevel 1 goto ErrorExit
-
-echo.
-echo.
-echo ***************************************
-echo * AutoML setup completed successfully *
-echo ***************************************
-echo.
-echo Starting jupyter notebook - please run notebook 00.configuration
-echo.
-jupyter notebook --log-level=50
-
-goto End
-
-:ErrorExit
-echo Install failed
-
-:End

automl/automl_setup_linux.sh

@@ -1,34 +0,0 @@
-#!/bin/bash
-
-CONDA_ENV_NAME=$1
-
-if [ "$CONDA_ENV_NAME" == "" ]
-then
-  CONDA_ENV_NAME="azure_automl"
-fi
-
-if source activate $CONDA_ENV_NAME 2> /dev/null
-then
-   conda env update -file automl_env.yml -n $CONDA_ENV_NAME
-else
-   conda env create -f automl_env.yml -n $CONDA_ENV_NAME &&
-   source activate $CONDA_ENV_NAME &&
-   jupyter nbextension install --py azureml.train.widgets --user &&
-   jupyter nbextension enable --py azureml.train.widgets --user &&
-   echo "" &&
-   echo "" &&
-   echo "***************************************" &&
-   echo "* AutoML setup completed successfully *" &&
-   echo "***************************************" &&
-   echo "" &&
-   echo "Starting jupyter notebook - please run notebook 00.configuration" &&
-   echo "" &&
-   jupyter notebook --log-level=50
-fi
-
-if [ $? -gt 0 ]
-then
-   echo "Installation failed"
-fi
-
-

automl/automl_setup_mac.sh

@@ -1,35 +0,0 @@
-#!/bin/bash
-
-CONDA_ENV_NAME=$1
-
-if [ "$CONDA_ENV_NAME" == "" ]
-then
-  CONDA_ENV_NAME="azure_automl"
-fi
-
-if source activate $CONDA_ENV_NAME 2> /dev/null
-then
-   conda env update -file automl_env.yml -n $CONDA_ENV_NAME
-else
-   conda env create -f automl_env.yml -n $CONDA_ENV_NAME &&
-   source activate $CONDA_ENV_NAME &&
-   conda install lightgbm -c conda-forge -y &&
-   jupyter nbextension install --py azureml.train.widgets --user &&
-   jupyter nbextension enable --py azureml.train.widgets --user &&
-   echo "" &&
-   echo "" &&
-   echo "***************************************" &&
-   echo "* AutoML setup completed successfully *" &&
-   echo "***************************************" &&
-   echo "" &&
-   echo "Starting jupyter notebook - please run notebook 00.configuration" &&
-   echo "" &&
-   jupyter notebook --log-level=50
-fi
-
-if [ $? -gt 0 ]
-then
-   echo "Installation failed"
-fi
-
-

configuration.ipynb

@@ -0,0 +1,376 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+        "\n",
+        "Licensed under the MIT License."
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "# Configuration\n",
+        "\n",
+        "_**Setting up your Azure Machine Learning services workspace and configuring your notebook library**_\n",
+        "\n",
+        "---\n",
+        "---\n",
+        "\n",
+        "## Table of Contents\n",
+        "\n",
+        "1. [Introduction](#Introduction)\n",
+        "    1. What is an Azure Machine Learning workspace\n",
+        "1. [Setup](#Setup)\n",
+        "    1. Azure subscription\n",
+        "    1. Azure ML SDK and other library installation\n",
+        "    1. Azure Container Instance registration\n",
+        "1. [Configure your Azure ML Workspace](#Configure%20your%20Azure%20ML%20workspace)\n",
+        "    1. Workspace parameters\n",
+        "    1. Access your workspace\n",
+        "    1. Create a new workspace\n",
+        "    1. Create compute resources\n",
+        "1. [Next steps](#Next%20steps)\n",
+        "\n",
+        "---\n",
+        "\n",
+        "## Introduction\n",
+        "\n",
+        "This notebook configures your library of notebooks to connect to an Azure Machine Learning (ML) workspace.  In this case, a library contains all of the notebooks in the current folder and any nested folders.  You can configure this notebook library to use an existing workspace or create a new workspace.\n",
+        "\n",
+        "Typically you will need to run this notebook only once per notebook library as all other notebooks will use connection information that is written here.  If you want to redirect your notebook library to work with a different workspace, then you should re-run this notebook.\n",
+        "\n",
+        "In this notebook you will\n",
+        "* Learn about getting an Azure subscription\n",
+        "* Specify your workspace parameters\n",
+        "* Access or create your workspace\n",
+        "* Add a default compute cluster for your workspace\n",
+        "\n",
+        "### What is an Azure Machine Learning workspace\n",
+        "\n",
+        "An Azure ML Workspace is an Azure resource that organizes and coordinates the actions of many other Azure resources to assist in executing and sharing machine learning workflows.  In particular, an Azure ML Workspace coordinates storage, databases, and compute resources providing added functionality for machine learning experimentation, deployment, inferencing, and the monitoring of deployed models."
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Setup\n",
+        "\n",
+        "This section describes activities required before you can access any Azure ML services functionality."
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "### 1. Azure Subscription\n",
+        "\n",
+        "In order to create an Azure ML Workspace, first you need access to an Azure subscription.  An Azure subscription allows you to manage storage, compute, and other assets in the Azure cloud.  You can [create a new subscription](https://azure.microsoft.com/en-us/free/) or access existing subscription information from the [Azure portal](https://portal.azure.com).  Later in this notebook you will need information such as your subscription ID in order to create and access AML workspaces.\n",
+        "\n",
+        "### 2. Azure ML SDK and other library installation\n",
+        "\n",
+        "If you are running in your own environment, follow [SDK installation instructions](https://docs.microsoft.com/azure/machine-learning/service/how-to-configure-environment).  If you are running in Azure Notebooks or another Microsoft managed environment, the SDK is already installed.\n",
+        "\n",
+        "Also install following libraries to your environment. Many of the example notebooks depend on them\n",
+        "\n",
+        "```\n",
+        "(myenv) $ conda install -y matplotlib tqdm scikit-learn\n",
+        "```\n",
+        "\n",
+        "Once installation is complete, the following cell checks the Azure ML SDK version:"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "tags": [
+          "install"
+        ]
+      },
+      "outputs": [],
+      "source": [
+        "import azureml.core\n",
+        "\n",
+        "print(\"This notebook was created using version 1.0.2 of the Azure ML SDK\")\n",
+        "print(\"You are currently using version\", azureml.core.VERSION, \"of the Azure ML SDK\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "If you are using an older version of the SDK then this notebook was created using, you should upgrade your SDK.\n",
+        "\n",
+        "### 3. Azure Container Instance registration\n",
+        "Azure Machine Learning uses of [Azure Container Instance (ACI)](https://azure.microsoft.com/services/container-instances) to deploy dev/test web services. An Azure subscription needs to be registered to use ACI.  If you or the subscription owner have not yet registered ACI on your subscription, you will need to use the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) and execute the following commands.  Note that if you ran through the AML [quickstart](https://docs.microsoft.com/en-us/azure/machine-learning/service/quickstart-get-started) you have already registered ACI. \n",
+        "\n",
+        "```shell\n",
+        "# check to see if ACI is already registered\n",
+        "(myenv) $ az provider show -n Microsoft.ContainerInstance -o table\n",
+        "\n",
+        "# if ACI is not registered, run this command.\n",
+        "# note you need to be the subscription owner in order to execute this command successfully.\n",
+        "(myenv) $ az provider register -n Microsoft.ContainerInstance\n",
+        "```\n",
+        "\n",
+        "---"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Configure your Azure ML workspace\n",
+        "\n",
+        "### Workspace parameters\n",
+        "\n",
+        "To use an AML Workspace, you will need to import the Azure ML SDK and supply the following information:\n",
+        "* Your subscription id\n",
+        "* A resource group name\n",
+        "* (optional) The region that will host your workspace\n",
+        "* A name for your workspace\n",
+        "\n",
+        "You can get your subscription ID from the [Azure portal](https://portal.azure.com).\n",
+        "\n",
+        "You will also need access to a [_resource group_](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview#resource-groups), which organizes Azure resources and provides a default region for the resources in a group.  You can see what resource groups to which you have access, or create a new one in the [Azure portal](https://portal.azure.com).  If you don't have a resource group, the create workspace command will create one for you using the name you provide.\n",
+        "\n",
+        "The region to host your workspace will be used if you are creating a new workspace.  You do not need to specify this if you are using an existing workspace. You can find the list of supported regions [here](https://azure.microsoft.com/en-us/global-infrastructure/services/?products=machine-learning-service).  You should pick a region that is close to your location or that contains your data.\n",
+        "\n",
+        "The name for your workspace is unique within the subscription and should be descriptive enough to discern among other AML Workspaces.  The subscription may be used only by you, or it may be used by your department or your entire enterprise, so choose a name that makes sense for your situation.\n",
+        "\n",
+        "The following cell allows you to specify your workspace parameters.  This cell uses the python method `os.getenv` to read values from environment variables which is useful for automation.  If no environment variable exists, the parameters will be set to the specified default values.  \n",
+        "\n",
+        "If you ran the Azure Machine Learning [quickstart](https://docs.microsoft.com/en-us/azure/machine-learning/service/quickstart-get-started) in Azure Notebooks, you already have a configured workspace!  You can go to your Azure Machine Learning Getting Started library, view *config.json* file, and copy-paste the values for subscription ID, resource group and workspace name below.\n",
+        "\n",
+        "Replace the default values in the cell below with your workspace parameters"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import os\n",
+        "\n",
+        "subscription_id = os.getenv(\"SUBSCRIPTION_ID\", default=\"<my-subscription-id>\")\n",
+        "resource_group = os.getenv(\"RESOURCE_GROUP\", default=\"<my-resource-group>\")\n",
+        "workspace_name = os.getenv(\"WORKSPACE_NAME\", default=\"<my-workspace-name>\")\n",
+        "workspace_region = os.getenv(\"WORKSPACE_REGION\", default=\"eastus2\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "### Access your workspace\n",
+        "\n",
+        "The following cell uses the Azure ML SDK to attempt to load the workspace specified by your parameters.  If this cell succeeds, your notebook library will be configured to access the workspace from all notebooks using the `Workspace.from_config()` method.  The cell can fail if the specified workspace doesn't exist or you don't have permissions to access it. "
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "from azureml.core import Workspace\n",
+        "\n",
+        "try:\n",
+        "    ws = Workspace(subscription_id = subscription_id, resource_group = resource_group, workspace_name = workspace_name)\n",
+        "    # write the details of the workspace to a configuration file to the notebook library\n",
+        "    ws.write_config()\n",
+        "    print(\"Workspace configuration succeeded. Skip the workspace creation steps below\")\n",
+        "except:\n",
+        "    print(\"Workspace not accessible. Change your parameters or create a new workspace below\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "### Create a new workspace\n",
+        "\n",
+        "If you don't have an existing workspace and are the owner of the subscription or resource group, you can create a new workspace.  If you don't have a resource group, the create workspace command will create one for you using the name you provide.\n",
+        "\n",
+        "**Note**: As with other Azure services, there are limits on certain resources (for example AmlCompute quota) associated with the Azure ML service. Please read [this article](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-manage-quotas) on the default limits and how to request more quota.\n",
+        "\n",
+        "This cell will create an Azure ML workspace for you in a subscription provided you have the correct permissions.\n",
+        "\n",
+        "This will fail if:\n",
+        "* You do not have permission to create a workspace in the resource group\n",
+        "* You do not have permission to create a resource group if it's non-existing.\n",
+        "* You are not a subscription owner or contributor and no Azure ML workspaces have ever been created in this subscription\n",
+        "\n",
+        "If workspace creation fails, please work with your IT admin to provide you with the appropriate permissions or to provision the required resources."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "tags": [
+          "create workspace"
+        ]
+      },
+      "outputs": [],
+      "source": [
+        "from azureml.core import Workspace\n",
+        "\n",
+        "# Create the workspace using the specified parameters\n",
+        "ws = Workspace.create(name = workspace_name,\n",
+        "                      subscription_id = subscription_id,\n",
+        "                      resource_group = resource_group, \n",
+        "                      location = workspace_region,\n",
+        "                      create_resource_group = True,\n",
+        "                      exist_ok = True)\n",
+        "ws.get_details()\n",
+        "\n",
+        "# write the details of the workspace to a configuration file to the notebook library\n",
+        "ws.write_config()"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "### Create compute resources for your training experiments\n",
+        "\n",
+        "Many of the sample notebooks use Azure ML managed compute (AmlCompute) to train models using a dynamically scalable pool of compute. In this section you will create default compute clusters for use by the other notebooks and any other operations you choose.\n",
+        "\n",
+        "To create a cluster, you need to specify a compute configuration that specifies the type of machine to be used and the scalability behaviors.  Then you choose a name for the cluster that is unique within the workspace that can be used to address the cluster later.\n",
+        "\n",
+        "The cluster parameters are:\n",
+        "* vm_size - this describes the virtual machine type and size used in the cluster.  All machines in the cluster are the same type.  You can get the list of vm sizes available in your region by using the CLI command\n",
+        "\n",
+        "```shell\n",
+        "az vm list-skus -o tsv\n",
+        "```\n",
+        "* min_nodes - this sets the minimum size of the cluster.  If you set the minimum to 0 the cluster will shut down all nodes while note in use.  Setting this number to a value higher than 0 will allow for faster start-up times, but you will also be billed when the cluster is not in use.\n",
+        "* max_nodes - this sets the maximum size of the cluster.  Setting this to a larger number allows for more concurrency and a greater distributed processing of scale-out jobs.\n",
+        "\n",
+        "\n",
+        "To create a **CPU** cluster now, run the cell below. The autoscale settings mean that the cluster will scale down to 0 nodes when inactive and up to 4 nodes when busy."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "from azureml.core.compute import ComputeTarget, AmlCompute\n",
+        "from azureml.core.compute_target import ComputeTargetException\n",
+        "\n",
+        "# Choose a name for your CPU cluster\n",
+        "cpu_cluster_name = \"cpucluster\"\n",
+        "\n",
+        "# Verify that cluster does not exist already\n",
+        "try:\n",
+        "    cpu_cluster = ComputeTarget(workspace=ws, name=cpu_cluster_name)\n",
+        "    print(\"Found existing cpucluster\")\n",
+        "except ComputeTargetException:\n",
+        "    print(\"Creating new cpucluster\")\n",
+        "    \n",
+        "    # Specify the configuration for the new cluster\n",
+        "    compute_config = AmlCompute.provisioning_configuration(vm_size=\"STANDARD_D2_V2\",\n",
+        "                                                           min_nodes=0,\n",
+        "                                                           max_nodes=4)\n",
+        "\n",
+        "    # Create the cluster with the specified name and configuration\n",
+        "    cpu_cluster = ComputeTarget.create(ws, cpu_cluster_name, compute_config)\n",
+        "    \n",
+        "    # Wait for the cluster to complete, show the output log\n",
+        "    cpu_cluster.wait_for_completion(show_output=True)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "To create a **GPU** cluster, run the cell below. Note that your subscription must have sufficient quota for GPU VMs or the command will fail. To increase quota, see [these instructions](https://docs.microsoft.com/en-us/azure/azure-supportability/resource-manager-core-quotas-request). "
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "from azureml.core.compute import ComputeTarget, AmlCompute\n",
+        "from azureml.core.compute_target import ComputeTargetException\n",
+        "\n",
+        "# Choose a name for your GPU cluster\n",
+        "gpu_cluster_name = \"gpucluster\"\n",
+        "\n",
+        "# Verify that cluster does not exist already\n",
+        "try:\n",
+        "    gpu_cluster = ComputeTarget(workspace=ws, name=gpu_cluster_name)\n",
+        "    print(\"Found existing gpu cluster\")\n",
+        "except ComputeTargetException:\n",
+        "    print(\"Creating new gpucluster\")\n",
+        "    \n",
+        "    # Specify the configuration for the new cluster\n",
+        "    compute_config = AmlCompute.provisioning_configuration(vm_size=\"STANDARD_NC6\",\n",
+        "                                                           min_nodes=0,\n",
+        "                                                           max_nodes=4)\n",
+        "    # Create the cluster with the specified name and configuration\n",
+        "    gpu_cluster = ComputeTarget.create(ws, gpu_cluster_name, compute_config)\n",
+        "\n",
+        "    # Wait for the cluster to complete, show the output log\n",
+        "    gpu_cluster.wait_for_completion(show_output=True)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "---\n",
+        "\n",
+        "## Next steps\n",
+        "\n",
+        "In this notebook you configured this notebook library to connect easily to an Azure ML workspace.  You can copy this notebook to your own libraries to connect them to you workspace, or use it to bootstrap new workspaces completely.\n",
+        "\n",
+        "If you came here from another notebook, you can return there and complete that exercise, or you can try out the [Tutorials](./tutorials) or jump into \"how-to\" notebooks and start creating and deploying models.  A good place to start is the [train in notebook](./how-to-use-azureml/training/train-in-notebook) example that walks through a simplified but complete end to end machine learning process."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": []
+    }
+  ],
+  "metadata": {
+    "authors": [
+      {
+        "name": "roastala"
+      }
+    ],
+    "kernelspec": {
+      "display_name": "Python 3.6",
+      "language": "python",
+      "name": "python36"
+    },
+    "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.6.7"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 2
+}

databricks/01.Installation_and_Configuration.ipynb

@@ -1 +0,0 @@
-{"cells":[{"cell_type":"markdown","source":["Azure ML & Azure Databricks notebooks by Parashar Shah.\n\nCopyright (c) Microsoft Corporation. All rights reserved.\n\nLicensed under the MIT License."],"metadata":{}},{"cell_type":"markdown","source":["Please ensure you have run this notebook before proceeding."],"metadata":{}},{"cell_type":"markdown","source":["Now we support installing AML SDK as library from GUI. When attaching a library follow this https://docs.databricks.com/user-guide/libraries.html and add the below string as your PyPi package (during private preview). You can select the option to attach the library to all clusters or just one cluster.\n\nProvide this full string to install the SDK:\n\nazureml-sdk[databricks]"],"metadata":{}},{"cell_type":"code","source":["import azureml.core\n\n# Check core SDK version number - based on build number of preview/master.\nprint(\"SDK version:\", azureml.core.VERSION)"],"metadata":{},"outputs":[],"execution_count":4},{"cell_type":"code","source":["subscription_id = \"<your-subscription-id>\"\nresource_group = \"<your-existing-resource-group>\"\nworkspace_name = \"<a-new-or-existing-workspace; it is unrelated to Databricks workspace>\"\nworkspace_region = \"<your-resource group-region>\""],"metadata":{},"outputs":[],"execution_count":5},{"cell_type":"code","source":["# import the Workspace class and check the azureml SDK version\n# exist_ok checks if workspace exists or not.\n\nfrom azureml.core import Workspace\n\nws = Workspace.create(name = workspace_name,\n                      subscription_id = subscription_id,\n                      resource_group = resource_group, \n                      location = workspace_region,\n                      exist_ok=True)\n\nws.get_details()"],"metadata":{},"outputs":[],"execution_count":6},{"cell_type":"code","source":["ws = Workspace(workspace_name = workspace_name,\n               subscription_id = subscription_id,\n               resource_group = resource_group)\n\n# persist the subscription id, resource group name, and workspace name in aml_config/config.json.\nws.write_config()"],"metadata":{},"outputs":[],"execution_count":7},{"cell_type":"code","source":["%sh\ncat /databricks/driver/aml_config/config.json"],"metadata":{},"outputs":[],"execution_count":8},{"cell_type":"code","source":["# import the Workspace class and check the azureml SDK version\nfrom azureml.core import Workspace\n\nws = Workspace.from_config()\nprint('Workspace name: ' + ws.name, \n      'Azure region: ' + ws.location, \n      'Subscription id: ' + ws.subscription_id, \n      'Resource group: ' + ws.resource_group, sep = '\\n')"],"metadata":{},"outputs":[],"execution_count":9},{"cell_type":"code","source":["dbutils.notebook.exit(\"success\")"],"metadata":{},"outputs":[],"execution_count":10},{"cell_type":"code","source":[""],"metadata":{},"outputs":[],"execution_count":11}],"metadata":{"name":"01.Installation_and_Configuration","notebookId":3874566296719377},"nbformat":4,"nbformat_minor":0}

databricks/02.Ingest_data.ipynb

@@ -1 +0,0 @@
-{"cells":[{"cell_type":"markdown","source":["Azure ML & Azure Databricks notebooks by Parashar Shah.\n\nCopyright (c) Microsoft Corporation. All rights reserved.\n\nLicensed under the MIT License."],"metadata":{}},{"cell_type":"markdown","source":["Please ensure you have run all previous notebooks in sequence before running this."],"metadata":{}},{"cell_type":"markdown","source":["#Data Ingestion"],"metadata":{}},{"cell_type":"code","source":["import os\nimport urllib"],"metadata":{},"outputs":[],"execution_count":4},{"cell_type":"code","source":["# Download AdultCensusIncome.csv from Azure CDN. This file has 32,561 rows.\nbasedataurl = \"https://amldockerdatasets.azureedge.net\"\ndatafile = \"AdultCensusIncome.csv\"\ndatafile_dbfs = os.path.join(\"/dbfs\", datafile)\n\nif os.path.isfile(datafile_dbfs):\n    print(\"found {} at {}\".format(datafile, datafile_dbfs))\nelse:\n    print(\"downloading {} to {}\".format(datafile, datafile_dbfs))\n    urllib.request.urlretrieve(os.path.join(basedataurl, datafile), datafile_dbfs)"],"metadata":{},"outputs":[],"execution_count":5},{"cell_type":"code","source":["# Create a Spark dataframe out of the csv file.\ndata_all = sqlContext.read.format('csv').options(header='true', inferSchema='true', ignoreLeadingWhiteSpace='true', ignoreTrailingWhiteSpace='true').load(datafile)\nprint(\"({}, {})\".format(data_all.count(), len(data_all.columns)))\ndata_all.printSchema()"],"metadata":{},"outputs":[],"execution_count":6},{"cell_type":"code","source":["#renaming columns\ncolumns_new = [col.replace(\"-\", \"_\") for col in data_all.columns]\ndata_all = data_all.toDF(*columns_new)\ndata_all.printSchema()"],"metadata":{},"outputs":[],"execution_count":7},{"cell_type":"code","source":["display(data_all.limit(5))"],"metadata":{},"outputs":[],"execution_count":8},{"cell_type":"markdown","source":["#Data Preparation"],"metadata":{}},{"cell_type":"code","source":["# Choose feature columns and the label column.\nlabel = \"income\"\nxvals_all = set(data_all.columns) - {label}\n\n#dbutils.widgets.remove(\"xvars_multiselect\")\ndbutils.widgets.removeAll()\n\ndbutils.widgets.multiselect('xvars_multiselect', 'hours_per_week', xvals_all)\nxvars_multiselect = dbutils.widgets.get(\"xvars_multiselect\")\nxvars = xvars_multiselect.split(\",\")\n\nprint(\"label = {}\".format(label))\nprint(\"features = {}\".format(xvars))\n\ndata = data_all.select([*xvars, label])\n\n# Split data into train and test.\ntrain, test = data.randomSplit([0.75, 0.25], seed=123)\n\nprint(\"train ({}, {})\".format(train.count(), len(train.columns)))\nprint(\"test ({}, {})\".format(test.count(), len(test.columns)))"],"metadata":{},"outputs":[],"execution_count":10},{"cell_type":"markdown","source":["#Data Persistence"],"metadata":{}},{"cell_type":"code","source":["# Write the train and test data sets to intermediate storage\ntrain_data_path = \"AdultCensusIncomeTrain\"\ntest_data_path = \"AdultCensusIncomeTest\"\n\ntrain_data_path_dbfs = os.path.join(\"/dbfs\", \"AdultCensusIncomeTrain\")\ntest_data_path_dbfs = os.path.join(\"/dbfs\", \"AdultCensusIncomeTest\")\n\ntrain.write.mode('overwrite').parquet(train_data_path)\ntest.write.mode('overwrite').parquet(test_data_path)\nprint(\"train and test datasets saved to {} and {}\".format(train_data_path_dbfs, test_data_path_dbfs))"],"metadata":{},"outputs":[],"execution_count":12},{"cell_type":"code","source":["dbutils.notebook.exit(\"success\")"],"metadata":{},"outputs":[],"execution_count":13},{"cell_type":"code","source":[""],"metadata":{},"outputs":[],"execution_count":14}],"metadata":{"name":"02.Ingest_data","notebookId":3874566296719393},"nbformat":4,"nbformat_minor":0}

databricks/05.Deploy_to_AKS_existingImage.ipynb

@@ -1 +0,0 @@
-{"cells":[{"cell_type":"markdown","source":["Azure ML & Azure Databricks notebooks by Parashar Shah.\n\nCopyright (c) Microsoft Corporation. All rights reserved.\n\nLicensed under the MIT License."],"metadata":{}},{"cell_type":"markdown","source":["Please ensure you have run all previous notebooks in sequence before running this. This notebook uses image from ACI notebook for deploying to AKS."],"metadata":{}},{"cell_type":"code","source":["from azureml.core import Workspace\nimport azureml.core\n\n# Check core SDK version number\nprint(\"SDK version:\", azureml.core.VERSION)\n\n#'''\nws = Workspace.from_config()\nprint('Workspace name: ' + ws.name, \n      'Azure region: ' + ws.location, \n      'Subscription id: ' + ws.subscription_id, \n      'Resource group: ' + ws.resource_group, sep = '\\n')\n#'''"],"metadata":{},"outputs":[],"execution_count":3},{"cell_type":"code","source":["# List images by ws\n\nfrom azureml.core.image import ContainerImage\nfor i in ContainerImage.list(workspace = ws):\n    print('{}(v.{} [{}]) stored at {} with build log {}'.format(i.name, i.version, i.creation_state, i.image_location, i.image_build_log_uri))"],"metadata":{},"outputs":[],"execution_count":4},{"cell_type":"code","source":["from azureml.core.image import Image\nmyimage = Image(workspace=ws, id=\"aciws:25\")"],"metadata":{},"outputs":[],"execution_count":5},{"cell_type":"code","source":["#create AKS compute\n#it may take 20-25 minutes to create a new cluster\n\nfrom azureml.core.compute import AksCompute, ComputeTarget\n\n# Use the default configuration (can also provide parameters to customize)\nprov_config = AksCompute.provisioning_configuration()\n\naks_name = 'ps-aks-clus2' \n\n# Create the cluster\naks_target = ComputeTarget.create(workspace = ws, \n                                  name = aks_name, \n                                  provisioning_configuration = prov_config)\n\naks_target.wait_for_completion(show_output = True)\n\nprint(aks_target.provisioning_state)\nprint(aks_target.provisioning_errors)"],"metadata":{},"outputs":[],"execution_count":6},{"cell_type":"code","source":["from azureml.core.webservice import Webservice\nhelp( Webservice.deploy_from_image)"],"metadata":{},"outputs":[],"execution_count":7},{"cell_type":"code","source":["from azureml.core.webservice import Webservice, AksWebservice\nfrom azureml.core.image import ContainerImage\n\n#Set the web service configuration (using default here)\naks_config = AksWebservice.deploy_configuration()\n\n#unique service name\nservice_name ='ps-aks-service'\n\n# Webservice creation using single command, there is a variant to use image directly as well.\naks_service = Webservice.deploy_from_image(\n  workspace=ws, \n  name=service_name,\n  deployment_config = aks_config,\n  image = myimage,\n  deployment_target = aks_target\n    )\n\naks_service.wait_for_deployment(show_output=True)"],"metadata":{},"outputs":[],"execution_count":8},{"cell_type":"code","source":["#for using the Web HTTP API \nprint(aks_service.scoring_uri)\nprint(aks_service.get_keys())"],"metadata":{},"outputs":[],"execution_count":9},{"cell_type":"code","source":["import json\n\n#get the some sample data\ntest_data_path = \"AdultCensusIncomeTest\"\ntest = spark.read.parquet(test_data_path).limit(5)\n\ntest_json = json.dumps(test.toJSON().collect())\n\nprint(test_json)"],"metadata":{},"outputs":[],"execution_count":10},{"cell_type":"code","source":["#using data defined above predict if income is >50K (1) or <=50K (0)\naks_service.run(input_data=test_json)"],"metadata":{},"outputs":[],"execution_count":11},{"cell_type":"code","source":["#comment to not delete the web service\naks_service.delete()\n#image.delete()\n#model.delete()\n#aks_target.delete()"],"metadata":{},"outputs":[],"execution_count":12},{"cell_type":"code","source":[""],"metadata":{},"outputs":[],"execution_count":13}],"metadata":{"name":"04.DeploytoACI","notebookId":3874566296719318},"nbformat":4,"nbformat_minor":0}

databricks/readme.md

@@ -1,26 +0,0 @@
-# Azure Databricks - Azure ML SDK Sample Notebooks
-
-**NOTE**: With the latest version of our AML SDK, there are some API changes due to which previous version of notebooks will not work.
-Kindly use this v4 notebooks (updated Sep 18)– if you had installed the AML SDK in your Databricks cluster please update to latest SDK version by installing azureml-sdk[databricks] as a library from GUI. 
-
-**NOTE**: Please create your Azure Databricks cluster as v4.x (high concurrency preferred) with **Python 3** (dropdown). We are extending it to more runtimes asap.
-
-**NOTE**: Some packages like psutil upgrade libs that can cause a conflict, please install such packages by freezing lib version. Eg. "pstuil **cryptography==1.5 pyopenssl==16.0.0 ipython=2.2.0**" to avoid install error. This issue is related to Databricks and not related to AML SDK.
-
-**NOTE**: You should at least have contributor access to your Azure subcription to run some of the notebooks.
-
-The iPython Notebooks have to be run sequentially after making changes based on your subscription. The corresponding DBC archive contains all the notebooks and can be imported into your Databricks workspace. You can the run notebooks after importing .dbc instead of downloading individually.  
-
-This set of notebooks are related to Income prediction experiment based on this [dataset](https://archive.ics.uci.edu/ml/datasets/adult) and demonstrate how to data prep, train and operationalize a Spark ML model with Azure ML Python SDK from within Azure Databricks. For details on SDK concepts, please refer to [Private preview notebooks](https://github.com/Azure/ViennaDocs/tree/master/PrivatePreview/notebooks)
-
-(Recommended) [Azure Databricks AML SDK notebooks](Databricks_AMLSDK_github.dbc) A single DBC package to import all notebooks in your Databricks workspace.
-
-01. [Installation and Configuration](01.Installation_and_Configuration.ipynb): Install the Azure ML Python SDK and Initialize an Azure ML Workspace and save the Workspace configuration file.
-02. [Ingest data](02.Ingest_data.ipynb): Download the Adult Census Income dataset and split it into train and test sets.
-03. [Build model](03a.Build_model.ipynb): Train a binary classification model in Azure Databricks with a Spark ML Pipeline.
-04. [Build model with Run History](03b.Build_model_runHistory.ipynb): Train model and also capture run history (tracking) with Azure ML Python SDK.
-05. [Deploy to ACI](04.Deploy_to_ACI.ipynb): Deploy model to Azure Container Instance (ACI) with Azure ML Python SDK.
-06. [Deploy to AKS](04.Deploy_to_AKS_existingImage.ipynb): Deploy model to Azure Kubernetis Service (AKS) with Azure ML Python SDK from an existing Image with model, conda and score file.
-
-Copyright (c) Microsoft Corporation. All rights reserved. 
-All notebooks in this folder are licensed under the MIT License. 

how-to-use-azureml/README.md

@@ -0,0 +1,15 @@
+## Examples to get started with Azure Machine Learning service
+
+Learn how to use Azure Machine Learning services for experimentation and model management.
+
+As a pre-requisite, run the [configuration Notebook](../configuration.ipynb) notebook first to set up your Azure ML Workspace. Then, run the notebooks in following recommended order.
+
+ * [train-within-notebook](./training/train-within-notebook): Train a model hile tracking run history, and learn how to deploy the model as web service to Azure Container Instance.
+ * [train-on-local](./training/train-on-local): Learn how to submit a run and use Azure ML managed run configuration.
+* [train-on-remote-vm](./training/train-on-remote-vm): Use Data Science Virtual Machine as a target for remote runs.
+* [logging-api](./training/logging-api): Learn about the details of logging metrics to run history.
+* [register-model-create-image-deploy-service](./deployment/register-model-create-image-deploy-service): Learn about the details of model management.
+* [production-deploy-to-aks](./deployment/production-deploy-to-aks) Deploy a model to production at scale on Azure Kubernetes Service.
+* [enable-data-collection-for-models-in-aks](./deployment/enable-data-collection-for-models-in-aks) Learn about data collection APIs for deployed model.
+* [enable-app-insights-in-production-service](./deployment/enable-app-insights-in-production-service) Learn how to use App Insights with production web service.
+ 

how-to-use-azureml/automated-machine-learning/README.md

@@ -0,0 +1,356 @@
+# Table of Contents
+1. [Automated ML Introduction](#introduction)
+1. [Running samples in Azure Notebooks](#jupyter)
+1. [Running samples in Azure Databricks](#databricks)
+1. [Running samples in a Local Conda environment](#localconda)
+1. [Automated ML SDK Sample Notebooks](#samples)
+1. [Documentation](#documentation)
+1. [Running using python command](#pythoncommand)
+1. [Troubleshooting](#troubleshooting)
+
+<a name="introduction"></a>
+# Automated ML introduction
+Automated machine learning (automated ML) builds high quality machine learning models for you by automating model and hyperparameter selection. Bring a labelled dataset that you want to build a model for, automated ML will give you a high quality machine learning model that you can use for predictions.
+
+
+If you are new to Data Science, AutoML will help you get jumpstarted by simplifying machine learning model building. It abstracts you from needing to perform model selection, hyperparameter selection and in one step creates a high quality trained model for you to use.
+
+If you are an experienced data scientist, AutoML will help increase your productivity by intelligently performing the model and hyperparameter selection for your training and generates high quality models much quicker than manually specifying several combinations of the parameters and running training jobs. AutoML provides visibility and access to all the training jobs and the performance characteristics of the models to help you further tune the pipeline if you desire.
+
+Below are the three execution environments supported by AutoML.
+
+
+ <a name="jupyter"></a>
+## Running samples in Azure Notebooks - Jupyter based notebooks in the Azure cloud
+
+1. [![Azure Notebooks](https://notebooks.azure.com/launch.png)](https://aka.ms/aml-clone-azure-notebooks)
+[Import sample notebooks ](https://aka.ms/aml-clone-azure-notebooks) into Azure Notebooks.
+1. Follow the instructions in the [configuration](configuration.ipynb) notebook to create and connect to a workspace.
+1. Open one of the sample notebooks.
+
+ <a name="databricks"></a>
+## Running samples in Azure Databricks
+
+**NOTE**: Please create your Azure Databricks cluster as v4.x (high concurrency preferred) with **Python 3** (dropdown).
+**NOTE**: You should at least have contributor access to your Azure subcription to run the notebook.
+- Please remove the previous SDK version if there is any and install the latest SDK by installing **azureml-sdk[automl_databricks]** as a PyPi library in Azure Databricks workspace.
+- Download the sample notebook 16a.auto-ml-classification-local-azuredatabricks from [GitHub](https://github.com/Azure/MachineLearningNotebooks) and import into the Azure databricks workspace.
+- Attach the notebook to the cluster.
+
+<a name="localconda"></a>
+## Running samples in a Local Conda environment
+
+To run these notebook on your own notebook server, use these installation instructions.
+
+The instructions below will install everything you need and then start a Jupyter notebook.  To start your Jupyter notebook manually, use:
+
+```
+conda activate azure_automl
+jupyter notebook
+```
+
+or on Mac:
+
+```
+source activate azure_automl
+jupyter notebook
+```
+
+
+### 1. Install mini-conda from [here](https://conda.io/miniconda.html), choose Python 3.7 or higher.
+- **Note**: if you already have conda installed, you can keep using it but it should be version 4.4.10 or later (as shown by: conda -V).  If you have a previous version installed, you can update it using the command: conda update conda.
+There's no need to install mini-conda specifically.
+
+### 2. Downloading the sample notebooks
+- Download the sample notebooks from [GitHub](https://github.com/Azure/MachineLearningNotebooks) as zip and extract the contents to a local directory.  The AutoML sample notebooks are in the "automl" folder.
+
+### 3. Setup a new conda environment
+The **automl/automl_setup** script creates a new conda environment, installs the necessary packages, configures the widget and starts a jupyter notebook.
+It takes the conda environment name as an optional parameter.  The default conda environment name is azure_automl.  The exact command depends on the operating system.  See the specific sections below for Windows, Mac and Linux.  It can take about 10 minutes to execute.
+## Windows
+Start an **Anaconda Prompt** window, cd to the **how-to-use-azureml/automated-machine-learning** folder where the sample notebooks were extracted and then run:
+```
+automl_setup
+```
+## Mac
+Install "Command line developer tools" if it is not already installed (you can use the command: `xcode-select --install`).
+
+Start a Terminal windows, cd to the **how-to-use-azureml/automated-machine-learning** folder where the sample notebooks were extracted and then run:
+
+```
+bash automl_setup_mac.sh
+```
+
+## Linux
+cd to the **how-to-use-azureml/automated-machine-learning** folder where the sample notebooks were extracted and then run:
+
+```
+bash automl_setup_linux.sh
+```
+
+### 4. Running configuration.ipynb
+- Before running any samples you next need to run the configuration notebook. Click on configuration.ipynb notebook
+- Execute the cells in the notebook to Register Machine Learning Services Resource Provider and create a workspace. (*instructions in notebook*)
+
+### 5. Running Samples
+- Please make sure you use the Python [conda env:azure_automl] kernel when trying the sample Notebooks.
+- Follow the instructions in the individual notebooks to explore various features in AutoML
+
+<a name="samples"></a>
+# Automated ML SDK Sample Notebooks
+- [configuration.ipynb](configuration.ipynb)
+    - Create new Azure ML Workspace
+    - Save Workspace configuration file
+
+- [auto-ml-classification.ipynb](classification/auto-ml-classification.ipynb)
+    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
+    - Simple example of using Auto ML for classification
+    - Uses local compute for training
+
+- [auto-ml-regression.ipynb](regression/auto-ml-regression.ipynb)
+    - Dataset: scikit learn's [diabetes dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_diabetes.html)
+    - Simple example of using Auto ML for regression
+    - Uses local compute for training
+
+- [auto-ml-remote-execution.ipynb](remote-execution/auto-ml-remote-execution.ipynb)
+    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
+    - Example of using Auto ML for classification using a remote linux DSVM for training
+    - Parallel execution of iterations
+    - Async tracking of progress
+    - Cancelling individual iterations or entire run
+    - Retrieving models for any iteration or logged metric
+    - Specify automl settings as kwargs
+
+- [auto-ml-remote-batchai.ipynb](remote-batchai/auto-ml-remote-batchai.ipynb)
+    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
+    - Example of using automated ML for classification using a remote Batch AI compute for training
+    - Parallel execution of iterations
+    - Async tracking of progress
+    - Cancelling individual iterations or entire run
+    - Retrieving models for any iteration or logged metric
+    - Specify automl settings as kwargs
+
+- [auto-ml-remote-attach.ipynb](remote-attach/auto-ml-remote-attach.ipynb)
+    - Dataset: Scikit learn's [20newsgroup](http://scikit-learn.org/stable/datasets/twenty_newsgroups.html)
+    - handling text data with preprocess flag
+    - Reading data from a blob store for remote executions
+    - using pandas dataframes for reading data
+
+- [auto-ml-missing-data-blacklist-early-termination.ipynb](missing-data-blacklist-early-termination/auto-ml-missing-data-blacklist-early-termination.ipynb)
+    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
+    - Blacklist certain pipelines
+    - Specify a target metrics to indicate stopping criteria
+    - Handling Missing Data in the input
+
+- [auto-ml-sparse-data-train-test-split.ipynb](sparse-data-train-test-split/auto-ml-sparse-data-train-test-split.ipynb)
+    - Dataset: Scikit learn's [20newsgroup](http://scikit-learn.org/stable/datasets/twenty_newsgroups.html)
+    - Handle sparse datasets
+    - Specify custom train and validation set
+
+- [auto-ml-exploring-previous-runs.ipynb](exploring-previous-runs/auto-ml-exploring-previous-runs.ipynb)
+    - List all projects for the workspace
+    - List all AutoML Runs for a given project
+    - Get details for a AutoML Run. (Automl settings, run widget & all metrics)
+    - Download fitted pipeline for any iteration
+
+- [auto-ml-remote-execution-with-datastore.ipynb](remote-execution-with-datastore/auto-ml-remote-execution-with-datastore.ipynb)
+    - Dataset: Scikit learn's [20newsgroup](http://scikit-learn.org/stable/datasets/twenty_newsgroups.html)
+    - Download the data and store it in DataStore.
+
+- [auto-ml-classification-with-deployment.ipynb](classification-with-deployment/auto-ml-classification-with-deployment.ipynb)
+    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
+    - Simple example of using Auto ML for classification
+    - Registering the model
+    - Creating Image and creating aci service
+    - Testing the aci service
+
+- [auto-ml-sample-weight.ipynb](sample-weight/auto-ml-sample-weight.ipynb)
+    - How to specifying sample_weight
+    - The difference that it makes to test results
+
+- [auto-ml-dataprep.ipynb](dataprep/auto-ml-dataprep.ipynb)
+    - Using DataPrep for reading data
+
+- [auto-ml-dataprep-remote-execution.ipynb](dataprep-remote-execution/auto-ml-dataprep-remote-execution.ipynb)
+    - Using DataPrep for reading data with remote execution
+
+- [auto-ml-classification-local-azuredatabricks.ipynb](classification-local-azuredatabricks/auto-ml-classification-local-azuredatabricks.ipynb)
+    - Dataset: scikit learn's [digit dataset](https://innovate.burningman.org/datasets-page/)
+    - Example of using AutoML for classification using Azure Databricks as the platform for training
+
+- [auto-ml-classification_with_tensorflow.ipynb](classification_with_tensorflow/auto-ml-classification_with_tensorflow.ipynb)
+    - Dataset: scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html#sklearn.datasets.load_digits)
+    - Simple example of using Auto ML for classification with whitelisting tensorflow models.checkout
+    - Uses local compute for training
+
+- [auto-ml-forecasting-a.ipynb](forecasting-a/auto-ml-forecasting-a.ipynb)
+    - Dataset: [NYC energy demand data](forecasting-a/nyc_energy.csv)
+    - Example of using AutoML for training a forecasting model
+
+- [auto-ml-forecasting-b.ipynb](forecasting-b/auto-ml-forecasting-b.ipynb)
+    - Dataset: [Dominick's grocery sales of orange juice](forecasting-b/dominicks_OJ.csv)
+    - Example of training an AutoML forecasting model on multiple time-series
+
+<a name="documentation"></a>
+# Documentation
+## Table of Contents
+1. [Automated ML Settings ](#automlsettings)
+1. [Cross validation split options](#cvsplits)
+1. [Get Data Syntax](#getdata)
+1. [Data pre-processing and featurization](#preprocessing)
+
+<a name="automlsettings"></a>
+## Automated ML Settings
+
+|Property|Description|Default|
+|-|-|-|
+|**primary_metric**|This is the metric that you want to optimize.<br><br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i><br><br> Regression supports the following primary metrics <br><i>spearman_correlation</i><br><i>normalized_root_mean_squared_error</i><br><i>r2_score</i><br><i>normalized_mean_absolute_error</i><br><i>normalized_root_mean_squared_log_error</i>| Classification: accuracy <br><br> Regression: spearman_correlation
+|**iteration_timeout_minutes**|Time limit in minutes for each iteration|None|
+|**iterations**|Number of iterations. In each iteration trains the data with a specific pipeline.  To get the best result, use at least 100. |100|
+|**n_cross_validations**|Number of cross validation splits|None|
+|**validation_size**|Size of validation set as percentage of all training samples|None|
+|**max_concurrent_iterations**|Max number of iterations that would be executed in parallel|1|
+|**preprocess**|*True/False* <br>Setting this to *True* enables preprocessing <br>on the input to handle missing data, and perform some common feature extraction<br>*Note: If input data is Sparse you cannot use preprocess=True*|False|
+|**max_cores_per_iteration**| Indicates how many cores on the compute target would be used to train a single pipeline.<br> You can set it to *-1* to use all cores|1|
+|**experiment_exit_score**|*double* value indicating the target for *primary_metric*. <br> Once the target is surpassed the run terminates|None|
+|**blacklist_models**|*Array* of *strings* indicating models to ignore for Auto ML from the list of models.|None|
+|**whitelist_models**|*Array* of *strings* use only models listed for Auto ML from the list of models..|None|
+ <a name="cvsplits"></a>
+## List of models for white list/blacklist
+**Classification**
+<br><i>LogisticRegression</i>
+<br><i>SGD</i>
+<br><i>MultinomialNaiveBayes</i>
+<br><i>BernoulliNaiveBayes</i>
+<br><i>SVM</i>
+<br><i>LinearSVM</i>
+<br><i>KNN</i>
+<br><i>DecisionTree</i>
+<br><i>RandomForest</i>
+<br><i>ExtremeRandomTrees</i>
+<br><i>LightGBM</i>
+<br><i>GradientBoosting</i>
+<br><i>TensorFlowDNN</i>
+<br><i>TensorFlowLinearClassifier</i>
+<br><br>**Regression**
+<br><i>ElasticNet</i>
+<br><i>GradientBoosting</i>
+<br><i>DecisionTree</i>
+<br><i>KNN</i>
+<br><i>LassoLars</i>
+<br><i>SGD</i>
+<br><i>RandomForest</i>
+<br><i>ExtremeRandomTrees</i>
+<br><i>LightGBM</i>
+<br><i>TensorFlowLinearRegressor</i>
+<br><i>TensorFlowDNN</i>
+
+## Cross validation split options
+### K-Folds Cross Validation
+Use *n_cross_validations* setting to specify the number of cross validations. The training data set will be randomly split into *n_cross_validations* folds of equal size. During each cross validation round, one of the folds will be used for validation of the model trained on the remaining folds. This process repeats for *n_cross_validations* rounds until each fold is used once as validation set. Finally, the average scores accross all *n_cross_validations* rounds will be reported, and the corresponding model will be retrained on the whole training data set.
+
+### Monte Carlo Cross Validation (a.k.a. Repeated Random Sub-Sampling)
+Use *validation_size* to specify the percentage of the training data set that should be used for validation, and use *n_cross_validations* to specify the number of cross validations. During each cross validation round, a subset of size *validation_size* will be randomly selected for validation of the model trained on the remaining data. Finally, the average scores accross all *n_cross_validations* rounds will be reported, and the corresponding model will be retrained on the whole training data set.
+
+### Custom train and validation set
+You can specify seperate train and validation set either through the get_data() or directly to the fit method.
+
+<a name="getdata"></a>
+## get_data() syntax
+The *get_data()* function can be used to return a dictionary with these values:
+
+|Key|Type|Dependency|Mutually Exclusive with|Description|
+|:-|:-|:-|:-|:-|
+|X|Pandas Dataframe or Numpy Array|y|data_train, label, columns|All features to train with|
+|y|Pandas Dataframe or Numpy Array|X|label|Label data to train with.  For classification, this should be an array of integers. |
+|X_valid|Pandas Dataframe or Numpy Array|X, y, y_valid|data_train, label|*Optional* All features to validate with.  If this is not specified, X is split between train and validate|
+|y_valid|Pandas Dataframe or Numpy Array|X, y, X_valid|data_train, label|*Optional* The label data to validate with.  If this is not specified, y is split between train and validate|
+|sample_weight|Pandas Dataframe or Numpy Array|y|data_train, label, columns|*Optional* A weight value for each label. Higher values indicate that the sample is more important.|
+|sample_weight_valid|Pandas Dataframe or Numpy Array|y_valid|data_train, label, columns|*Optional* A weight value for each validation label. Higher values indicate that the sample is more important.  If this is not specified, sample_weight is split between train and validate|
+|data_train|Pandas Dataframe|label|X, y, X_valid, y_valid|All data (features+label) to train with|
+|label|string|data_train|X, y, X_valid, y_valid|Which column in data_train represents the label|
+|columns|Array of strings|data_train||*Optional* Whitelist of columns to use for features|
+|cv_splits_indices|Array of integers|data_train||*Optional* List of indexes to split the data for cross validation|
+
+<a name="preprocessing"></a>
+## Data pre-processing and featurization
+If you use `preprocess=True`, the following data preprocessing steps are performed automatically for you:
+
+1. Dropping high cardinality or no variance features
+    - Features with no useful information are dropped from training and validation sets. These include features with all values missing, same value across all rows or with extremely high cardinality (e.g., hashes, IDs or GUIDs).
+2. Missing value imputation
+    - For numerical features, missing values are imputed with average of values in the column.
+    - For categorical features, missing values are imputed with most frequent value.
+3. Generating additional features
+    - For DateTime features: Year, Month, Day, Day of week, Day of year, Quarter, Week of the year, Hour, Minute, Second.
+    - For Text features: Term frequency based on bi-grams and tri-grams, Count vectorizer.
+4. Transformations and encodings
+    - Numeric features with very few unique values are transformed into categorical features.
+
+<a name="pythoncommand"></a>
+# Running using python command
+Jupyter notebook provides a File / Download as / Python (.py) option for saving the notebook as a Python file.
+You can then run this file using the python command.
+However, on Windows the file needs to be modified before it can be run.
+The following condition must be added to the main code in the file:
+
+    if __name__ == "__main__":
+
+The main code of the file must be indented so that it is under this condition.
+
+<a name="troubleshooting"></a>
+# Troubleshooting
+## automl_setup fails
+1. On windows, make sure that you are running automl_setup from an Anconda Prompt window rather than a regular cmd window.  You can launch the "Anaconda Prompt" window by hitting the Start button and typing "Anaconda Prompt".  If you don't see the application "Anaconda Prompt", you might not have conda or mini conda installed.  In that case, you can install it [here](https://conda.io/miniconda.html)
+2. Check that you have conda 4.4.10 or later.  You can check the version with the command `conda -V`.  If you have a previous version installed, you can update it using the command: `conda update conda`.
+3. Pass a new name as the first parameter to automl_setup so that it creates a new conda environment. You can view existing conda environments using `conda env list` and remove them with `conda env remove -n <environmentname>`. 
+
+## configuration.ipynb fails
+1) For local conda, make sure that you have susccessfully run automl_setup first.
+2) Check that the subscription_id is correct.  You can find the subscription_id in the Azure Portal by selecting All Service and then Subscriptions. The characters "<" and ">" should not be included in the subscription_id value.  For example, `subscription_id = "12345678-90ab-1234-5678-1234567890abcd"` has the valid format.
+3) Check that you have Contributor or Owner access to the Subscription.
+4) Check that the region is one of the supported regions: `eastus2`, `eastus`, `westcentralus`, `southeastasia`, `westeurope`, `australiaeast`, `westus2`, `southcentralus`
+5) Check that you have access to the region using the Azure Portal.
+
+## workspace.from_config fails
+If the call `ws = Workspace.from_config()` fails:
+1) Make sure that you have run the `configuration.ipynb` notebook successfully.
+2) If you are running a notebook from a folder that is not under the folder where you ran `configuration.ipynb`, copy the folder aml_config and the file config.json that it contains to the new folder.  Workspace.from_config reads the config.json for the notebook folder or it parent folder.
+3) If you are switching to a new subscription, resource group, workspace or region, make sure that you run the `configuration.ipynb` notebook again.  Changing config.json directly will only work if the workspace already exists in the specified resource group under the specified subscription.
+4) If you want to change the region, please change the workspace, resource group or subscription.  `Workspace.create` will not create or update a workspace if it already exists, even if the region specified is different.
+
+## Sample notebook fails
+If a sample notebook fails with an error that property, method or library does not exist:
+1) Check that you have selected correct kernel in jupyter notebook.  The kernel is displayed in the top right of the notebook page.  It can be changed using the `Kernel | Change Kernel` menu option.  For Azure Notebooks, it should be `Python 3.6`.  For local conda environments, it should be the conda envioronment name that you specified in automl_setup.  The default is azure_automl.  Note that the kernel is saved as part of the notebook.  So, if you switch to a new conda environment, you will have to select the new kernel in the notebook.
+2) Check that the notebook is for the SDK version that you are using.  You can check the SDK version by executing `azureml.core.VERSION` in a jupyter notebook cell.  You can download previous version of the sample notebooks from GitHub by clicking the `Branch` button, selecting the `Tags` tab and then selecting the version.
+
+## Remote run: DsvmCompute.create fails 
+There are several reasons why the DsvmCompute.create can fail.  The reason is usually in the error message but you have to look at the end of the error message for the detailed reason.  Some common reasons are:
+1) `Compute name is invalid, it should start with a letter, be between 2 and 16 character, and only include letters (a-zA-Z), numbers (0-9) and \'-\'.`  Note that underscore is not allowed in the name.
+2) `The requested VM size xxxxx is not available in the current region.`  You can select a different region or vm_size. 
+
+## Remote run: Unable to establish SSH connection
+AutoML uses the SSH protocol to communicate with remote DSVMs.  This defaults to port 22.  Possible causes for this error are:
+1) The DSVM is not ready for SSH connections.  When DSVM creation completes, the DSVM might still not be ready to acceept SSH connections.  The sample notebooks have a one minute delay to allow for this.
+2) Your Azure Subscription may restrict the IP address ranges that can access the DSVM on port 22.  You can check this in the Azure Portal by selecting the Virtual Machine and then clicking Networking.  The Virtual Machine name is the name that you provided in the notebook plus 10 alpha numeric characters to make the name unique.  The Inbound Port Rules define what can access the VM on specific ports.  Note that there is a priority priority order.  So, a Deny entry with a low priority number will override a Allow entry with a higher priority number.
+
+## Remote run: setup iteration fails
+This is often an issue with the `get_data` method.
+1) Check that the `get_data` method is valid by running it locally.
+2) Make sure that `get_data` isn't referring to any local files.  `get_data` is executed on the remote DSVM.  So, it doesn't have direct access to local data files.  Instead you can store the data files with DataStore.  See [auto-ml-remote-execution-with-datastore.ipynb](remote-execution-with-datastore/auto-ml-remote-execution-with-datastore.ipynb)
+3) You can get to the error log for the setup iteration by clicking the `Click here to see the run in Azure portal` link, click `Back to Experiment`, click on the highest run number and then click on Logs.
+
+## Remote run: disk full
+AutoML creates files under /tmp/azureml_runs for each iteration that it runs.  It creates a folder with the iteration id.  For example: AutoML_9a038a18-77cc-48f1-80fb-65abdbc33abe_93.  Under this, there is a azureml-logs folder, which contains logs.  If you run too many iterations on the same DSVM, these files can fill the disk.
+You can delete the files under /tmp/azureml_runs or just delete the VM and create a new one.
+If your get_data downloads files, make sure the delete them or they can use disk space as well.
+When using DataStore, it is good to specify an absolute path for the files so that they are downloaded just once.  If you specify a relative path, it will download a file for each iteration.
+
+## Remote run: Iterations fail and the log contains "MemoryError"
+This can be caused by insufficient memory on the DSVM.  AutoML loads all training data into memory.  So, the available memory should be more than the training data size.
+If you are using a remote DSVM, memory is needed for each concurrent iteration.  The max_concurrent_iterations setting specifies the maximum concurrent iterations.  For example, if the training data size is 8Gb and max_concurrent_iterations is set to 10, the minimum memory required is at least 80Gb.
+To resolve this issue, allocate a DSVM with more memory or reduce the value specified for max_concurrent_iterations.
+
+## Remote run: Iterations show as "Not Responding" in the RunDetails widget.
+This can be caused by too many concurrent iterations for a remote DSVM.  Each concurrent iteration usually takes 100% of a core when it is running.  Some iterations can use multiple cores.  So, the max_concurrent_iterations setting should always be less than the number of cores of the DSVM.
+To resolve this issue, try reducing the value specified for the max_concurrent_iterations setting.

how-to-use-azureml/automated-machine-learning/automl_env.yml

@@ -0,0 +1,32 @@
+name: azure_automl
+dependencies:
+  # The python interpreter version.
+  # Currently Azure ML only supports 3.5.2 and later.
+- python=3.6
+- nb_conda
+- matplotlib==2.1.0
+- numpy>=1.11.0,<1.15.0
+- cython
+- urllib3<1.24
+- scipy>=1.0.0,<=1.1.0
+- scikit-learn>=0.18.0,<=0.19.1
+- pandas>=0.22.0,<0.23.0
+- tensorflow>=1.12.0
+
+# Required for azuremlftk
+- dill
+- pyodbc
+- statsmodels 
+- numexpr  
+- keras
+- distributed>=1.21.5,<1.24
+  
+- pip:
+
+  # Required for azuremlftk
+  - https://azuremlpackages.blob.core.windows.net/forecasting/azuremlftk-0.1.18323.5a1-py3-none-any.whl
+
+  # Required packages for AzureML execution, history, and data preparation.
+  - azureml-sdk[automl,notebooks,explain]
+  - pandas_ml
+  

how-to-use-azureml/automated-machine-learning/automl_env_mac.yml

@@ -0,0 +1,33 @@
+name: azure_automl
+dependencies:
+  # The python interpreter version.
+  # Currently Azure ML only supports 3.5.2 and later.
+- python=3.6
+- nb_conda
+- matplotlib==2.1.0
+- numpy>=1.15.3
+- cython
+- urllib3<1.24
+- scipy>=1.0.0,<=1.1.0
+- scikit-learn>=0.18.0,<=0.19.1
+- pandas>=0.22.0,<0.23.0
+- tensorflow>=1.12.0
+
+# Required for azuremlftk
+- dill
+- pyodbc
+- statsmodels 
+- numexpr  
+- keras
+- distributed>=1.21.5,<1.24
+  
+- pip:
+
+  # Required for azuremlftk
+  - https://azuremlpackages.blob.core.windows.net/forecasting/azuremlftk-0.1.18323.5a1-py3-none-any.whl
+
+  # Required packages for AzureML execution, history, and data preparation.
+  - azureml-sdk[automl,notebooks,explain]
+  - pandas_ml
+  
+

how-to-use-azureml/automated-machine-learning/automl_setup.cmd

@@ -0,0 +1,52 @@
+@echo off
+set conda_env_name=%1
+set automl_env_file=%2
+set PIP_NO_WARN_SCRIPT_LOCATION=0
+
+IF "%conda_env_name%"=="" SET conda_env_name="azure_automl"
+IF "%automl_env_file%"=="" SET automl_env_file="automl_env.yml"
+
+IF NOT EXIST %automl_env_file% GOTO YmlMissing
+
+call conda activate %conda_env_name% 2>nul:
+
+if not errorlevel 1 (
+  echo Upgrading azureml-sdk[automl,notebooks,explain] in existing conda environment %conda_env_name%
+  call pip install --upgrade azureml-sdk[automl,notebooks,explain]
+  if errorlevel 1 goto ErrorExit
+) else (
+  call conda env create -f %automl_env_file% -n %conda_env_name%
+)
+
+call conda activate %conda_env_name% 2>nul:
+if errorlevel 1 goto ErrorExit
+
+call pip install psutil
+
+call python -m ipykernel install --user --name %conda_env_name% --display-name "Python (%conda_env_name%)"
+
+call jupyter nbextension install --py azureml.widgets --user
+if errorlevel 1 goto ErrorExit
+
+call jupyter nbextension enable --py azureml.widgets --user
+if errorlevel 1 goto ErrorExit
+
+echo.
+echo.
+echo ***************************************
+echo * AutoML setup completed successfully *
+echo ***************************************
+echo.
+echo Starting jupyter notebook - please run the configuration notebook 
+echo.
+jupyter notebook --log-level=50
+
+goto End
+
+:YmlMissing
+echo File %automl_env_file% not found.
+
+:ErrorExit
+echo Install failed
+
+:End

how-to-use-azureml/automated-machine-learning/automl_setup_linux.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+CONDA_ENV_NAME=$1
+AUTOML_ENV_FILE=$2
+PIP_NO_WARN_SCRIPT_LOCATION=0
+
+if [ "$CONDA_ENV_NAME" == "" ]
+then
+  CONDA_ENV_NAME="azure_automl"
+fi
+
+if [ "$AUTOML_ENV_FILE" == "" ]
+then
+  AUTOML_ENV_FILE="automl_env.yml"
+fi
+
+if [ ! -f $AUTOML_ENV_FILE ]; then
+    echo "File $AUTOML_ENV_FILE not found"
+    exit 1
+fi
+
+if source activate $CONDA_ENV_NAME 2> /dev/null
+then
+   echo "Upgrading azureml-sdk[automl,notebooks,explain] in existing conda environment" $CONDA_ENV_NAME
+   pip install --upgrade azureml-sdk[automl,notebooks,explain]
+else
+   conda env create -f $AUTOML_ENV_FILE -n $CONDA_ENV_NAME &&
+   source activate $CONDA_ENV_NAME &&
+   python -m ipykernel install --user --name $CONDA_ENV_NAME --display-name "Python ($CONDA_ENV_NAME)" &&
+   jupyter nbextension install --py azureml.widgets --user &&
+   jupyter nbextension enable --py azureml.widgets --user &&
+   echo "" &&
+   echo "" &&
+   echo "***************************************" &&
+   echo "* AutoML setup completed successfully *" &&
+   echo "***************************************" &&
+   echo "" &&
+   echo "Starting jupyter notebook - please run the configuration notebook" &&
+   echo "" &&
+   jupyter notebook --log-level=50
+fi
+
+if [ $? -gt 0 ]
+then
+   echo "Installation failed"
+fi
+
+

how-to-use-azureml/automated-machine-learning/automl_setup_mac.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+CONDA_ENV_NAME=$1
+AUTOML_ENV_FILE=$2
+PIP_NO_WARN_SCRIPT_LOCATION=0
+
+if [ "$CONDA_ENV_NAME" == "" ]
+then
+  CONDA_ENV_NAME="azure_automl"
+fi
+
+if [ "$AUTOML_ENV_FILE" == "" ]
+then
+  AUTOML_ENV_FILE="automl_env_mac.yml"
+fi
+
+if [ ! -f $AUTOML_ENV_FILE ]; then
+    echo "File $AUTOML_ENV_FILE not found"
+    exit 1
+fi
+
+if source activate $CONDA_ENV_NAME 2> /dev/null
+then
+   echo "Upgrading azureml-sdk[automl,notebooks,explain] in existing conda environment" $CONDA_ENV_NAME
+   pip install --upgrade azureml-sdk[automl,notebooks,explain]
+else
+   conda env create -f $AUTOML_ENV_FILE -n $CONDA_ENV_NAME &&
+   source activate $CONDA_ENV_NAME &&
+   conda install lightgbm -c conda-forge -y &&
+   python -m ipykernel install --user --name $CONDA_ENV_NAME --display-name "Python ($CONDA_ENV_NAME)" &&
+   jupyter nbextension install --py azureml.widgets --user &&
+   jupyter nbextension enable --py azureml.widgets --user &&
+   pip install numpy==1.15.3
+   echo "" &&
+   echo "" &&
+   echo "***************************************" &&
+   echo "* AutoML setup completed successfully *" &&
+   echo "***************************************" &&
+   echo "" &&
+   echo "Starting jupyter notebook - please run the configuration notebook" &&
+   echo "" &&
+   jupyter notebook --log-level=50
+fi
+
+if [ $? -gt 0 ]
+then
+   echo "Installation failed"
+fi
+
+
+

how-to-use-azureml/automated-machine-learning/classification-local-azuredatabricks/auto-ml-classification-local-azuredatabricks.ipynb

@@ -0,0 +1,568 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Classification local on Azure DataBricks\n",
+    "\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use AutoML for a simple classification problem.\n",
+    "\n",
+    "In this notebook you will learn how to:\n",
+    "1. Create Azure Machine Learning Workspace object and initialize your notebook directory to easily reload this object from a configuration file.\n",
+    "2. Create an `Experiment` in an existing `Workspace`.\n",
+    "3. Configure AutoML using `AutoMLConfig`.\n",
+    "4. Train the model using AzureDataBricks.\n",
+    "5. Explore the results.\n",
+    "6. Test the best fitted model.\n",
+    "\n",
+    "Prerequisites:\n",
+    "Before running this notebook, run the install instructions described in README.md."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Register Machine Learning Services Resource Provider\n",
+    "Microsoft.MachineLearningServices only needs to be registed once in the subscription. To register it:\n",
+    "Start the Azure portal.\n",
+    "Select your All services and then Subscription.\n",
+    "Select the subscription that you want to use.\n",
+    "Click on Resource providers\n",
+    "Click the Register link next to Microsoft.MachineLearningServices"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Check the Azure ML Core SDK Version to Validate Your Installation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "\n",
+    "print(\"SDK Version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize an Azure ML Workspace\n",
+    "### What is an Azure ML Workspace and Why Do I Need One?\n",
+    "\n",
+    "An Azure ML workspace is an Azure resource that organizes and coordinates the actions of many other Azure resources to assist in executing and sharing machine learning workflows.  In particular, an Azure ML workspace coordinates storage, databases, and compute resources providing added functionality for machine learning experimentation, operationalization, and the monitoring of operationalized models.\n",
+    "\n",
+    "\n",
+    "### What do I Need?\n",
+    "\n",
+    "To create or access an Azure ML workspace, you will need to import the Azure ML library and specify following information:\n",
+    "* A name for your workspace. You can choose one.\n",
+    "* Your subscription id. Use the `id` value from the `az account show` command output above.\n",
+    "* The resource group name. The resource group organizes Azure resources and provides a default region for the resources in the group. The resource group will be created if it doesn't exist. Resource groups can be created and viewed in the [Azure portal](https://portal.azure.com)\n",
+    "* Supported regions include `eastus2`, `eastus`,`westcentralus`, `southeastasia`, `westeurope`, `australiaeast`, `westus2`, `southcentralus`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "subscription_id = \"<SubscriptionId>\"\n",
+    "resource_group = \"myrg\"\n",
+    "workspace_name = \"myws\"\n",
+    "workspace_region = \"eastus2\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Creating a Workspace\n",
+    "If you already have access to an Azure ML workspace you want to use, you can skip this cell.  Otherwise, this cell will create an Azure ML workspace for you in the specified subscription, provided you have the correct permissions for the given `subscription_id`.\n",
+    "\n",
+    "This will fail when:\n",
+    "1. The workspace already exists.\n",
+    "2. You do not have permission to create a workspace in the resource group.\n",
+    "3. You are not a subscription owner or contributor and no Azure ML workspaces have ever been created in this subscription.\n",
+    "\n",
+    "If workspace creation fails for any reason other than already existing, please work with your IT administrator to provide you with the appropriate permissions or to provision the required resources.\n",
+    "\n",
+    "**Note:** Creation of a new workspace can take several minutes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import the Workspace class and check the Azure ML SDK version.\n",
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace.create(name = workspace_name,\n",
+    "                      subscription_id = subscription_id,\n",
+    "                      resource_group = resource_group, \n",
+    "                      location = workspace_region,\n",
+    "                      exist_ok=True)\n",
+    "ws.get_details()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configuring Your Local Environment\n",
+    "You can validate that you have access to the specified workspace and write a configuration file to the default configuration location, `./aml_config/config.json`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace(workspace_name = workspace_name,\n",
+    "               subscription_id = subscription_id,\n",
+    "               resource_group = resource_group)\n",
+    "\n",
+    "# Persist the subscription id, resource group name, and workspace name in aml_config/config.json.\n",
+    "ws.write_config()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create a Folder to Host Sample Projects\n",
+    "Finally, create a folder where all the sample projects will be hosted."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "\n",
+    "sample_projects_folder = './sample_projects'\n",
+    "\n",
+    "if not os.path.isdir(sample_projects_folder):\n",
+    "    os.mkdir(sample_projects_folder)\n",
+    "    \n",
+    "print('Sample projects will be created in {}.'.format(sample_projects_folder))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an Experiment\n",
+    "\n",
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import os\n",
+    "import random\n",
+    "import time\n",
+    "\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "import numpy as np\n",
+    "import pandas as pd\n",
+    "\n",
+    "import azureml.core\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "\n",
+    "# Choose a name for the experiment and specify the project folder.\n",
+    "experiment_name = 'automl-local-classification'\n",
+    "project_folder = './sample_projects/automl-local-classification'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace Name'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Experiment Name'] = experiment.name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data = output, index = ['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "set_diagnostics_collection(send_diagnostics = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Load Training Data Using DataPrep\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.dataprep as dprep\n",
+    "# You can use `auto_read_file` which intelligently figures out delimiters and datatypes of a file.\n",
+    "# The data referenced here was pulled from `sklearn.datasets.load_digits()`.\n",
+    "simple_example_data_root = 'https://dprepdata.blob.core.windows.net/automl-notebook-data/'\n",
+    "X = dprep.auto_read_file(simple_example_data_root + 'X.csv').skip(1)  # Remove the header row.\n",
+    "\n",
+    "# You can also use `read_csv` and `to_*` transformations to read (with overridable delimiter)\n",
+    "# and convert column types manually.\n",
+    "# Here we read a comma delimited file and convert all columns to integers.\n",
+    "y = dprep.read_csv(simple_example_data_root + 'y.csv').to_long(dprep.ColumnSelector(term='.*', use_regex = True))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\n",
+    "## Review the Data Preparation Result\n",
+    "You can peek the result of a Dataflow at any range using skip(i) and head(j). Doing so evaluates only j records for all the steps in the Dataflow, which makes it fast even against large datasets."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "X.skip(1).head(5)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure AutoML\n",
+    "\n",
+    "Instantiate an `AutoMLConfig` object to specify the settings and data used to run the experiment.\n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**task**|classification or regression|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**spark_context**|Spark Context object.|\n",
+    "|**max_cuncurrent_iterations**|Maximum number of iterations to execute in parallel. This should be less than the number of cores on the ADB..|\n",
+    "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. This should be an array of integers.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "automl_settings = {\n",
+    "    \"iteration_timeout_minutes\": 10,\n",
+    "    \"iterations\": 10,\n",
+    "    \"n_cross_validations\": 5,\n",
+    "    \"primary_metric\": 'AUC_weighted',\n",
+    "    \"preprocess\": False,\n",
+    "    \"max_concurrent_iterations\": 2,\n",
+    "    \"verbosity\": logging.INFO,\n",
+    "    \"spark_context\": sc\n",
+    "}\n",
+    " \n",
+    "automl_config = AutoMLConfig(task = 'classification',\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             path = project_folder, \n",
+    "                             X = X, \n",
+    "                             y = y,\n",
+    "                             **automl_settings\n",
+    "                            )\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output = False)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explore the Results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Portal URL for Monitoring Runs\n",
+    "\n",
+    "The following will provide a link to the web interface to explore individual run details and status."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(local_run.get_portal_url())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\n",
+    "The following will show the child runs and waits for the parent run to complete."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run.wait_for_completion(show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Retrieve All Child Runs\n",
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "children = list(local_run.get_children())\n",
+    "metricslist = {}\n",
+    "for run in children:\n",
+    "    properties = run.get_properties()\n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
+    "    metricslist[int(properties['iteration'])] = metrics\n",
+    "\n",
+    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
+    "rundata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "\n",
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = local_run.get_output()\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model that has the smallest `log_loss` value:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "lookup_metric = \"log_loss\"\n",
+    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "iteration = 3\n",
+    "third_run, third_model = local_run.get_output(iteration = iteration)\n",
+    "print(third_run)\n",
+    "print(third_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Test the Best Fitted Model\n",
+    "\n",
+    "#### Load Test Data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "digits = datasets.load_digits()\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
+    "images = digits.images[:10]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Testing Our Best Fitted Model\n",
+    "We will try to predict 2 digits and see how our model works."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Randomly select digits and test.\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
+    "    print(index)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
+    "    fig = plt.figure(1, figsize = (3,3))\n",
+    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
+    "    ax1.set_title(title)\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
+    "    display(fig)"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python [conda env:AutoML_ADB]",
+   "language": "python",
+   "name": "conda-env-AutoML_ADB-py"
+  },
+  "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.6.6"
+  },
+  "name": "auto-ml-classification-local-adb",
+  "notebookId": 3742842704905931
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}

how-to-use-azureml/automated-machine-learning/classification-with-deployment/auto-ml-classification-with-deployment.ipynb

@@ -13,29 +13,30 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 09: Classification with deployment\n",
+    "# Automated Machine Learning: Classification with Deployment\n",
     "\n",
-    "In this example we use the scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) to showcase how you can use AutoML for a simple classification problem.\n",
+    "In this example we use the scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) to showcase how you can use AutoML for a simple classification problem and deploy it to an Azure Container Instance (ACI).\n",
     "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
-    "In this notebook you would see\n",
-    "1. Creating an Experiment using an existing Workspace\n",
-    "2. Instantiating AutoMLConfig\n",
-    "3. Training the Model using local compute\n",
-    "4. Exploring the results\n",
-    "5. Registering the model\n",
-    "6. Creating Image and creating aci service\n",
-    "7. Testing the aci service\n"
+    "In this notebook you will learn how to:\n",
+    "1. Create an experiment using an existing workspace.\n",
+    "2. Configure AutoML using `AutoMLConfig`.\n",
+    "3. Train the model using local compute.\n",
+    "4. Explore the results.\n",
+    "5. Register the model.\n",
+    "6. Create a container image.\n",
+    "7. Create an Azure Container Instance (ACI) service.\n",
+    "8. Test the ACI service.\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create Experiment\n",
+    "## Create an Experiment\n",
     "\n",
-    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
    ]
   },
   {
@@ -71,7 +72,7 @@
     "ws = Workspace.from_config()\n",
     "\n",
     "# choose a name for experiment\n",
-    "experiment_name =  'automl-local-classification'\n",
+    "experiment_name = 'automl-local-classification'\n",
     "# project folder\n",
     "project_folder = './sample_projects/automl-local-classification'\n",
     "\n",
@@ -95,7 +96,7 @@
    "source": [
     "## Diagnostics\n",
     "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
    ]
   },
   {
@@ -105,27 +106,27 @@
    "outputs": [],
    "source": [
     "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
+    "set_diagnostics_collection(send_diagnostics = True)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Instantiate Auto ML Config\n",
+    "## Configure AutoML\n",
     "\n",
     "Instantiate a AutoMLConfig object. This defines the settings and data used to run the experiment.\n",
     "\n",
     "|Property|Description|\n",
     "|-|-|\n",
     "|**task**|classification or regression|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data|\n",
-    "|**n_cross_validations**|Number of cross validation splits|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
     "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
-    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers. |\n",
-    "|**path**|Relative path to the project folder.  AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder. |"
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. This should be an array of integers.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
    ]
   },
   {
@@ -135,30 +136,30 @@
    "outputs": [],
    "source": [
     "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[10:,:]\n",
-    "y_digits = digits.target[10:]\n",
+    "X_train = digits.data[10:,:]\n",
+    "y_train = digits.target[10:]\n",
     "\n",
     "automl_config = AutoMLConfig(task = 'classification',\n",
-    "                             name=experiment_name,\n",
-    "                             debug_log='automl_errors.log',\n",
-    "                             primary_metric='AUC_weighted',\n",
-    "                             max_time_sec=1200,\n",
-    "                             iterations=10,\n",
-    "                             n_cross_validations=2,\n",
-    "                             verbosity=logging.INFO,\n",
-    "                             X = X_digits, \n",
-    "                             y = y_digits,\n",
-    "                             path=project_folder)"
+    "                             name = experiment_name,\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             primary_metric = 'AUC_weighted',\n",
+    "                             iteration_timeout_minutes = 20,\n",
+    "                             iterations = 10,\n",
+    "                             n_cross_validations = 2,\n",
+    "                             verbosity = logging.INFO,\n",
+    "                             X = X_train, \n",
+    "                             y = y_train,\n",
+    "                             path = project_folder)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Training the Model\n",
+    "## Train the Models\n",
     "\n",
-    "You can call the submit method on the experiment object and pass the run configuration. For Local runs the execution is synchronous. Depending on the data and number of iterations this can run for while.\n",
-    "You will see the currently running iterations printing to the console."
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
    ]
   },
   {
@@ -167,7 +168,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "local_run = experiment.submit(automl_config, show_output=True)"
+    "local_run = experiment.submit(automl_config, show_output = True)"
    ]
   },
   {
@@ -176,7 +177,7 @@
    "source": [
     "### Retrieve the Best Model\n",
     "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
+    "Below we select the best pipeline from our iterations. The `get_output` method on `automl_classifier` returns the best run and the fitted model for the last invocation. Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
    ]
   },
   {
@@ -192,7 +193,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Register fitted model for deployment"
+    "### Register the Fitted Model for Deployment\n",
+    "If neither `metric` nor `iteration` are specified in the `register_model` call, the iteration with the best primary metric is registered."
    ]
   },
   {
@@ -203,7 +205,7 @@
    "source": [
     "description = 'AutoML Model'\n",
     "tags = None\n",
-    "model = local_run.register_model(description=description, tags=tags, iteration=8)\n",
+    "model = local_run.register_model(description = description, tags = tags)\n",
     "local_run.model_id # This will be written to the script file later in the notebook."
    ]
   },
@@ -211,7 +213,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Create Scoring script ###"
+    "### Create Scoring Script"
    ]
   },
   {
@@ -224,6 +226,7 @@
     "import pickle\n",
     "import json\n",
     "import numpy\n",
+    "import azureml.train.automl\n",
     "from sklearn.externals import joblib\n",
     "from azureml.core.model import Model\n",
     "\n",
@@ -249,14 +252,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Create yml file for env"
+    "### Create a YAML File for the Environment"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "To ensure the consistence the fit results with the training results, the sdk dependence versions need to be the same as the environment that trains the model. Details about retrieving the versions can be found in notebook 12.auto-ml-retrieve-the-training-sdk-versions.ipynb."
+    "To ensure the fit results are consistent with the training results, the SDK dependency versions need to be the same as the environment that trains the model. Details about retrieving the versions can be found in notebook [12.auto-ml-retrieve-the-training-sdk-versions](12.auto-ml-retrieve-the-training-sdk-versions.ipynb)."
    ]
   },
   {
@@ -268,7 +271,7 @@
     "experiment_name = 'automl-local-classification'\n",
     "\n",
     "experiment = Experiment(ws, experiment_name)\n",
-    "ml_run = AutoMLRun(experiment=experiment, run_id=local_run.id)"
+    "ml_run = AutoMLRun(experiment = experiment, run_id = local_run.id)"
    ]
   },
   {
@@ -277,7 +280,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dependencies = ml_run.get_run_sdk_dependencies(iteration=7)"
+    "dependencies = ml_run.get_run_sdk_dependencies(iteration = 7)"
    ]
   },
   {
@@ -296,15 +299,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%%writefile myenv.yml\n",
-    "name: myenv\n",
-    "channels:\n",
-    "  - defaults\n",
-    "dependencies:\n",
-    "  - pip:\n",
-    "    - numpy==1.14.2\n",
-    "    - scikit-learn==0.19.2\n",
-    "    - azureml-sdk[notebooks,automl]==<<azureml-version>> "
+    "from azureml.core.conda_dependencies import CondaDependencies\n",
+    "\n",
+    "myenv = CondaDependencies.create(conda_packages=['numpy','scikit-learn'], pip_packages=['azureml-sdk[automl]'])\n",
+    "\n",
+    "conda_env_file_name = 'myenv.yml'\n",
+    "myenv.save_to_file('.', conda_env_file_name)"
    ]
   },
   {
@@ -314,14 +314,14 @@
    "outputs": [],
    "source": [
     "# Substitute the actual version number in the environment file.\n",
-    "\n",
-    "conda_env_file_name = 'myenv.yml'\n",
+    "# This is not strictly needed in this notebook because the model should have been generated using the current SDK version.\n",
+    "# However, we include this in case this code is used on an experiment from a previous SDK version.\n",
     "\n",
     "with open(conda_env_file_name, 'r') as cefr:\n",
     "    content = cefr.read()\n",
     "\n",
     "with open(conda_env_file_name, 'w') as cefw:\n",
-    "    cefw.write(content.replace('<<azureml-version>>', dependencies['azureml-sdk']))\n",
+    "    cefw.write(content.replace(azureml.core.VERSION, dependencies['azureml-sdk']))\n",
     "\n",
     "# Substitute the actual model id in the script file.\n",
     "\n",
@@ -338,7 +338,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Create Image ###"
+    "### Create a Container Image"
    ]
   },
   {
@@ -361,14 +361,17 @@
     "                     image_config = image_config, \n",
     "                     workspace = ws)\n",
     "\n",
-    "image.wait_for_creation(show_output = True)"
+    "image.wait_for_creation(show_output = True)\n",
+    "\n",
+    "if image.creation_state == 'Failed':\n",
+    "    print(\"Image build log at: \" + image.image_build_log_uri)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Deploy Image as web service on Azure Container Instance ###"
+    "### Deploy the Image as a Web Service on Azure Container Instance"
    ]
   },
   {
@@ -407,7 +410,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### To delete a service ##"
+    "### Delete a Web Service"
    ]
   },
   {
@@ -423,7 +426,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### To get logs from deployed service ###"
+    "### Get Logs from a Deployed Web Service"
    ]
   },
   {
@@ -439,7 +442,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Test Web Service ###"
+    "### Test a Web Service"
    ]
   },
   {
@@ -450,33 +453,31 @@
    "source": [
     "#Randomly select digits and test\n",
     "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[:10, :]\n",
-    "y_digits = digits.target[:10]\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
     "images = digits.images[:10]\n",
     "\n",
-    "for index in np.random.choice(len(y_digits), 3):\n",
+    "for index in np.random.choice(len(y_test), 3, replace = False):\n",
     "    print(index)\n",
-    "    test_sample = json.dumps({'data':X_digits[index:index + 1].tolist()})\n",
+    "    test_sample = json.dumps({'data':X_test[index:index + 1].tolist()})\n",
     "    predicted = aci_service.run(input_data = test_sample)\n",
-    "    label = y_digits[index]\n",
+    "    label = y_test[index]\n",
     "    predictedDict = json.loads(predicted)\n",
     "    title = \"Label value = %d  Predicted value = %s \" % ( label,predictedDict['result'][0])\n",
-    "    fig = plt.figure(1, figsize=(3,3))\n",
+    "    fig = plt.figure(1, figsize = (3,3))\n",
     "    ax1 = fig.add_axes((0,0,.8,.8))\n",
     "    ax1.set_title(title)\n",
-    "    plt.imshow(images[index], cmap=plt.cm.gray_r, interpolation='nearest')\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
     "    plt.show()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/classification/auto-ml-classification.ipynb

@@ -0,0 +1,414 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Classification with Local Compute\n",
+    "\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use AutoML for a simple classification problem.\n",
+    "\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
+    "\n",
+    "In this notebook you will learn how to:\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Configure AutoML using `AutoMLConfig`.\n",
+    "3. Train the model using local compute.\n",
+    "4. Explore the results.\n",
+    "5. Test the best fitted model.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an Experiment\n",
+    "\n",
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import os\n",
+    "import random\n",
+    "\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "import numpy as np\n",
+    "import pandas as pd\n",
+    "from sklearn import datasets\n",
+    "\n",
+    "import azureml.core\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "\n",
+    "# Choose a name for the experiment and specify the project folder.\n",
+    "experiment_name = 'automl-local-classification'\n",
+    "project_folder = './sample_projects/automl-local-classification'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace Name'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Experiment Name'] = experiment.name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data = output, index = ['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "set_diagnostics_collection(send_diagnostics = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Load Training Data\n",
+    "\n",
+    "This uses scikit-learn's [load_digits](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) method."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from sklearn import datasets\n",
+    "\n",
+    "digits = datasets.load_digits()\n",
+    "\n",
+    "# Exclude the first 100 rows from training so that they can be used for test.\n",
+    "X_train = digits.data[100:,:]\n",
+    "y_train = digits.target[100:]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure AutoML\n",
+    "\n",
+    "Instantiate an `AutoMLConfig` object to specify the settings and data used to run the experiment.\n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**task**|classification or regression|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. This should be an array of integers.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_config = AutoMLConfig(task = 'classification',\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             primary_metric = 'AUC_weighted',\n",
+    "                             iteration_timeout_minutes = 60,\n",
+    "                             iterations = 25,\n",
+    "                             n_cross_validations = 3,\n",
+    "                             verbosity = logging.INFO,\n",
+    "                             X = X_train, \n",
+    "                             y = y_train,\n",
+    "                             path = project_folder)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Optionally, you can continue an interrupted local run by calling `continue_experiment` without the `iterations` parameter, or run more iterations for a completed run by specifying the `iterations` parameter:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = local_run.continue_experiment(X = X_train, \n",
+    "                                          y = y_train, \n",
+    "                                          show_output = True,\n",
+    "                                          iterations = 5)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explore the Results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Widget for Monitoring Runs\n",
+    "\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
+    "\n",
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(local_run).show() "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\n",
+    "#### Retrieve All Child Runs\n",
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "children = list(local_run.get_children())\n",
+    "metricslist = {}\n",
+    "for run in children:\n",
+    "    properties = run.get_properties()\n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
+    "    metricslist[int(properties['iteration'])] = metrics\n",
+    "\n",
+    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
+    "rundata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "\n",
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = local_run.get_output()\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model that has the smallest `log_loss` value:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "lookup_metric = \"log_loss\"\n",
+    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "iteration = 3\n",
+    "third_run, third_model = local_run.get_output(iteration = iteration)\n",
+    "print(third_run)\n",
+    "print(third_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Test the Best Fitted Model\n",
+    "\n",
+    "#### Load Test Data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "digits = datasets.load_digits()\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
+    "images = digits.images[:10]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Testing Our Best Fitted Model\n",
+    "We will try to predict 2 digits and see how our model works."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Randomly select digits and test.\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
+    "    print(index)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
+    "    fig = plt.figure(1, figsize = (3,3))\n",
+    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
+    "    ax1.set_title(title)\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
+    "    plt.show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/classification_with_tensorflow/auto-ml-classification_with_tensorflow.ipynb

@@ -0,0 +1,390 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Classification with Local Compute with Tensorflow DNNClassifier and LinearClassifier using whitelist models\n",
+    "\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use AutoML for a simple classification problem.\n",
+    "\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
+    "This notebooks shows how can automl can be trained on a a selected list of models,see the readme.md for the models.\n",
+    "This trains the model exclusively on tensorflow based models.\n",
+    "\n",
+    "In this notebook you will learn how to:\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Configure AutoML using `AutoMLConfig`.\n",
+    "3. Train the model on a whilelisted models using local compute. \n",
+    "4. Explore the results.\n",
+    "5. Test the best fitted model.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an Experiment\n",
+    "\n",
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import os\n",
+    "import random\n",
+    "\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "import numpy as np\n",
+    "import pandas as pd\n",
+    "from sklearn import datasets\n",
+    "\n",
+    "import azureml.core\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "\n",
+    "# Choose a name for the experiment and specify the project folder.\n",
+    "experiment_name = 'automl-local-classification'\n",
+    "project_folder = './sample_projects/automl-local-classification'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace Name'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Experiment Name'] = experiment.name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data = output, index = ['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "set_diagnostics_collection(send_diagnostics = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Load Training Data\n",
+    "\n",
+    "This uses scikit-learn's [load_digits](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) method."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from sklearn import datasets\n",
+    "\n",
+    "digits = datasets.load_digits()\n",
+    "\n",
+    "# Exclude the first 100 rows from training so that they can be used for test.\n",
+    "X_train = digits.data[100:,:]\n",
+    "y_train = digits.target[100:]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure AutoML\n",
+    "\n",
+    "Instantiate an `AutoMLConfig` object to specify the settings and data used to run the experiment.\n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**task**|classification or regression|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. This should be an array of integers.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_config = AutoMLConfig(task = 'classification',\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             primary_metric = 'AUC_weighted',\n",
+    "                             iteration_timeout_minutes = 60,\n",
+    "                             iterations = 10,\n",
+    "                             n_cross_validations = 3,\n",
+    "                             verbosity = logging.INFO,\n",
+    "                             X = X_train, \n",
+    "                             y = y_train,\n",
+    "                             enable_tf=True,\n",
+    "                             whitelist_models=[\"TensorFlowLinearClassifier\", \"TensorFlowDNN\"],\n",
+    "                             path = project_folder)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explore the Results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Widget for Monitoring Runs\n",
+    "\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
+    "\n",
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(local_run).show() "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\n",
+    "#### Retrieve All Child Runs\n",
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "children = list(local_run.get_children())\n",
+    "metricslist = {}\n",
+    "for run in children:\n",
+    "    properties = run.get_properties()\n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
+    "    metricslist[int(properties['iteration'])] = metrics\n",
+    "\n",
+    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
+    "rundata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "\n",
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = local_run.get_output()\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model that has the smallest `log_loss` value:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "lookup_metric = \"log_loss\"\n",
+    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "iteration = 3\n",
+    "third_run, third_model = local_run.get_output(iteration = iteration)\n",
+    "print(third_run)\n",
+    "print(third_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Test the Best Fitted Model\n",
+    "\n",
+    "#### Load Test Data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "digits = datasets.load_digits()\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
+    "images = digits.images[:10]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Testing Our Best Fitted Model\n",
+    "We will try to predict 2 digits and see how our model works."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Randomly select digits and test.\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
+    "    print(index)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
+    "    fig = plt.figure(1, figsize = (3,3))\n",
+    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
+    "    ax1.set_title(title)\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
+    "    plt.show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/configuration.ipynb

@@ -0,0 +1,154 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning Configuration\n",
+    "\n",
+    "In this example you will create an Azure Machine Learning `Workspace` object and initialize your notebook directory to easily reload this object from a configuration file.  Typically you will only need to run this once per notebook directory, and all other notebooks in this directory or any sub-directories will automatically use the settings you indicate here.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Check the Azure ML Core SDK Version to Validate Your Installation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "\n",
+    "print(\"SDK Version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize an Azure ML Workspace\n",
+    "### What is an Azure ML Workspace and Why Do I Need One?\n",
+    "\n",
+    "An Azure ML workspace is an Azure resource that organizes and coordinates the actions of many other Azure resources to assist in executing and sharing machine learning workflows.  In particular, an Azure ML workspace coordinates storage, databases, and compute resources providing added functionality for machine learning experimentation, operationalization, and the monitoring of operationalized models.\n",
+    "\n",
+    "\n",
+    "### What do I Need?\n",
+    "\n",
+    "To create or access an Azure ML workspace, you will need to import the Azure ML library and specify following information:\n",
+    "* A name for your workspace. You can choose one.\n",
+    "* Your subscription id. Use the `id` value from the `az account show` command output above.\n",
+    "* The resource group name. The resource group organizes Azure resources and provides a default region for the resources in the group. The resource group will be created if it doesn't exist. Resource groups can be created and viewed in the [Azure portal](https://portal.azure.com)\n",
+    "* Supported regions include `eastus2`, `eastus`,`westcentralus`, `southeastasia`, `westeurope`, `australiaeast`, `westus2`, `southcentralus`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "subscription_id = \"<subscription_id>\"\n",
+    "resource_group = \"myrg\"\n",
+    "workspace_name = \"myws\"\n",
+    "workspace_region = \"eastus2\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Creating a Workspace\n",
+    "If you already have access to an Azure ML workspace you want to use, you can skip this cell.  Otherwise, this cell will create an Azure ML workspace for you in the specified subscription, provided you have the correct permissions for the given `subscription_id`.\n",
+    "\n",
+    "This will fail when:\n",
+    "1. The workspace already exists.\n",
+    "2. You do not have permission to create a workspace in the resource group.\n",
+    "3. You are not a subscription owner or contributor and no Azure ML workspaces have ever been created in this subscription.\n",
+    "\n",
+    "If workspace creation fails for any reason other than already existing, please work with your IT administrator to provide you with the appropriate permissions or to provision the required resources.\n",
+    "\n",
+    "**Note:** Creation of a new workspace can take several minutes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import the Workspace class and check the Azure ML SDK version.\n",
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace.create(name = workspace_name,\n",
+    "                      subscription_id = subscription_id,\n",
+    "                      resource_group = resource_group, \n",
+    "                      location = workspace_region)\n",
+    "ws.get_details()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configuring Your Local Environment\n",
+    "You can validate that you have access to the specified workspace and write a configuration file to the default configuration location, `./aml_config/config.json`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace(workspace_name = workspace_name,\n",
+    "               subscription_id = subscription_id,\n",
+    "               resource_group = resource_group)\n",
+    "\n",
+    "# Persist the subscription id, resource group name, and workspace name in aml_config/config.json.\n",
+    "ws.write_config()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/dataprep-remote-execution/auto-ml-dataprep-remote-execution.ipynb

@@ -13,41 +13,24 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 13: Prepare Data using `azureml.dataprep`\n",
-    "In this example we showcase how you can use `azureml.dataprep` SDK to load and prepare data for AutoML. `azureml.dataprep` can also be used standalone - full documentation can be found [here](https://github.com/Microsoft/PendletonDocs).\n",
+    "# Automated Machine Learning: Prepare Data using `azureml.dataprep` for Remote Execution (DSVM)\n",
+    "In this example we showcase how you can use the `azureml.dataprep` SDK to load and prepare data for AutoML. `azureml.dataprep` can also be used standalone; full documentation can be found [here](https://github.com/Microsoft/PendletonDocs).\n",
     "\n",
-    "Make sure you have executed the [setup](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
-    "In this notebook you would see\n",
-    "1. Defining data loading and preparation steps in a `Dataflow` using `azureml.dataprep`\n",
-    "2. Passing the `Dataflow` to AutoML for local run\n",
-    "3. Passing the `Dataflow` to AutoML for remote run"
+    "In this notebook you will learn how to:\n",
+    "1. Define data loading and preparation steps in a `Dataflow` using `azureml.dataprep`.\n",
+    "2. Pass the `Dataflow` to AutoML for a local run.\n",
+    "3. Pass the `Dataflow` to AutoML for a remote run."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Install `azureml.dataprep` SDK"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Please restart your kernel after the below installs.\n",
+    "# Compatibility\n",
     "\n",
-    "Tornado must be downgraded to a pre-5 version due to a known Tornado x Jupyter event loop bug."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install azureml-dataprep\n",
-    "!pip install tornado==4.5.1"
+    "Currently, Data Prep only supports __Ubuntu 16__ and __Red Hat Enterprise Linux 7__. We are working on supporting more linux distros."
    ]
   },
   {
@@ -73,9 +56,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create Experiment\n",
+    "## Create an Experiment\n",
     "\n",
-    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
    ]
   },
   {
@@ -86,14 +69,13 @@
    "source": [
     "import logging\n",
     "import os\n",
+    "import time\n",
     "\n",
     "import pandas as pd\n",
     "\n",
     "import azureml.core\n",
     "from azureml.core.compute import DsvmCompute\n",
     "from azureml.core.experiment import Experiment\n",
-    "from azureml.core.runconfig import CondaDependencies\n",
-    "from azureml.core.runconfig import RunConfiguration\n",
     "from azureml.core.workspace import Workspace\n",
     "import azureml.dataprep as dprep\n",
     "from azureml.train.automl import AutoMLConfig"
@@ -108,9 +90,9 @@
     "ws = Workspace.from_config()\n",
     " \n",
     "# choose a name for experiment\n",
-    "experiment_name = 'automl-dataprep-classification'\n",
+    "experiment_name = 'automl-dataprep-remote-dsvm'\n",
     "# project folder\n",
-    "project_folder = './sample_projects/automl-dataprep-classification'\n",
+    "project_folder = './sample_projects/automl-dataprep-remote-dsvm'\n",
     " \n",
     "experiment = Experiment(ws, experiment_name)\n",
     " \n",
@@ -139,12 +121,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# You can use `smart_read_file` which intelligently figures out delimiters and datatypes of a file\n",
-    "# data pulled from sklearn.datasets.load_digits()\n",
+    "# You can use `auto_read_file` which intelligently figures out delimiters and datatypes of a file.\n",
+    "# The data referenced here was pulled from `sklearn.datasets.load_digits()`.\n",
     "simple_example_data_root = 'https://dprepdata.blob.core.windows.net/automl-notebook-data/'\n",
-    "X = dprep.smart_read_file(simple_example_data_root + 'X.csv').skip(1)  # remove header\n",
+    "X = dprep.auto_read_file(simple_example_data_root + 'X.csv').skip(1)  # Remove the header row.\n",
     "\n",
-    "# You can also use `read_csv` and `to_*` transformations to read (with overridable delimiter).\n",
+    "# You can also use `read_csv` and `to_*` transformations to read (with overridable delimiter)\n",
     "# and convert column types manually.\n",
     "# Here we read a comma delimited file and convert all columns to integers.\n",
     "y = dprep.read_csv(simple_example_data_root + 'y.csv').to_long(dprep.ColumnSelector(term='.*', use_regex = True))"
@@ -156,7 +138,7 @@
    "source": [
     "## Review the Data Preparation Result\n",
     "\n",
-    "You can peek the result of a Dataflow at any range using `skip(i)` and `head(j)`. Doing so evaluates only `j` records for all the steps in the Dataflow, which makes it fast even against large dataset."
+    "You can peek the result of a Dataflow at any range using `skip(i)` and `head(j)`. Doing so evaluates only `j` records for all the steps in the Dataflow, which makes it fast even against large datasets."
    ]
   },
   {
@@ -172,9 +154,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Instantiate AutoML Settings\n",
+    "## Configure AutoML\n",
     "\n",
-    "This creates a general Auto ML Settings applicable for both Local and Remote runs."
+    "This creates a general AutoML settings object applicable for both local and remote runs."
    ]
   },
   {
@@ -184,12 +166,12 @@
    "outputs": [],
    "source": [
     "automl_settings = {\n",
-    "    \"max_time_sec\": 600,\n",
-    "    \"iterations\": 2,\n",
-    "    \"primary_metric\": 'AUC_weighted',\n",
-    "    \"preprocess\": False,\n",
-    "    \"verbosity\": logging.INFO,\n",
-    "    \"n_cross_validations\" : 3\n",
+    "    \"iteration_timeout_minutes\" : 10,\n",
+    "    \"iterations\" : 2,\n",
+    "    \"primary_metric\" : 'AUC_weighted',\n",
+    "    \"preprocess\" : False,\n",
+    "    \"verbosity\" : logging.INFO,\n",
+    "    \"n_cross_validations\": 3\n",
     "}"
    ]
   },
@@ -197,46 +179,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Local Run"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Pass data with Dataflows\n",
-    "\n",
-    "The `Dataflow` objects captured above can be passed to `submit` method for local run. AutoML will retrieve the results from the `Dataflow` for model training."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "automl_config = AutoMLConfig(task = 'classification',\n",
-    "                             debug_log = 'automl_errors.log',\n",
-    "                             X = X,\n",
-    "                             y = y,\n",
-    "                             **automl_settings)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "local_run = experiment.submit(automl_config, show_output=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Remote Run\n",
-    "*Note: This feature might not work properly in your workspace region before the October update. You may jump to the \"Exploring the results\" section below to explore other features AutoML and DataPrep has to offer.*"
+    "## Remote Run"
    ]
   },
   {
@@ -252,24 +195,21 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dsvm_name = 'mydsvm'\n",
+    "dsvm_name = 'mydsvmc'\n",
+    "\n",
     "try:\n",
+    "    while ws.compute_targets[dsvm_name].provisioning_state == 'Creating':\n",
+    "        time.sleep(1)\n",
+    "        \n",
     "    dsvm_compute = DsvmCompute(ws, dsvm_name)\n",
-    "    print('found existing dsvm.')\n",
+    "    print('Found existing DVSM.')\n",
     "except:\n",
-    "    print('creating new dsvm.')\n",
+    "    print('Creating a new DSVM.')\n",
     "    dsvm_config = DsvmCompute.provisioning_configuration(vm_size = \"Standard_D2_v2\")\n",
     "    dsvm_compute = DsvmCompute.create(ws, name = dsvm_name, provisioning_configuration = dsvm_config)\n",
-    "    dsvm_compute.wait_for_completion(show_output = True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Update Conda Dependency file to have AutoML and DataPrep SDK\n",
-    "\n",
-    "Currently AutoML and DataPrep SDK is not installed with Azure ML SDK by default. Due to this we update the conda dependency file to add such dependencies."
+    "    dsvm_compute.wait_for_completion(show_output = True)\n",
+    "    print(\"Waiting one minute for ssh to be accessible\")\n",
+    "    time.sleep(60) # Wait for ssh to be accessible"
    ]
   },
   {
@@ -278,36 +218,24 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "cd = CondaDependencies()\n",
-    "cd.add_pip_package(pip_package='azureml-dataprep')\n",
-    "cd.add_pip_package(pip_package='tornado==4.5.1')"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Create a RunConfiguration with DSVM name"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "run_config = RunConfiguration(conda_dependencies=cd)\n",
-    "run_config.target = dsvm_compute\n",
-    "run_config.auto_prepare_environment = True"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Pass data with Dataflows\n",
+    "from azureml.core.runconfig import RunConfiguration\n",
+    "from azureml.core.conda_dependencies import CondaDependencies\n",
     "\n",
-    "The `Dataflow` objects captured above can also be passed to `submit` method for remote run. AutoML will serialize the `Dataflow` and send to remote compute target. The `Dataflow` will not be evaluated locally."
+    "conda_run_config = RunConfiguration(framework=\"python\")\n",
+    "\n",
+    "conda_run_config.target = dsvm_compute\n",
+    "\n",
+    "cd = CondaDependencies.create(pip_packages=['azureml-sdk[automl]'], conda_packages=['numpy'])\n",
+    "conda_run_config.environment.python.conda_dependencies = cd"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Pass Data with `Dataflow` Objects\n",
+    "\n",
+    "The `Dataflow` objects captured above can also be passed to the `submit` method for a remote run. AutoML will serialize the `Dataflow` object and send it to the remote compute target. The `Dataflow` will not be evaluated locally."
    ]
   },
   {
@@ -319,31 +247,10 @@
     "automl_config = AutoMLConfig(task = 'classification',\n",
     "                             debug_log = 'automl_errors.log',\n",
     "                             path = project_folder,\n",
-    "                             run_configuration = run_config,\n",
+    "                             run_configuration=conda_run_config,\n",
     "                             X = X,\n",
     "                             y = y,\n",
-    "                             **automl_settings)\n",
-    "# Please uncomment the line below to try out remote run with dataprep. \n",
-    "# This feature might not work properly in your workspace region before the October update.\n",
-    "# remote_run = experiment.submit(automl_config, show_output = True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Exploring the results"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Widget for monitoring runs\n",
-    "\n",
-    "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
-    "\n",
-    "NOTE: The widget displays a link at the bottom. This links to a web-ui to explore the individual run details."
+    "                             **automl_settings)"
    ]
   },
   {
@@ -352,15 +259,42 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
-    "RunDetails(local_run).show() "
+    "remote_run = experiment.submit(automl_config, show_output = True)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Retrieve all child runs\n",
+    "## Explore the Results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Widget for Monitoring Runs\n",
+    "\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
+    "\n",
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(remote_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Retrieve All Child Runs\n",
     "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
    ]
   },
@@ -370,7 +304,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "children = list(local_run.get_children())\n",
+    "children = list(remote_run.get_children())\n",
     "metricslist = {}\n",
     "for run in children:\n",
     "    properties = run.get_properties()\n",
@@ -388,7 +322,7 @@
    "source": [
     "### Retrieve the Best Model\n",
     "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
    ]
   },
   {
@@ -397,7 +331,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "best_run, fitted_model = local_run.get_output()\n",
+    "best_run, fitted_model = remote_run.get_output()\n",
     "print(best_run)\n",
     "print(fitted_model)"
    ]
@@ -406,8 +340,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Best Model based on any other metric\n",
-    "Give me the run and the model that has the smallest `log_loss`:"
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model that has the smallest `log_loss` value:"
    ]
   },
   {
@@ -417,7 +351,7 @@
    "outputs": [],
    "source": [
     "lookup_metric = \"log_loss\"\n",
-    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
+    "best_run, fitted_model = remote_run.get_output(metric = lookup_metric)\n",
     "print(best_run)\n",
     "print(fitted_model)"
    ]
@@ -426,8 +360,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Best Model based on any iteration\n",
-    "Give me the run and the model from the 1st iteration:"
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the first iteration:"
    ]
   },
   {
@@ -437,7 +371,7 @@
    "outputs": [],
    "source": [
     "iteration = 0\n",
-    "best_run, fitted_model = local_run.get_output(iteration = iteration)\n",
+    "best_run, fitted_model = remote_run.get_output(iteration = iteration)\n",
     "print(best_run)\n",
     "print(fitted_model)"
    ]
@@ -446,7 +380,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Testing the Fitted Model \n",
+    "### Test the Best Fitted Model\n",
     "\n",
     "#### Load Test Data"
    ]
@@ -460,8 +394,8 @@
     "from sklearn import datasets\n",
     "\n",
     "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[:10, :]\n",
-    "y_digits = digits.target[:10]\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
     "images = digits.images[:10]"
    ]
   },
@@ -469,7 +403,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Testing our best pipeline\n",
+    "#### Testing Our Best Fitted Model\n",
     "We will try to predict 2 digits and see how our model works."
    ]
   },
@@ -485,15 +419,15 @@
     "import random\n",
     "import numpy as np\n",
     "\n",
-    "for index in np.random.choice(len(y_digits), 2):\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
     "    print(index)\n",
-    "    predicted = fitted_model.predict(X_digits[index:index + 1])[0]\n",
-    "    label = y_digits[index]\n",
-    "    title = \"Label value = %d  Predicted value = %d \" % ( label,predicted)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
     "    fig = plt.figure(1, figsize=(3,3))\n",
     "    ax1 = fig.add_axes((0,0,.8,.8))\n",
     "    ax1.set_title(title)\n",
-    "    plt.imshow(images[index], cmap=plt.cm.gray_r, interpolation='nearest')\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
     "    plt.show()"
    ]
   },
@@ -508,9 +442,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Capture the Dataflows to use for AutoML later\n",
+    "### Capture the `Dataflow` Objects for Later Use in AutoML\n",
     "\n",
-    "`Dataflow` objects are immutable. Each of them is composed of a list of data preparation steps. A `Dataflow` can be branched at any point for further usage."
+    "`Dataflow` objects are immutable and are composed of a list of data preparation steps. A `Dataflow` object can be branched at any point for further usage."
    ]
   },
   {
@@ -520,14 +454,14 @@
    "outputs": [],
    "source": [
     "# sklearn.digits.data + target\n",
-    "digits_complete = dprep.smart_read_file('https://dprepdata.blob.core.windows.net/automl-notebook-data/digits-complete.csv')"
+    "digits_complete = dprep.auto_read_file('https://dprepdata.blob.core.windows.net/automl-notebook-data/digits-complete.csv')"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "`digits_complete` (sourced from `sklearn.datasets.load_digits()`)is forked into `dflow_X` to capture all the feature columns and `dflow_y` to capture the label column."
+    "`digits_complete` (sourced from `sklearn.datasets.load_digits()`) is forked into `dflow_X` to capture all the feature columns and `dflow_y` to capture the label column."
    ]
   },
   {
@@ -544,6 +478,11 @@
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/dataprep/auto-ml-dataprep.ipynb

@@ -0,0 +1,455 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Prepare Data using `azureml.dataprep` for Local Execution\n",
+    "In this example we showcase how you can use the `azureml.dataprep` SDK to load and prepare data for AutoML. `azureml.dataprep` can also be used standalone; full documentation can be found [here](https://github.com/Microsoft/PendletonDocs).\n",
+    "\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
+    "\n",
+    "In this notebook you will learn how to:\n",
+    "1. Define data loading and preparation steps in a `Dataflow` using `azureml.dataprep`.\n",
+    "2. Pass the `Dataflow` to AutoML for a local run.\n",
+    "3. Pass the `Dataflow` to AutoML for a remote run."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Compatibility\n",
+    "\n",
+    "Currently, Data Prep only supports __Ubuntu 16__ and __Red Hat Enterprise Linux 7__. We are working on supporting more linux distros."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "set_diagnostics_collection(send_diagnostics = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an Experiment\n",
+    "\n",
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import os\n",
+    "\n",
+    "import pandas as pd\n",
+    "\n",
+    "import azureml.core\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.core.workspace import Workspace\n",
+    "import azureml.dataprep as dprep\n",
+    "from azureml.train.automl import AutoMLConfig"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    " \n",
+    "# choose a name for experiment\n",
+    "experiment_name = 'automl-dataprep-local'\n",
+    "# project folder\n",
+    "project_folder = './sample_projects/automl-dataprep-local'\n",
+    " \n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    " \n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace Name'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Experiment Name'] = experiment.name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data = output, index = ['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Loading Data using DataPrep"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# You can use `auto_read_file` which intelligently figures out delimiters and datatypes of a file.\n",
+    "# The data referenced here was pulled from `sklearn.datasets.load_digits()`.\n",
+    "simple_example_data_root = 'https://dprepdata.blob.core.windows.net/automl-notebook-data/'\n",
+    "X = dprep.auto_read_file(simple_example_data_root + 'X.csv').skip(1)  # Remove the header row.\n",
+    "\n",
+    "# You can also use `read_csv` and `to_*` transformations to read (with overridable delimiter)\n",
+    "# and convert column types manually.\n",
+    "# Here we read a comma delimited file and convert all columns to integers.\n",
+    "y = dprep.read_csv(simple_example_data_root + 'y.csv').to_long(dprep.ColumnSelector(term='.*', use_regex = True))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Review the Data Preparation Result\n",
+    "\n",
+    "You can peek the result of a Dataflow at any range using `skip(i)` and `head(j)`. Doing so evaluates only `j` records for all the steps in the Dataflow, which makes it fast even against large datasets."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "X.skip(1).head(5)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure AutoML\n",
+    "\n",
+    "This creates a general AutoML settings object applicable for both local and remote runs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_settings = {\n",
+    "    \"iteration_timeout_minutes\" : 10,\n",
+    "    \"iterations\" : 2,\n",
+    "    \"primary_metric\" : 'AUC_weighted',\n",
+    "    \"preprocess\" : False,\n",
+    "    \"verbosity\" : logging.INFO,\n",
+    "    \"n_cross_validations\": 3\n",
+    "}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Local Run"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Pass Data with `Dataflow` Objects\n",
+    "\n",
+    "The `Dataflow` objects captured above can be passed to the `submit` method for a local run. AutoML will retrieve the results from the `Dataflow` for model training."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_config = AutoMLConfig(task = 'classification',\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             X = X,\n",
+    "                             y = y,\n",
+    "                             **automl_settings)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explore the Results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Widget for Monitoring Runs\n",
+    "\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
+    "\n",
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(local_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Retrieve All Child Runs\n",
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "children = list(local_run.get_children())\n",
+    "metricslist = {}\n",
+    "for run in children:\n",
+    "    properties = run.get_properties()\n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
+    "    metricslist[int(properties['iteration'])] = metrics\n",
+    "    \n",
+    "import pandas as pd\n",
+    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
+    "rundata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "\n",
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = local_run.get_output()\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model that has the smallest `log_loss` value:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "lookup_metric = \"log_loss\"\n",
+    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the first iteration:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "iteration = 0\n",
+    "best_run, fitted_model = local_run.get_output(iteration = iteration)\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Test the Best Fitted Model\n",
+    "\n",
+    "#### Load Test Data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from sklearn import datasets\n",
+    "\n",
+    "digits = datasets.load_digits()\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
+    "images = digits.images[:10]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Testing Our Best Fitted Model\n",
+    "We will try to predict 2 digits and see how our model works."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#Randomly select digits and test\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "import random\n",
+    "import numpy as np\n",
+    "\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
+    "    print(index)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
+    "    fig = plt.figure(1, figsize=(3,3))\n",
+    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
+    "    ax1.set_title(title)\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
+    "    plt.show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Appendix"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Capture the `Dataflow` Objects for Later Use in AutoML\n",
+    "\n",
+    "`Dataflow` objects are immutable and are composed of a list of data preparation steps. A `Dataflow` object can be branched at any point for further usage."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# sklearn.digits.data + target\n",
+    "digits_complete = dprep.auto_read_file('https://dprepdata.blob.core.windows.net/automl-notebook-data/digits-complete.csv')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "`digits_complete` (sourced from `sklearn.datasets.load_digits()`) is forked into `dflow_X` to capture all the feature columns and `dflow_y` to capture the label column."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "digits_complete.to_pandas_dataframe().shape\n",
+    "labels_column = 'Column64'\n",
+    "dflow_X = digits_complete.drop_columns(columns = [labels_column])\n",
+    "dflow_y = digits_complete.keep_columns(columns = [labels_column])"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/exploring-previous-runs/auto-ml-exploring-previous-runs.ipynb

@@ -13,17 +13,17 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 07: Exploring previous runs\n",
+    "# Automated Machine Learning: Exploring Previous Runs\n",
     "\n",
     "In this example we present some examples on navigating previously executed runs. We also show how you can download a fitted model for any previous run.\n",
     "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
-    "In this notebook you would see\n",
-    "1. List all Experiments for the workspace\n",
-    "2. List AutoML runs for an Experiment\n",
-    "3. Get details for a AutoML Run. (Automl settings, run widget & all metrics)\n",
-    "4. Download fitted pipeline for any iteration\n"
+    "In this notebook you will learn how to:\n",
+    "1. List all experiments in a workspace.\n",
+    "2. List all AutoML runs in an experiment.\n",
+    "3. Get details for an AutoML run, including settings, run widget, and all metrics.\n",
+    "4. Download a fitted pipeline for any iteration.\n"
    ]
   },
   {
@@ -87,7 +87,7 @@
    "source": [
     "## Diagnostics\n",
     "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
    ]
   },
   {
@@ -97,15 +97,15 @@
    "outputs": [],
    "source": [
     "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
+    "set_diagnostics_collection(send_diagnostics = True)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# List AutoML runs for an Experiment\n",
-    "You can set <i>Experiment</i> name with any experiment name from the result of the Experiment.list cell to load the AutoML runs."
+    "# List AutoML runs for an experiment\n",
+    "Set `experiment_name` to any experiment name from the result of the Experiment.list cell to load the AutoML runs."
    ]
   },
   {
@@ -114,12 +114,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "experiment_name = 'automl-local-classification' # Replace this with any project name from previous cell\n",
+    "experiment_name = 'automl-local-classification' # Replace this with any project name from previous cell.\n",
     "\n",
-    "proj = ws.experiments()[experiment_name]\n",
+    "proj = ws.experiments[experiment_name]\n",
     "summary_df = pd.DataFrame(index = ['Type', 'Status', 'Primary Metric', 'Iterations', 'Compute', 'Name'])\n",
     "pattern = re.compile('^AutoML_[^_]*$')\n",
     "all_runs = list(proj.get_runs(properties={'azureml.runsource': 'automl'}))\n",
+    "automl_runs_project = []\n",
     "for run in all_runs:\n",
     "    if(pattern.match(run.id)):\n",
     "        properties = run.get_properties()\n",
@@ -130,6 +131,8 @@
     "        else:\n",
     "            iterations = properties['num_iterations']\n",
     "        summary_df[run.id] = [amlsettings['task_type'], run.get_details()['status'], properties['primary_metric'], iterations, properties['target'], amlsettings['name']]\n",
+    "        if run.get_details()['status'] == 'Completed':\n",
+    "            automl_runs_project.append(run.id)\n",
     "    \n",
     "from IPython.display import HTML\n",
     "projname_html = HTML(\"<h3>{}</h3>\".format(proj.name))\n",
@@ -143,7 +146,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Get Details for a Auto ML Run\n",
+    "# Get details for an AutoML run\n",
     "\n",
     "Copy the project name and run id from the previous cell output to find more details on a particular run."
    ]
@@ -154,12 +157,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "run_id = '' # Filling your own run_id\n",
+    "run_id = automl_runs_project[0]  # Replace with your own run_id from above run ids\n",
+    "assert (run_id in summary_df.keys()), \"Run id not found! Please set run id to a value from above run ids\"\n",
     "\n",
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
     "\n",
     "experiment = Experiment(ws, experiment_name)\n",
-    "ml_run = AutoMLRun(experiment=experiment, run_id=run_id)\n",
+    "ml_run = AutoMLRun(experiment = experiment, run_id = run_id)\n",
     "\n",
     "summary_df = pd.DataFrame(index = ['Type', 'Status', 'Primary Metric', 'Iterations', 'Compute', 'Name', 'Start Time', 'End Time'])\n",
     "properties = ml_run.get_properties()\n",
@@ -180,7 +184,7 @@
     "display(HTML('<h3>Runtime Details</h3>'))\n",
     "display(summary_df)\n",
     "\n",
-    "#settings_df = pd.DataFrame(data=amlsettings, index=[''])\n",
+    "#settings_df = pd.DataFrame(data = amlsettings, index = [''])\n",
     "display(HTML('<h3>AutoML Settings</h3>'))\n",
     "display(amlsettings)\n",
     "\n",
@@ -191,7 +195,7 @@
     "metricslist = {}\n",
     "for run in children:\n",
     "    properties = run.get_properties()\n",
-    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
     "    metricslist[int(properties['iteration'])] = metrics\n",
     "\n",
     "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
@@ -210,7 +214,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Download best model for any given metric"
+    "## Download the Best Model for Any Given Metric"
    ]
   },
   {
@@ -219,8 +223,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "metric = 'AUC_weighted' # Replace with a metric name\n",
-    "best_run, fitted_model = ml_run.get_output(metric=metric)\n",
+    "metric = 'AUC_weighted' # Replace with a metric name.\n",
+    "best_run, fitted_model = ml_run.get_output(metric = metric)\n",
     "fitted_model"
    ]
   },
@@ -228,7 +232,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Download model for any given iteration"
+    "## Download the Model for Any Given Iteration"
    ]
   },
   {
@@ -237,8 +241,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "iteration = 4 # Replace with an interation number\n",
-    "best_run, fitted_model = ml_run.get_output(iteration=iteration)\n",
+    "iteration = 1 # Replace with an iteration number.\n",
+    "best_run, fitted_model = ml_run.get_output(iteration = iteration)\n",
     "fitted_model"
    ]
   },
@@ -246,7 +250,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Register fitted model for deployment"
+    "# Register fitted model for deployment\n",
+    "If neither `metric` nor `iteration` are specified in the `register_model` call, the iteration with the best primary metric is registered."
    ]
   },
   {
@@ -257,15 +262,15 @@
    "source": [
     "description = 'AutoML Model'\n",
     "tags = None\n",
-    "ml_run.register_model(description=description, tags=tags)\n",
-    "ml_run.model_id # Use this id to deploy the model as a web service in Azure"
+    "ml_run.register_model(description = description, tags = tags)\n",
+    "ml_run.model_id # Use this id to deploy the model as a web service in Azure."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Register best model for any given metric"
+    "## Register the Best Model for Any Given Metric"
    ]
   },
   {
@@ -274,18 +279,18 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "metric = 'AUC_weighted' # Replace with a metric name\n",
+    "metric = 'AUC_weighted' # Replace with a metric name.\n",
     "description = 'AutoML Model'\n",
     "tags = None\n",
-    "ml_run.register_model(description=description, tags=tags, metric=metric)\n",
-    "ml_run.model_id # Use this id to deploy the model as a web service in Azure"
+    "ml_run.register_model(description = description, tags = tags, metric = metric)\n",
+    "print(ml_run.model_id) # Use this id to deploy the model as a web service in Azure."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Register model for any given iteration"
+    "## Register the Model for Any Given Iteration"
    ]
   },
   {
@@ -294,15 +299,20 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "iteration = 4 # Replace with an interation number\n",
+    "iteration = 1 # Replace with an iteration number.\n",
     "description = 'AutoML Model'\n",
     "tags = None\n",
-    "ml_run.register_model(description=description, tags=tags, iteration=iteration)\n",
-    "ml_run.model_id # Use this id to deploy the model as a web service in Azure"
+    "ml_run.register_model(description = description, tags = tags, iteration = iteration)\n",
+    "print(ml_run.model_id) # Use this id to deploy the model as a web service in Azure."
    ]
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/forecasting-a/auto-ml-forecasting-a.ipynb

@@ -0,0 +1,398 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Energy Demand Forecasting\n",
+    "\n",
+    "In this example, we show how AutoML can be used for energy demand forecasting.\n",
+    "\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
+    "\n",
+    "In this notebook you would see\n",
+    "1. Creating an Experiment in an existing Workspace\n",
+    "2. Instantiating AutoMLConfig with new task type \"forecasting\" for timeseries data training, and other timeseries related settings: for this dataset we use the basic one: \"time_column_name\" \n",
+    "3. Training the Model using local compute\n",
+    "4. Exploring the results\n",
+    "5. Testing the fitted model"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create Experiment\n",
+    "\n",
+    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "import pandas as pd\n",
+    "import numpy as np\n",
+    "import os\n",
+    "import logging\n",
+    "import warnings\n",
+    "# Squash warning messages for cleaner output in the notebook\n",
+    "warnings.showwarning = lambda *args, **kwargs: None\n",
+    "\n",
+    "\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "from sklearn.metrics import mean_absolute_error, mean_squared_error, r2_score"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "\n",
+    "# choose a name for the run history container in the workspace\n",
+    "experiment_name = 'automl-energydemandforecasting'\n",
+    "# project folder\n",
+    "project_folder = './sample_projects/automl-local-energydemandforecasting'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Run History Name'] = experiment_name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data=output, index=['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Read Data\n",
+    "Read energy demanding data from file, and preview data."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "data = pd.read_csv(\"nyc_energy.csv\", parse_dates=['timeStamp'])\n",
+    "data.head()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Split the data to train and test\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "train = data[data['timeStamp'] < '2017-02-01']\n",
+    "test = data[data['timeStamp'] >= '2017-02-01']\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Prepare the test data, we will feed X_test to the fitted model and get prediction"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "y_test = test.pop('demand').values\n",
+    "X_test = test"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Split the train data to train and valid\n",
+    "\n",
+    "Use one month's data as valid data\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "X_train = train[train['timeStamp'] < '2017-01-01']\n",
+    "X_valid = train[train['timeStamp'] >= '2017-01-01']\n",
+    "y_train = X_train.pop('demand').values\n",
+    "y_valid = X_valid.pop('demand').values\n",
+    "print(X_train.shape)\n",
+    "print(y_train.shape)\n",
+    "print(X_valid.shape)\n",
+    "print(y_valid.shape)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Instantiate Auto ML Config\n",
+    "\n",
+    "Instantiate a AutoMLConfig object. This defines the settings and data used to run the experiment.\n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**task**|forecasting|\n",
+    "|**primary_metric**|This is the metric that you want to optimize.<br> Forecasting supports the following primary metrics <br><i>spearman_correlation</i><br><i>normalized_root_mean_squared_error</i><br><i>r2_score</i><br><i>normalized_mean_absolute_error</i>\n",
+    "|**iterations**|Number of iterations. In each iteration, Auto ML trains a specific pipeline on the given data|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers. |\n",
+    "|**X_valid**|Data used to evaluate a model in a iteration. (sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y_valid**|Data used to evaluate a model in a iteration. (sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers. |\n",
+    "|**path**|Relative path to the project folder.  AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "time_column_name = 'timeStamp'\n",
+    "automl_settings = {\n",
+    "    \"time_column_name\": time_column_name,\n",
+    "}\n",
+    "\n",
+    "\n",
+    "automl_config = AutoMLConfig(task = 'forecasting',\n",
+    "                             debug_log = 'automl_nyc_energy_errors.log',\n",
+    "                             primary_metric='normalized_root_mean_squared_error',\n",
+    "                             iterations = 10,\n",
+    "                             iteration_timeout_minutes = 5,\n",
+    "                             X = X_train,\n",
+    "                             y = y_train,\n",
+    "                             X_valid = X_valid,\n",
+    "                             y_valid = y_valid,\n",
+    "                             path=project_folder,\n",
+    "                             verbosity = logging.INFO,\n",
+    "                            **automl_settings)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Training the Model\n",
+    "\n",
+    "You can call the submit method on the experiment object and pass the run configuration. For Local runs the execution is synchronous. Depending on the data and number of iterations this can run for while.\n",
+    "You will see the currently running iterations printing to the console."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "Below we select the best pipeline from our iterations. The get_output method on automl_classifier returns the best run and the fitted model for the last fit invocation. There are overloads on get_output that allow you to retrieve the best run and fitted model for any logged metric or a particular iteration."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = local_run.get_output()\n",
+    "fitted_model.steps"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Test the Best Fitted Model\n",
+    "\n",
+    "Predict on training and test set, and calculate residual values."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "y_pred = fitted_model.predict(X_test)\n",
+    "y_pred"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Define a Check Data Function\n",
+    "\n",
+    "Remove the nan values from y_test to avoid error when calculate metrics "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def _check_calc_input(y_true, y_pred, rm_na=True):\n",
+    "    \"\"\"\n",
+    "    Check that 'y_true' and 'y_pred' are non-empty and\n",
+    "    have equal length.\n",
+    "\n",
+    "    :param y_true: Vector of actual values\n",
+    "    :type y_true: array-like\n",
+    "\n",
+    "    :param y_pred: Vector of predicted values\n",
+    "    :type y_pred: array-like\n",
+    "\n",
+    "    :param rm_na:\n",
+    "        If rm_na=True, remove entries where y_true=NA and y_pred=NA.\n",
+    "    :type rm_na: boolean\n",
+    "\n",
+    "    :return:\n",
+    "        Tuple (y_true, y_pred). if rm_na=True,\n",
+    "        the returned vectors may differ from their input values.\n",
+    "    :rtype: Tuple with 2 entries\n",
+    "    \"\"\"\n",
+    "    if len(y_true) != len(y_pred):\n",
+    "        raise ValueError(\n",
+    "            'the true values and prediction values do not have equal length.')\n",
+    "    elif len(y_true) == 0:\n",
+    "        raise ValueError(\n",
+    "            'y_true and y_pred are empty.')\n",
+    "    # if there is any non-numeric element in the y_true or y_pred,\n",
+    "    # the ValueError exception will be thrown.\n",
+    "    y_true = np.array(y_true).astype(float)\n",
+    "    y_pred = np.array(y_pred).astype(float)\n",
+    "    if rm_na:\n",
+    "        # remove entries both in y_true and y_pred where at least\n",
+    "        # one element in y_true or y_pred is missing\n",
+    "        y_true_rm_na = y_true[~(np.isnan(y_true) | np.isnan(y_pred))]\n",
+    "        y_pred_rm_na = y_pred[~(np.isnan(y_true) | np.isnan(y_pred))]\n",
+    "        return (y_true_rm_na, y_pred_rm_na)\n",
+    "    else:\n",
+    "        return y_true, y_pred"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Use the Check Data Function to remove the nan values from y_test to avoid error when calculate metrics "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "y_test,y_pred =  _check_calc_input(y_test,y_pred)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Calculate metrics for the prediction\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(\"[Test Data] \\nRoot Mean squared error: %.2f\" % np.sqrt(mean_squared_error(y_test, y_pred)))\n",
+    "# Explained variance score: 1 is perfect prediction\n",
+    "print('mean_absolute_error score: %.2f' % mean_absolute_error(y_test, y_pred))\n",
+    "print('R2 score: %.2f' % r2_score(y_test, y_pred))\n",
+    "\n",
+    "\n",
+    "\n",
+    "# Plot outputs\n",
+    "%matplotlib notebook\n",
+    "test_pred = plt.scatter(y_test, y_pred, color='b')\n",
+    "test_test = plt.scatter(y_test, y_test, color='g')\n",
+    "plt.legend((test_pred, test_test), ('prediction', 'truth'), loc='upper left', fontsize=8)\n",
+    "plt.show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "xiaga"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/forecasting-b/auto-ml-forecasting-b.ipynb

@@ -0,0 +1,394 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Orange Juice Sales Forecasting\n",
+    "\n",
+    "In this example, we use AutoML to find and tune a time-series forecasting model.\n",
+    "\n",
+    "Make sure you have executed the [configuration notebook](../configuration.ipynb) before running this notebook.\n",
+    "\n",
+    "In this notebook, you will:\n",
+    "1. Create an Experiment in an existing Workspace\n",
+    "2. Instantiate an AutoMLConfig \n",
+    "3. Find and train a forecasting model using local compute\n",
+    "4. Evaluate the performance of the model\n",
+    "\n",
+    "## Sample Data\n",
+    "The examples in the follow code samples use the [University of Chicago's Dominick's Finer Foods dataset](https://research.chicagobooth.edu/kilts/marketing-databases/dominicks) to forecast orange juice sales. Dominick's was a grocery chain in the Chicago metropolitan area."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create Experiment\n",
+    "\n",
+    "As part of the setup you have already created a <b>Workspace</b>. To run AutoML, you also need to create an <b>Experiment</b>. An Experiment is a named object in a Workspace which represents a predictive task, the output of which is a trained model and a set of evaluation metrics for the model. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "import pandas as pd\n",
+    "import numpy as np\n",
+    "import os\n",
+    "import logging\n",
+    "import warnings\n",
+    "# Squash warning messages for cleaner output in the notebook\n",
+    "warnings.showwarning = lambda *args, **kwargs: None\n",
+    "\n",
+    "\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun\n",
+    "from sklearn.metrics import mean_absolute_error, mean_squared_error"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "\n",
+    "# choose a name for the run history container in the workspace\n",
+    "experiment_name = 'automl-ojsalesforecasting'\n",
+    "# project folder\n",
+    "project_folder = './sample_projects/automl-local-ojsalesforecasting'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Run History Name'] = experiment_name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data=output, index=['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Read Data\n",
+    "You are now ready to load the historical orange juice sales data. We will load the CSV file into a plain pandas DataFrame; the time column in the CSV is called _WeekStarting_, so it will be specially parsed into the datetime type."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "time_column_name = 'WeekStarting'\n",
+    "data = pd.read_csv(\"dominicks_OJ.csv\", parse_dates=[time_column_name])\n",
+    "data.head()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Each row in the DataFrame holds a quantity of weekly sales for an OJ brand at a single store. The data also includes the sales price, a flag indicating if the OJ brand was advertised in the store that week, and some customer demographic information based on the store location. For historical reasons, the data also include the logarithm of the sales quantity. The Dominick's grocery data is commonly used to illustrate econometric modeling techniques where logarithms of quantities are generally preferred.    \n",
+    "\n",
+    "The task is now to build a time-series model for the _Quantity_ column. It is important to note that this dataset is comprised of many individual time-series - one for each unique combination of _Store_ and _Brand_. To distinguish the individual time-series, we thus define the **grain** - the columns whose values determine the boundaries between time-series: "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "grain_column_names = ['Store', 'Brand']\n",
+    "nseries = data.groupby(grain_column_names).ngroups\n",
+    "print('Data contains {0} individual time-series.'.format(nseries))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Data Splitting\n",
+    "For the purposes of demonstration and later forecast evaluation, we now split the data into a training and a testing set. The test set will contain the final 20 weeks of observed sales for each time-series."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ntest_periods = 20\n",
+    "\n",
+    "def split_last_n_by_grain(df, n):\n",
+    "    \"\"\"\n",
+    "    Group df by grain and split on last n rows for each group\n",
+    "    \"\"\"\n",
+    "    df_grouped = (df.sort_values(time_column_name) # Sort by ascending time\n",
+    "                  .groupby(grain_column_names, group_keys=False))\n",
+    "    df_head = df_grouped.apply(lambda dfg: dfg.iloc[:-n])\n",
+    "    df_tail = df_grouped.apply(lambda dfg: dfg.iloc[-n:])\n",
+    "    return df_head, df_tail\n",
+    "\n",
+    "X_train, X_test = split_last_n_by_grain(data, ntest_periods)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Modeling\n",
+    "\n",
+    "For forecasting tasks, AutoML uses pre-processing and estimation steps that are specific to time-series. AutoML will undertake the following pre-processing steps:\n",
+    "* Detect time-series sample frequency (e.g. hourly, daily, weekly) and create new records for absent time points to make the series regular. A regular time series has a well-defined frequency and has a value at every sample point in a contiguous time span \n",
+    "* Impute missing values in the target (via forward-fill) and feature columns (using median column values) \n",
+    "* Create grain-based features to enable fixed effects across different series\n",
+    "* Create time-based features to assist in learning seasonal patterns\n",
+    "* Encode categorical variables to numeric quantities\n",
+    "\n",
+    "AutoML will currently train a single, regression-type model across **all** time-series in a given training set. This allows the model to generalize across related series.\n",
+    "\n",
+    "You are almost ready to start an AutoML training job. We will first need to create a validation set from the existing training set (i.e. for hyper-parameter tuning): "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "nvalidation_periods = 20\n",
+    "X_train, X_validate = split_last_n_by_grain(X_train, nvalidation_periods)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We also need to separate the target column from the rest of the DataFrame: "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "target_column_name = 'Quantity'\n",
+    "y_train = X_train.pop(target_column_name).values\n",
+    "y_validate = X_validate.pop(target_column_name).values "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an AutoMLConfig\n",
+    "\n",
+    "The AutoMLConfig object defines the settings and data for an AutoML training job. Here, we set necessary inputs like the task type, the number of AutoML iterations to try, and the training and validation data. \n",
+    "\n",
+    "For forecasting tasks, there are some additional parameters that can be set: the name of the column holding the date/time and the grain column names. A time column is required for forecasting, while the grain is optional. If a grain is not given, the forecaster assumes that the whole dataset is a single time-series. We also pass a list of columns to drop prior to modeling. The _logQuantity_ column is completely correlated with the target quantity, so it must be removed to prevent a target leak. \n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**task**|forecasting|\n",
+    "|**primary_metric**|This is the metric that you want to optimize.<br> Forecasting supports the following primary metrics <br><i>spearman_correlation</i><br><i>normalized_root_mean_squared_error</i><br><i>r2_score</i><br><i>normalized_mean_absolute_error</i>\n",
+    "|**iterations**|Number of iterations. In each iteration, Auto ML trains a specific pipeline on the given data|\n",
+    "|**X**|Training matrix of features, shape = [n_training_samples, n_features]|\n",
+    "|**y**|Target values, shape = [n_training_samples, ]|\n",
+    "|**X_valid**|Validation matrix of features, shape = [n_validation_samples, n_features]|\n",
+    "|**y_valid**|Target values for validation, shape = [n_validation_samples, ]\n",
+    "|**enable_ensembling**|Allow AutoML to create ensembles of the best performing models\n",
+    "|**debug_log**|Log file path for writing debugging information\n",
+    "|**path**|Relative path to the project folder.  AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_settings = {\n",
+    "    'time_column_name': time_column_name,\n",
+    "    'grain_column_names': grain_column_names,\n",
+    "    'drop_column_names': ['logQuantity']\n",
+    "}\n",
+    "\n",
+    "automl_config = AutoMLConfig(task='forecasting',\n",
+    "                             debug_log='automl_oj_sales_errors.log',\n",
+    "                             primary_metric='normalized_root_mean_squared_error',\n",
+    "                             iterations=10,\n",
+    "                             X=X_train,\n",
+    "                             y=y_train,\n",
+    "                             X_valid=X_validate,\n",
+    "                             y_valid=y_validate,\n",
+    "                             enable_ensembling=False,\n",
+    "                             path=project_folder,\n",
+    "                             verbosity=logging.INFO,\n",
+    "                            **automl_settings)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Training the Model\n",
+    "\n",
+    "You can now submit a new training run. For local runs, the execution is synchronous. Depending on the data and number of iterations this operation may take several minutes.\n",
+    "Information from each iteration will be printed to the console."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "Each run within an Experiment stores serialized (i.e. pickled) pipelines from the AutoML iterations. We can now retrieve the pipeline with the best performance on the validation dataset:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_pipeline = local_run.get_output()\n",
+    "fitted_pipeline.steps"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Make Predictions from the Best Fitted Model\n",
+    "Now that we have retrieved the best pipeline/model, it can be used to make predictions on test data. First, we remove the target values from the test set:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "y_test = X_test.pop(target_column_name).values"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "X_test.head()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "To produce predictions on the test set, we need to know the feature values at all dates in the test set. This requirement is somewhat reasonable for the OJ sales data since the features mainly consist of price, which is usually set in advance, and customer demographics which are approximately constant for each store over the 20 week forecast horizon in the testing data. \n",
+    "\n",
+    "The target predictions can be retrieved by calling the `predict` method on the best model:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "y_pred = fitted_pipeline.predict(X_test)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Calculate evaluation metrics for the prediction\n",
+    "To evaluate the accuracy of the forecast, we'll compare against the actual sales quantities for some select metrics, included the mean absolute percentage error (MAPE)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def MAPE(actual, pred):\n",
+    "    \"\"\"\n",
+    "    Calculate mean absolute percentage error.\n",
+    "    Remove NA and values where actual is close to zero\n",
+    "    \"\"\"\n",
+    "    not_na = ~(np.isnan(actual) | np.isnan(pred))\n",
+    "    not_zero = ~np.isclose(actual, 0.0)\n",
+    "    actual_safe = actual[not_na & not_zero]\n",
+    "    pred_safe = pred[not_na & not_zero]\n",
+    "    APE = 100*np.abs((actual_safe - pred_safe)/actual_safe)\n",
+    "    return np.mean(APE)\n",
+    "\n",
+    "print(\"[Test Data] \\nRoot Mean squared error: %.2f\" % np.sqrt(mean_squared_error(y_test, y_pred)))\n",
+    "print('mean_absolute_error score: %.2f' % mean_absolute_error(y_test, y_pred))\n",
+    "print('MAPE: %.2f' % MAPE(y_test, y_pred))"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "erwright"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/missing-data-blacklist-early-termination/auto-ml-missing-data-blacklist-early-termination.ipynb

@@ -0,0 +1,381 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Blacklisting Models, Early Termination, and Handling Missing Data\n",
+    "\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use AutoML for handling missing values in data. We also provide a stopping metric indicating a target for the primary metrics so that AutoML can terminate the run without necessarly going through all the iterations. Finally, if you want to avoid a certain pipeline, we allow you to specify a blacklist of algorithms that AutoML will ignore for this run.\n",
+    "\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
+    "\n",
+    "In this notebook you will learn how to:\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Configure AutoML using `AutoMLConfig`.\n",
+    "4. Train the model.\n",
+    "5. Explore the results.\n",
+    "6. Test the best fitted model.\n",
+    "\n",
+    "In addition this notebook showcases the following features\n",
+    "- **Blacklisting** certain pipelines\n",
+    "- Specifying **target metrics** to indicate stopping criteria\n",
+    "- Handling **missing data** in the input\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an Experiment\n",
+    "\n",
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import os\n",
+    "import random\n",
+    "\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "import numpy as np\n",
+    "import pandas as pd\n",
+    "from sklearn import datasets\n",
+    "\n",
+    "import azureml.core\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "\n",
+    "# Choose a name for the experiment.\n",
+    "experiment_name = 'automl-local-missing-data'\n",
+    "project_folder = './sample_projects/automl-local-missing-data'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Experiment Name'] = experiment.name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data=output, index=['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "set_diagnostics_collection(send_diagnostics = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Creating missing data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from scipy import sparse\n",
+    "\n",
+    "digits = datasets.load_digits()\n",
+    "X_train = digits.data[10:,:]\n",
+    "y_train = digits.target[10:]\n",
+    "\n",
+    "# Add missing values in 75% of the lines.\n",
+    "missing_rate = 0.75\n",
+    "n_missing_samples = int(np.floor(X_train.shape[0] * missing_rate))\n",
+    "missing_samples = np.hstack((np.zeros(X_train.shape[0] - n_missing_samples, dtype=np.bool), np.ones(n_missing_samples, dtype=np.bool)))\n",
+    "rng = np.random.RandomState(0)\n",
+    "rng.shuffle(missing_samples)\n",
+    "missing_features = rng.randint(0, X_train.shape[1], n_missing_samples)\n",
+    "X_train[np.where(missing_samples)[0], missing_features] = np.nan"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "df = pd.DataFrame(data = X_train)\n",
+    "df['Label'] = pd.Series(y_train, index=df.index)\n",
+    "df.head()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure AutoML\n",
+    "\n",
+    "Instantiate an `AutoMLConfig` object to specify the settings and data used to run the experiment.  This includes setting `experiment_exit_score`, which should cause the run to complete before the `iterations` count is reached.\n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**task**|classification or regression|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**preprocess**|Setting this to *True* enables AutoML to perform preprocessing on the input to handle *missing data*, and to perform some common *feature extraction*.|\n",
+    "|**experiment_exit_score**|*double* value indicating the target for *primary_metric*. <br>Once the target is surpassed the run terminates.|\n",
+    "|**blacklist_models**|*List* of *strings* indicating machine learning algorithms for AutoML to avoid in this run.<br><br> Allowed values for **Classification**<br><i>LogisticRegression</i><br><i>SGD</i><br><i>MultinomialNaiveBayes</i><br><i>BernoulliNaiveBayes</i><br><i>SVM</i><br><i>LinearSVM</i><br><i>KNN</i><br><i>DecisionTree</i><br><i>RandomForest</i><br><i>ExtremeRandomTrees</i><br><i>LightGBM</i><br><i>GradientBoosting</i><br><i>TensorFlowDNN</i><br><i>TensorFlowLinearClassifier</i><br><br>Allowed values for **Regression**<br><i>ElasticNet</i><br><i>GradientBoosting</i><br><i>DecisionTree</i><br><i>KNN</i><br><i>LassoLars</i><br><i>SGD</i><br><i>RandomForest</i><br><i>ExtremeRandomTrees</i><br><i>LightGBM</i><br><i>TensorFlowLinearRegressor</i><br><i>TensorFlowDNN</i>|\n",
+    "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_config = AutoMLConfig(task = 'classification',\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             primary_metric = 'AUC_weighted',\n",
+    "                             iteration_timeout_minutes = 60,\n",
+    "                             iterations = 20,\n",
+    "                             n_cross_validations = 5,\n",
+    "                             preprocess = True,\n",
+    "                             experiment_exit_score = 0.9984,\n",
+    "                             blacklist_models = ['KNN','LinearSVM'],\n",
+    "                             verbosity = logging.INFO,\n",
+    "                             X = X_train, \n",
+    "                             y = y_train,\n",
+    "                             path = project_folder)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explore the Results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Widget for Monitoring Runs\n",
+    "\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
+    "\n",
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(local_run).show() "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\n",
+    "#### Retrieve All Child Runs\n",
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "children = list(local_run.get_children())\n",
+    "metricslist = {}\n",
+    "for run in children:\n",
+    "    properties = run.get_properties()\n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
+    "    metricslist[int(properties['iteration'])] = metrics\n",
+    "\n",
+    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
+    "rundata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "\n",
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = local_run.get_output()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model which has the smallest `accuracy` value:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# lookup_metric = \"accuracy\"\n",
+    "# best_run, fitted_model = local_run.get_output(metric = lookup_metric)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# iteration = 3\n",
+    "# best_run, fitted_model = local_run.get_output(iteration = iteration)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Testing the best Fitted Model"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "digits = datasets.load_digits()\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
+    "images = digits.images[:10]\n",
+    "\n",
+    "# Randomly select digits and test.\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
+    "    print(index)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
+    "    fig = plt.figure(1, figsize=(3,3))\n",
+    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
+    "    ax1.set_title(title)\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
+    "    plt.show()\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/model-explanation/auto-ml-model-explanation.ipynb

@@ -13,18 +13,18 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 01: Classification with local compute\n",
+    "# Automated Machine Learning: Explain classification model and visualize the explanation\n",
     "\n",
-    "In this example we use the scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) to showcase how you can use AutoML for a simple classification problem.\n",
+    "In this example we use the sklearn's [iris dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_iris.html) to showcase how you can use the AutoML Classifier for a simple classification problem.\n",
     "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
     "In this notebook you would see\n",
     "1. Creating an Experiment in an existing Workspace\n",
     "2. Instantiating AutoMLConfig\n",
-    "3. Training the Model using local compute\n",
-    "4. Exploring the results\n",
-    "5. Testing the fitted model\n"
+    "3. Training the Model using local compute and explain the model\n",
+    "4. Visualization model's feature importance in widget\n",
+    "5. Explore best model's explanation\n"
    ]
   },
   {
@@ -46,12 +46,7 @@
     "import os\n",
     "import random\n",
     "\n",
-    "from matplotlib import pyplot as plt\n",
-    "from matplotlib.pyplot import imshow\n",
-    "import numpy as np\n",
     "import pandas as pd\n",
-    "from sklearn import datasets\n",
-    "\n",
     "import azureml.core\n",
     "from azureml.core.experiment import Experiment\n",
     "from azureml.core.workspace import Workspace\n",
@@ -70,7 +65,7 @@
     "# choose a name for experiment\n",
     "experiment_name = 'automl-local-classification'\n",
     "# project folder\n",
-    "project_folder = './sample_projects/automl-local-classification'\n",
+    "project_folder = './sample_projects/automl-local-classification-model-explanation'\n",
     "\n",
     "experiment=Experiment(ws, experiment_name)\n",
     "\n",
@@ -109,7 +104,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Load Digits Dataset"
+    "## Load Iris Data Set"
    ]
   },
   {
@@ -120,11 +115,21 @@
    "source": [
     "from sklearn import datasets\n",
     "\n",
-    "digits = datasets.load_digits()\n",
+    "iris = datasets.load_iris()\n",
+    "y = iris.target\n",
+    "X = iris.data\n",
     "\n",
-    "# Exclude the first 100 rows from training so that they can be used for test.\n",
-    "X_digits = digits.data[100:,:]\n",
-    "y_digits = digits.target[100:]"
+    "features = iris.feature_names\n",
+    "\n",
+    "from sklearn.model_selection import train_test_split\n",
+    "X_train, X_test, y_train, y_test = train_test_split(X,\n",
+    "                                                    y,\n",
+    "                                                    test_size=0.1,\n",
+    "                                                    random_state=100,\n",
+    "                                                    stratify=y)\n",
+    "\n",
+    "X_train = pd.DataFrame(X_train, columns=features)\n",
+    "X_test = pd.DataFrame(X_test, columns=features)"
    ]
   },
   {
@@ -138,12 +143,14 @@
     "|Property|Description|\n",
     "|-|-|\n",
     "|**task**|classification or regression|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data |\n",
-    "|**n_cross_validations**|Number of cross validation splits|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**max_time_sec**|Time limit in minutes for each iterations|\n",
+    "|**iterations**|Number of iterations. In each iteration Auto ML trains the data with a specific pipeline|\n",
     "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
     "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers. |\n",
+    "|**X_valid**|(sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y_valid**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]|\n",
+    "|**model_explainability**|Indicate to explain each trained pipeline or not |\n",
     "|**path**|Relative path to the project folder.  AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder. |"
    ]
   },
@@ -156,12 +163,14 @@
     "automl_config = AutoMLConfig(task = 'classification',\n",
     "                             debug_log = 'automl_errors.log',\n",
     "                             primary_metric = 'AUC_weighted',\n",
-    "                             max_time_sec = 3600,\n",
-    "                             iterations = 50,\n",
-    "                             n_cross_validations = 3,\n",
+    "                             iteration_timeout_minutes = 200,\n",
+    "                             iterations = 10,\n",
     "                             verbosity = logging.INFO,\n",
-    "                             X = X_digits, \n",
-    "                             y = y_digits,\n",
+    "                             X = X_train, \n",
+    "                             y = y_train,\n",
+    "                             X_valid = X_test,\n",
+    "                             y_valid = y_test,\n",
+    "                             model_explainability=True,\n",
     "                             path=project_folder)"
    ]
   },
@@ -184,34 +193,6 @@
     "local_run = experiment.submit(automl_config, show_output=True)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Optionally, you can continue an interrupted local run by calling continue_experiment without the <b>iterations</b> parameter, or run more iterations to a completed run by specifying the <b>iterations</b> parameter:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "local_run"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "local_run = local_run.continue_experiment(X = X_digits, \n",
-    "                                          y = y_digits, \n",
-    "                                          show_output = True,\n",
-    "                                          iterations = 5)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -223,7 +204,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Widget for monitoring runs\n",
+    "### Widget for monitoring runs\n",
     "\n",
     "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
     "\n",
@@ -236,36 +217,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
     "RunDetails(local_run).show() "
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "#### Retrieve All Child Runs\n",
-    "You can also use sdk methods to fetch all the child runs and see individual metrics that we log. "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "children = list(local_run.get_children())\n",
-    "metricslist = {}\n",
-    "for run in children:\n",
-    "    properties = run.get_properties()\n",
-    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
-    "    metricslist[int(properties['iteration'])] = metrics\n",
-    "\n",
-    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
-    "rundata"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -290,49 +245,16 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Best Model based on any other metric\n",
-    "Give me the run and the model that has the smallest `log_loss`:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "lookup_metric = \"log_loss\"\n",
-    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
-    "print(best_run)\n",
-    "print(fitted_model)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Model from a specific iteration\n",
-    "Give me the run and the model from the 3rd iteration:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "iteration = 3\n",
-    "third_run, third_model = local_run.get_output(iteration = iteration)\n",
-    "print(third_run)\n",
-    "print(third_model)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Testing the Fitted Model \n",
+    "### Best Model 's explanation\n",
     "\n",
-    "#### Load Test Data"
+    "Retrieve the explanation from the best_run. And explanation information includes:\n",
+    "\n",
+    "1.\tshap_values: The explanation information generated by shap lib\n",
+    "2.\texpected_values: The expected value of the model applied to set of X_train data.\n",
+    "3.\toverall_summary: The model level feature importance values sorted in descending order\n",
+    "4.\toverall_imp: The feature names sorted in the same order as in overall_summary\n",
+    "5.\tper_class_summary: The class level feature importance values sorted in descending order. Only available for the classification case\n",
+    "6.\tper_class_imp: The feature names sorted in the same order as in per_class_summary. Only available for the classification case"
    ]
   },
   {
@@ -341,18 +263,37 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[:10, :]\n",
-    "y_digits = digits.target[:10]\n",
-    "images = digits.images[:10]"
+    "from azureml.train.automl.automlexplainer import retrieve_model_explanation\n",
+    "\n",
+    "shap_values, expected_values, overall_summary, overall_imp, per_class_summary, per_class_imp = \\\n",
+    "    retrieve_model_explanation(best_run)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(overall_summary)\n",
+    "print(overall_imp)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(per_class_summary)\n",
+    "print(per_class_imp)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Testing our best pipeline\n",
-    "We will try to predict 2 digits and see how our model works."
+    "Beside retrieve the existed model explanation information, explain the model with different train/test data"
    ]
   },
   {
@@ -361,21 +302,29 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#Randomly select digits and test\n",
-    "for index in np.random.choice(len(y_digits), 2):\n",
-    "    print(index)\n",
-    "    predicted = fitted_model.predict(X_digits[index:index + 1])[0]\n",
-    "    label = y_digits[index]\n",
-    "    title = \"Label value = %d  Predicted value = %d \" % ( label,predicted)\n",
-    "    fig = plt.figure(1, figsize=(3,3))\n",
-    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
-    "    ax1.set_title(title)\n",
-    "    plt.imshow(images[index], cmap=plt.cm.gray_r, interpolation='nearest')\n",
-    "    plt.show()"
+    "from azureml.train.automl.automlexplainer import explain_model\n",
+    "\n",
+    "shap_values, expected_values, overall_summary, overall_imp, per_class_summary, per_class_imp = \\\n",
+    "    explain_model(fitted_model, X_train, X_test)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(overall_summary)\n",
+    "print(overall_imp)"
    ]
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "xif"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/regression/auto-ml-regression.ipynb

@@ -13,27 +13,27 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 02: Regression with local compute\n",
+    "# AutoML: Regression with Local Compute\n",
     "\n",
-    "In this example we use the scikit learn's [diabetes dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_diabetes.html) to showcase how you can use AutoML for a simple regression problem.\n",
+    "In this example we use the scikit-learn's [diabetes dataset](http://scikit-learn.org/stable/datasets/index.html#diabetes-dataset) to showcase how you can use AutoML for a simple regression problem.\n",
     "\n",
     "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
     "\n",
-    "In this notebook you would see\n",
-    "1. Creating an Experiment using an existing Workspace\n",
-    "2. Instantiating AutoMLConfig\n",
-    "3. Training the Model using local compute\n",
-    "4. Exploring the results\n",
-    "5. Testing the fitted model"
+    "In this notebook you will learn how to:\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Configure AutoML using `AutoMLConfig`.\n",
+    "3. Train the model using local compute.\n",
+    "4. Explore the results.\n",
+    "5. Test the best fitted model.\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create Experiment\n",
+    "## Create an Experiment\n",
     "\n",
-    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
    ]
   },
   {
@@ -67,9 +67,8 @@
    "source": [
     "ws = Workspace.from_config()\n",
     "\n",
-    "# choose a name for the experiment\n",
+    "# Choose a name for the experiment and specify the project folder.\n",
     "experiment_name = 'automl-local-regression'\n",
-    "# project folder\n",
     "project_folder = './sample_projects/automl-local-regression'\n",
     "\n",
     "experiment = Experiment(ws, experiment_name)\n",
@@ -92,7 +91,7 @@
    "source": [
     "## Diagnostics\n",
     "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
    ]
   },
   {
@@ -102,14 +101,15 @@
    "outputs": [],
    "source": [
     "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
+    "set_diagnostics_collection(send_diagnostics = True)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Read Data"
+    "### Load Training Data\n",
+    "This uses scikit-learn's [load_diabetes](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_diabetes.html) method."
    ]
   },
   {
@@ -118,7 +118,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# load diabetes dataset, a well-known built-in small dataset that comes with scikit-learn\n",
+    "# Load the diabetes dataset, a well-known built-in small dataset that comes with scikit-learn.\n",
     "from sklearn.datasets import load_diabetes\n",
     "from sklearn.linear_model import Ridge\n",
     "from sklearn.metrics import mean_squared_error\n",
@@ -128,27 +128,27 @@
     "\n",
     "columns = ['age', 'gender', 'bmi', 'bp', 's1', 's2', 's3', 's4', 's5', 's6']\n",
     "\n",
-    "X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=0)"
+    "X_train, X_test, y_train, y_test = train_test_split(X, y, test_size = 0.2, random_state = 0)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Instantiate Auto ML Config\n",
+    "## Configure AutoML\n",
     "\n",
-    "Instantiate a AutoMLConfig object. This defines the settings and data used to run the experiment.\n",
+    "Instantiate an `AutoMLConfig` object to specify the settings and data used to run the experiment.\n",
     "\n",
     "|Property|Description|\n",
     "|-|-|\n",
     "|**task**|classification or regression|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Regression supports the following primary metrics <br><i>spearman_correlation</i><br><i>normalized_root_mean_squared_error</i><br><i>r2_score</i><br><i>normalized_mean_absolute_error</i><br><i>normalized_root_mean_squared_log_error</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data|\n",
-    "|**n_cross_validations**|Number of cross validation splits|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Regression supports the following primary metrics: <br><i>spearman_correlation</i><br><i>normalized_root_mean_squared_error</i><br><i>r2_score</i><br><i>normalized_mean_absolute_error</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
     "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
-    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers. |\n",
-    "|**path**|Relative path to the project folder.  AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. This should be an array of integers.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
    ]
   },
   {
@@ -157,26 +157,26 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "automl_config = AutoMLConfig(task='regression',\n",
-    "                             max_time_sec = 600,\n",
+    "automl_config = AutoMLConfig(task = 'regression',\n",
+    "                             iteration_timeout_minutes = 10,\n",
     "                             iterations = 10,\n",
-    "                             primary_metric = 'spearman_correlation', \n",
+    "                             primary_metric = 'spearman_correlation',\n",
     "                             n_cross_validations = 5,\n",
     "                             debug_log = 'automl.log',\n",
     "                             verbosity = logging.INFO,\n",
     "                             X = X_train, \n",
     "                             y = y_train,\n",
-    "                             path=project_folder)"
+    "                             path = project_folder)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Training the Model\n",
+    "## Train the Models\n",
     "\n",
-    "You can call the submit method on the experiment object and pass the run configuration. For Local runs the execution is synchronous. Depending on the data and number of iterations this can run for while.\n",
-    "You will see the currently running iterations printing to the console."
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
    ]
   },
   {
@@ -185,7 +185,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "local_run = experiment.submit(automl_config, show_output=True)"
+    "local_run = experiment.submit(automl_config, show_output = True)"
    ]
   },
   {
@@ -201,18 +201,18 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Exploring the results"
+    "## Explore the Results"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Widget for monitoring runs\n",
+    "#### Widget for Monitoring Runs\n",
     "\n",
-    "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
     "\n",
-    "NOTE: The widget displays a link at the bottom. This links to a web-ui to explore the individual run details."
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
    ]
   },
   {
@@ -221,7 +221,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
     "RunDetails(local_run).show() "
    ]
   },
@@ -231,7 +231,7 @@
    "source": [
     "\n",
     "#### Retrieve All Child Runs\n",
-    "You can also use sdk methods to fetch all the child runs and see individual metrics that we log. "
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
    ]
   },
   {
@@ -244,9 +244,9 @@
     "metricslist = {}\n",
     "for run in children:\n",
     "    properties = run.get_properties()\n",
-    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
     "    metricslist[int(properties['iteration'])] = metrics\n",
-    "    \n",
+    "\n",
     "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
     "rundata"
    ]
@@ -257,7 +257,7 @@
    "source": [
     "### Retrieve the Best Model\n",
     "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
    ]
   },
   {
@@ -275,8 +275,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Best Model based on any other metric\n",
-    "Show the run and model that has the smallest `root_mean_squared_error` (which turned out to be the same as the one with largest `spearman_correlation` value):"
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model that has the smallest `root_mean_squared_error` value (which turned out to be the same as the one with largest `spearman_correlation` value):"
    ]
   },
   {
@@ -286,7 +286,7 @@
    "outputs": [],
    "source": [
     "lookup_metric = \"root_mean_squared_error\"\n",
-    "best_run, fitted_model = local_run.get_output(metric=lookup_metric)\n",
+    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
     "print(best_run)\n",
     "print(fitted_model)"
    ]
@@ -295,9 +295,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Model from a specific iteration\n",
-    "\n",
-    "Simply show the run and model from the 3rd iteration:"
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
    ]
   },
   {
@@ -316,7 +315,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Testing the Fitted Model"
+    "### Test the Best Fitted Model"
    ]
   },
   {
@@ -351,13 +350,13 @@
     "from sklearn import datasets\n",
     "from sklearn.metrics import mean_squared_error, r2_score\n",
     "\n",
-    "# set up a multi-plot chart\n",
+    "# Set up a multi-plot chart.\n",
     "f, (a0, a1) = plt.subplots(1, 2, gridspec_kw = {'width_ratios':[1, 1], 'wspace':0, 'hspace': 0})\n",
     "f.suptitle('Regression Residual Values', fontsize = 18)\n",
     "f.set_figheight(6)\n",
     "f.set_figwidth(16)\n",
     "\n",
-    "# plot residual values of training set\n",
+    "# Plot residual values of training set.\n",
     "a0.axis([0, 360, -200, 200])\n",
     "a0.plot(y_residual_train, 'bo', alpha = 0.5)\n",
     "a0.plot([-10,360],[0,0], 'r-', lw = 3)\n",
@@ -365,11 +364,12 @@
     "a0.text(16,140,'R2 score = {0:.2f}'.format(r2_score(y_train, y_pred_train)), fontsize = 12)\n",
     "a0.set_xlabel('Training samples', fontsize = 12)\n",
     "a0.set_ylabel('Residual Values', fontsize = 12)\n",
-    "# plot histogram\n",
+    "\n",
+    "# Plot a histogram.\n",
     "a0.hist(y_residual_train, orientation = 'horizontal', color = 'b', bins = 10, histtype = 'step');\n",
     "a0.hist(y_residual_train, orientation = 'horizontal', color = 'b', alpha = 0.2, bins = 10);\n",
     "\n",
-    "# plot residual values of test set\n",
+    "# Plot residual values of test set.\n",
     "a1.axis([0, 90, -200, 200])\n",
     "a1.plot(y_residual_test, 'bo', alpha = 0.5)\n",
     "a1.plot([-10,360],[0,0], 'r-', lw = 3)\n",
@@ -377,15 +377,21 @@
     "a1.text(5,140,'R2 score = {0:.2f}'.format(r2_score(y_test, y_pred_test)), fontsize = 12)\n",
     "a1.set_xlabel('Test samples', fontsize = 12)\n",
     "a1.set_yticklabels([])\n",
-    "# plot histogram\n",
-    "a1.hist(y_residual_test, orientation = 'horizontal', color = 'b', bins = 10, histtype = 'step');\n",
-    "a1.hist(y_residual_test, orientation = 'horizontal', color = 'b', alpha = 0.2, bins = 10);\n",
+    "\n",
+    "# Plot a histogram.\n",
+    "a1.hist(y_residual_test, orientation = 'horizontal', color = 'b', bins = 10, histtype = 'step')\n",
+    "a1.hist(y_residual_test, orientation = 'horizontal', color = 'b', alpha = 0.2, bins = 10)\n",
     "\n",
     "plt.show()"
    ]
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/remote-attach/auto-ml-remote-attach.ipynb

@@ -0,0 +1,517 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Automated Machine Learning: Remote Execution using attach\n",
+    "\n",
+    "In this example we use the scikit-learn's [20newsgroup](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.fetch_20newsgroups.html) to showcase how you can use AutoML to handle text data with remote attach.\n",
+    "\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
+    "\n",
+    "In this notebook you will learn how to:\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Attach an existing DSVM to a workspace.\n",
+    "3. Configure AutoML using `AutoMLConfig`.\n",
+    "4. Train the model using the DSVM.\n",
+    "5. Explore the results.\n",
+    "6. Test the best fitted model.\n",
+    "\n",
+    "In addition this notebook showcases the following features\n",
+    "- **Parallel** executions for iterations\n",
+    "- **Asynchronous** tracking of progress\n",
+    "- **Cancellation** of individual iterations or the entire run\n",
+    "- Retrieving models for any iteration or logged metric\n",
+    "- Specifying AutoML settings as `**kwargs`\n",
+    "- Handling **text** data using the `preprocess` flag\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an Experiment\n",
+    "\n",
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import os\n",
+    "import random\n",
+    "\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "import numpy as np\n",
+    "import pandas as pd\n",
+    "from sklearn import datasets\n",
+    "\n",
+    "import azureml.core\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "\n",
+    "# Choose a name for the run history container in the workspace.\n",
+    "experiment_name = 'automl-remote-dsvm-blobstore'\n",
+    "project_folder = './sample_projects/automl-remote-dsvm-blobstore'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Experiment Name'] = experiment.name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data=output, index=['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "set_diagnostics_collection(send_diagnostics = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Attach a Remote Linux DSVM\n",
+    "To use a remote Docker compute target:\n",
+    "1. Create a Linux DSVM in Azure, following these [quick instructions](https://docs.microsoft.com/en-us/azure/machine-learning/desktop-workbench/how-to-create-dsvm-hdi). Make sure you use the Ubuntu flavor (not CentOS). Make sure that disk space is available under `/tmp` because AutoML creates files under `/tmp/azureml_run`s. The DSVM should have more cores than the number of parallel runs that you plan to enable. It should also have at least 4GB per core.\n",
+    "2. Enter the IP address, user name and password below.\n",
+    "\n",
+    "**Note:** By default, SSH runs on port 22 and you don't need to change the port number below. If you've configured SSH to use a different port, change `dsvm_ssh_port` accordinglyaddress. [Read more](https://render.githubusercontent.com/documentation/sdk/ssh-issue.md) on changing SSH ports for security reasons."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.compute import ComputeTarget, RemoteCompute\n",
+    "import time\n",
+    "\n",
+    "# Add your VM information below\n",
+    "# If a compute with the specified compute_name already exists, it will be used and the dsvm_ip_addr, dsvm_ssh_port, \n",
+    "# dsvm_username and dsvm_password will be ignored.\n",
+    "compute_name  = 'mydsvmb'\n",
+    "dsvm_ip_addr  = '<<ip_addr>>'\n",
+    "dsvm_ssh_port = 22\n",
+    "dsvm_username = '<<username>>'\n",
+    "dsvm_password = '<<password>>'\n",
+    "\n",
+    "if compute_name in ws.compute_targets:\n",
+    "    print('Using existing compute.')\n",
+    "    dsvm_compute = ws.compute_targets[compute_name]\n",
+    "else:\n",
+    "    attach_config = RemoteCompute.attach_configuration(address=dsvm_ip_addr, username=dsvm_username, password=dsvm_password, ssh_port=dsvm_ssh_port)\n",
+    "    ComputeTarget.attach(workspace=ws, name=compute_name, attach_configuration=attach_config)\n",
+    "\n",
+    "    while ws.compute_targets[compute_name].provisioning_state == 'Creating':\n",
+    "        time.sleep(1)\n",
+    "\n",
+    "    dsvm_compute = ws.compute_targets[compute_name]\n",
+    "    \n",
+    "    if dsvm_compute.provisioning_state == 'Failed':\n",
+    "        print('Attached failed.')\n",
+    "        print(dsvm_compute.provisioning_errors)\n",
+    "        dsvm_compute.detach()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.runconfig import RunConfiguration\n",
+    "from azureml.core.conda_dependencies import CondaDependencies\n",
+    "\n",
+    "# create a new RunConfig object\n",
+    "conda_run_config = RunConfiguration(framework=\"python\")\n",
+    "\n",
+    "# Set compute target to the Linux DSVM\n",
+    "conda_run_config.target = dsvm_compute\n",
+    "\n",
+    "cd = CondaDependencies.create(pip_packages=['azureml-sdk[automl]'], conda_packages=['numpy'])\n",
+    "conda_run_config.environment.python.conda_dependencies = cd"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create Get Data File\n",
+    "For remote executions you should author a `get_data.py` file containing a `get_data()` function. This file should be in the root directory of the project. You can encapsulate code to read data either from a blob storage or local disk in this file.\n",
+    "In this example, the `get_data()` function returns a [dictionary](README.md#getdata)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if not os.path.exists(project_folder):\n",
+    "    os.makedirs(project_folder)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%writefile $project_folder/get_data.py\n",
+    "\n",
+    "import numpy as np\n",
+    "from sklearn.datasets import fetch_20newsgroups\n",
+    "\n",
+    "def get_data():\n",
+    "    remove = ('headers', 'footers', 'quotes')\n",
+    "    categories = [\n",
+    "        'alt.atheism',\n",
+    "        'talk.religion.misc',\n",
+    "        'comp.graphics',\n",
+    "        'sci.space',\n",
+    "    ]\n",
+    "    data_train = fetch_20newsgroups(subset = 'train', categories = categories,\n",
+    "                                    shuffle = True, random_state = 42,\n",
+    "                                    remove = remove)\n",
+    "    \n",
+    "    X_train = np.array(data_train.data).reshape((len(data_train.data),1))\n",
+    "    y_train = np.array(data_train.target)\n",
+    "    \n",
+    "    return { \"X\" : X_train, \"y\" : y_train }"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure AutoML <a class=\"anchor\" id=\"Instatiate-AutoML-Remote-DSVM\"></a>\n",
+    "\n",
+    "You can specify `automl_settings` as `**kwargs` as well. Also note that you can use a `get_data()` function for local excutions too.\n",
+    "\n",
+    "**Note:** When using Remote DSVM, you can't pass Numpy arrays directly to the fit method.\n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**max_concurrent_iterations**|Maximum number of iterations that would be executed in parallel. This should be less than the number of cores on the DSVM.|\n",
+    "|**preprocess**|Setting this to *True* enables AutoML to perform preprocessing on the input to handle *missing data*, and to perform some common *feature extraction*.|\n",
+    "|**enable_cache**|Setting this to *True* enables preprocess done once and reuse the same preprocessed data for all the iterations. Default value is True.\n",
+    "|**max_cores_per_iteration**|Indicates how many cores on the compute target would be used to train a single pipeline.<br>Default is *1*; you can set it to *-1* to use all cores.|"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_settings = {\n",
+    "    \"iteration_timeout_minutes\": 60,\n",
+    "    \"iterations\": 4,\n",
+    "    \"n_cross_validations\": 5,\n",
+    "    \"primary_metric\": 'AUC_weighted',\n",
+    "    \"preprocess\": True,\n",
+    "    \"max_cores_per_iteration\": 2\n",
+    "}\n",
+    "\n",
+    "automl_config = AutoMLConfig(task = 'classification',\n",
+    "                             path = project_folder,\n",
+    "                             run_configuration=conda_run_config,\n",
+    "                             data_script = project_folder + \"/get_data.py\",\n",
+    "                             **automl_settings\n",
+    "                            )\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models <a class=\"anchor\" id=\"Training-the-model-Remote-DSVM\"></a>\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. For remote runs the execution is asynchronous, so you will see the iterations get populated as they complete. You can interact with the widgets and models even when the experiment is running to retrieve the best model up to that point. Once you are satisfied with the model, you can cancel a particular iteration or the whole run."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "remote_run = experiment.submit(automl_config)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Exploring the Results <a class=\"anchor\" id=\"Exploring-the-Results-Remote-DSVM\"></a>\n",
+    "#### Widget for Monitoring Runs\n",
+    "\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
+    "\n",
+    "You can click on a pipeline to see run properties and output logs.  Logs are also available on the DSVM under `/tmp/azureml_run/{iterationid}/azureml-logs`\n",
+    "\n",
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(remote_run).show() "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Wait until the run finishes.\n",
+    "remote_run.wait_for_completion(show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Pre-process cache cleanup\n",
+    "The preprocess data gets cache at user default file store. When the run is completed the cache can be cleaned by running below cell"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "remote_run.clean_preprocessor_cache()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "\n",
+    "#### Retrieve All Child Runs\n",
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "children = list(remote_run.get_children())\n",
+    "metricslist = {}\n",
+    "for run in children:\n",
+    "    properties = run.get_properties()\n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
+    "    metricslist[int(properties['iteration'])] = metrics\n",
+    "\n",
+    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
+    "rundata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Cancelling Runs\n",
+    "You can cancel ongoing remote runs using the `cancel` and `cancel_iteration` functions."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Cancel the ongoing experiment and stop scheduling new iterations.\n",
+    "# remote_run.cancel()\n",
+    "\n",
+    "# Cancel iteration 1 and move onto iteration 2.\n",
+    "# remote_run.cancel_iteration(1)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model\n",
+    "\n",
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = remote_run.get_output()\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model which has the smallest `accuracy` value:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# lookup_metric = \"accuracy\"\n",
+    "# best_run, fitted_model = remote_run.get_output(metric = lookup_metric)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Model from a Specific Iteration"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "iteration = 0\n",
+    "zero_run, zero_model = remote_run.get_output(iteration = iteration)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Testing the Fitted Model <a class=\"anchor\" id=\"Testing-the-Fitted-Model-Remote-DSVM\"></a>\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Load test data.\n",
+    "from pandas_ml import ConfusionMatrix\n",
+    "from sklearn.datasets import fetch_20newsgroups\n",
+    "\n",
+    "remove = ('headers', 'footers', 'quotes')\n",
+    "categories = [\n",
+    "        'alt.atheism',\n",
+    "        'talk.religion.misc',\n",
+    "        'comp.graphics',\n",
+    "        'sci.space',\n",
+    "    ]\n",
+    "\n",
+    "data_test = fetch_20newsgroups(subset = 'test', categories = categories,\n",
+    "                               shuffle = True, random_state = 42,\n",
+    "                               remove = remove)\n",
+    "\n",
+    "X_test = np.array(data_test.data).reshape((len(data_test.data),1))\n",
+    "y_test = data_test.target\n",
+    "\n",
+    "# Test our best pipeline.\n",
+    "\n",
+    "y_pred = fitted_model.predict(X_test)\n",
+    "y_pred_strings = [data_test.target_names[i] for i in y_pred]\n",
+    "y_test_strings = [data_test.target_names[i] for i in y_test]\n",
+    "\n",
+    "cm = ConfusionMatrix(y_test_strings, y_pred_strings)\n",
+    "print(cm)\n",
+    "cm.plot()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/automated-machine-learning/remote-batchai/auto-ml-remote-batchai.ipynb

@@ -13,35 +13,35 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 03:  Remote Execution using Batch AI\n",
+    "# Automated Machine Learning: Remote Execution using Batch AI\n",
     "\n",
-    "In this example we use the scikit learn's [diabetes dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_diabetes.html) to showcase how you can use AutoML for a simple classification problem.\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use AutoML for a simple classification problem.\n",
     "\n",
-    "Make sure you have executed the [setup](setup.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
     "In this notebook you would see\n",
-    "1. Creating an Experiment using an existing Workspace\n",
-    "2. Attaching an existing Batch AI compute to a workspace\n",
-    "3. Instantiating AutoMLConfig \n",
-    "4. Training the Model using the Batch AI\n",
-    "5. Exploring the results\n",
-    "6. Testing the fitted model\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Attach an existing Batch AI compute to a workspace.\n",
+    "3. Configure AutoML using `AutoMLConfig`.\n",
+    "4. Train the model using Batch AI.\n",
+    "5. Explore the results.\n",
+    "6. Test the best fitted model.\n",
     "\n",
     "In addition this notebook showcases the following features\n",
-    "- **Parallel** Executions for iterations\n",
-    "- Asyncronous tracking of progress\n",
-    "- **Cancelling** individual iterations or the entire run\n",
+    "- **Parallel** executions for iterations\n",
+    "- **Asynchronous** tracking of progress\n",
+    "- **Cancellation** of individual iterations or the entire run\n",
     "- Retrieving models for any iteration or logged metric\n",
-    "- specify automl settings as **kwargs**\n"
+    "- Specifying AutoML settings as `**kwargs`\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create Experiment\n",
+    "## Create an Experiment\n",
     "\n",
-    "As part of the setup you have already created a workspace. For AutoML you would need to create a <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
    ]
   },
   {
@@ -75,12 +75,11 @@
    "source": [
     "ws = Workspace.from_config()\n",
     "\n",
-    "# choose a name for the run history container in the workspace\n",
+    "# Choose a name for the run history container in the workspace.\n",
     "experiment_name = 'automl-remote-batchai'\n",
-    "# project folder\n",
     "project_folder = './sample_projects/automl-remote-batchai'\n",
     "\n",
-    "experiment=Experiment(ws, experiment_name)\n",
+    "experiment = Experiment(ws, experiment_name)\n",
     "\n",
     "output = {}\n",
     "output['SDK version'] = azureml.core.VERSION\n",
@@ -100,7 +99,7 @@
    "source": [
     "## Diagnostics\n",
     "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
    ]
   },
   {
@@ -110,7 +109,7 @@
    "outputs": [],
    "source": [
     "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
+    "set_diagnostics_collection(send_diagnostics = True)"
    ]
   },
   {
@@ -120,9 +119,9 @@
     "## Create Batch AI Cluster\n",
     "The cluster is created as Machine Learning Compute and will appear under your workspace.\n",
     "\n",
-    "<b>Note</b>: The cluster creation can take over 10 minutes, please be patient.\n",
+    "**Note:** The creation of the Batch AI cluster can take over 10 minutes, please be patient.\n",
     "\n",
-    "As with other Azure services, there are limits on certain resources (for eg. BatchAI cluster size) associated with the Azure Machine Learning service. Please read [this article](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-manage-quotas) on the default limits and how to request more quota."
+    "As with other Azure services, there are limits on certain resources (e.g. Batch AI cluster size) associated with the Azure Machine Learning service. Please read [this article](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-manage-quotas) on the default limits and how to request more quota."
    ]
   },
   {
@@ -131,38 +130,55 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.core.compute import BatchAiCompute\n",
+    "from azureml.core.compute import AmlCompute\n",
     "from azureml.core.compute import ComputeTarget\n",
     "\n",
-    "# choose a name for your cluster\n",
-    "batchai_cluster_name = ws.name + \"cpu\"\n",
+    "# Choose a name for your cluster.\n",
+    "batchai_cluster_name = \"automlcl\"\n",
     "\n",
     "found = False\n",
-    "# see if this compute target already exists in the workspace\n",
-    "for ct in ws.compute_targets():\n",
-    "    print(ct.name, ct.type)\n",
-    "    if (ct.name == batchai_cluster_name and ct.type == 'BatchAI'):\n",
-    "        found = True\n",
-    "        print('found compute target. just use it.')\n",
-    "        compute_target = ct\n",
-    "        break\n",
-    "        \n",
+    "# Check if this compute target already exists in the workspace.\n",
+    "cts = ws.compute_targets\n",
+    "if batchai_cluster_name in cts and cts[batchai_cluster_name].type == 'BatchAI':\n",
+    "    found = True\n",
+    "    print('Found existing compute target.')\n",
+    "    compute_target = cts[batchai_cluster_name]\n",
+    "    \n",
     "if not found:\n",
-    "    print('creating a new compute target...')\n",
-    "    provisioning_config = BatchAiCompute.provisioning_configuration(vm_size = \"STANDARD_D2_V2\", # for GPU, use \"STANDARD_NC6\"\n",
+    "    print('Creating a new compute target...')\n",
+    "    provisioning_config = AmlCompute.provisioning_configuration(vm_size = \"STANDARD_D2_V2\", # for GPU, use \"STANDARD_NC6\"\n",
     "                                                                #vm_priority = 'lowpriority', # optional\n",
-    "                                                                autoscale_enabled = True,\n",
-    "                                                                cluster_min_nodes = 1, \n",
-    "                                                                cluster_max_nodes = 4)\n",
+    "                                                                max_nodes = 6)\n",
     "\n",
-    "    # create the cluster\n",
-    "    compute_target = ComputeTarget.create(ws,batchai_cluster_name, provisioning_config)\n",
+    "    # Create the cluster.\n",
+    "    compute_target = ComputeTarget.create(ws, batchai_cluster_name, provisioning_config)\n",
     "    \n",
-    "    # can poll for a minimum number of nodes and for a specific timeout. \n",
-    "    # if no min node count is provided it will use the scale settings for the cluster\n",
-    "    compute_target.wait_for_completion(show_output=True, min_node_count=None, timeout_in_minutes=20)\n",
+    "    # Can poll for a minimum number of nodes and for a specific timeout.\n",
+    "    # If no min_node_count is provided, it will use the scale settings for the cluster.\n",
+    "    compute_target.wait_for_completion(show_output = True, min_node_count = None, timeout_in_minutes = 20)\n",
     "    \n",
-    "     # For a more detailed view of current BatchAI cluster status, use the 'status' property    "
+    "     # For a more detailed view of current Batch AI cluster status, use the 'status' property."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.runconfig import RunConfiguration\n",
+    "from azureml.core.conda_dependencies import CondaDependencies\n",
+    "\n",
+    "# create a new RunConfig object\n",
+    "conda_run_config = RunConfiguration(framework=\"python\")\n",
+    "\n",
+    "# Set compute target to the Batch AI cluster\n",
+    "conda_run_config.target = compute_target\n",
+    "conda_run_config.environment.docker.enabled = True\n",
+    "conda_run_config.environment.docker.base_image = azureml.core.runconfig.DEFAULT_CPU_IMAGE\n",
+    "\n",
+    "cd = CondaDependencies.create(pip_packages=['azureml-sdk[automl]'], conda_packages=['numpy'])\n",
+    "conda_run_config.environment.python.conda_dependencies = cd"
    ]
   },
   {
@@ -170,7 +186,8 @@
    "metadata": {},
    "source": [
     "## Create Get Data File\n",
-    "For remote executions you should author a get_data.py file containing a get_data() function. This file should be in the root directory of the project. You can encapsulate code to read data either from a blob storage or local disk in this file."
+    "For remote executions you should author a `get_data.py` file containing a `get_data()` function. This file should be in the root directory of the project. You can encapsulate code to read data either from a blob storage or local disk in this file.\n",
+    "In this example, the `get_data()` function returns data using scikit-learn's [load_digits](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) method."
    ]
   },
   {
@@ -198,10 +215,10 @@
     "def get_data():\n",
     "    \n",
     "    digits = datasets.load_digits()\n",
-    "    X_digits = digits.data\n",
-    "    y_digits = digits.target\n",
+    "    X_train = digits.data\n",
+    "    y_train = digits.target\n",
     "\n",
-    "    return { \"X\" : X_digits, \"y\" : y_digits }"
+    "    return { \"X\" : X_train, \"y\" : y_train }"
    ]
   },
   {
@@ -210,17 +227,17 @@
    "source": [
     "## Instantiate AutoML <a class=\"anchor\" id=\"Instatiate-AutoML-Remote-DSVM\"></a>\n",
     "\n",
-    "You can specify automl_settings as **kwargs** as well. Also note that you can use the get_data() symantic for local excutions too. \n",
+    "You can specify `automl_settings` as `**kwargs` as well. Also note that you can use a `get_data()` function for local excutions too.\n",
     "\n",
-    "<i>Note: For Remote DSVM and Batch AI you cannot pass Numpy arrays directly to the fit method.</i>\n",
+    "**Note:** When using Batch AI, you can't pass Numpy arrays directly to the fit method.\n",
     "\n",
     "|Property|Description|\n",
     "|-|-|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data|\n",
-    "|**n_cross_validations**|Number of cross validation splits|\n",
-    "|**concurrent_iterations**|Max number of iterations that would be executed in parallel.  This should be less than the number of cores on the DSVM."
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**max_concurrent_iterations**|Maximum number of iterations that would be executed in parallel. This should be less than the number of cores on the DSVM.|"
    ]
   },
   {
@@ -230,61 +247,71 @@
    "outputs": [],
    "source": [
     "automl_settings = {\n",
-    "    \"max_time_sec\": 120,\n",
+    "    \"iteration_timeout_minutes\": 2,\n",
     "    \"iterations\": 20,\n",
     "    \"n_cross_validations\": 5,\n",
     "    \"primary_metric\": 'AUC_weighted',\n",
     "    \"preprocess\": False,\n",
-    "    \"concurrent_iterations\": 5,\n",
+    "    \"max_concurrent_iterations\": 5,\n",
     "    \"verbosity\": logging.INFO\n",
     "}\n",
     "\n",
     "automl_config = AutoMLConfig(task = 'classification',\n",
     "                             debug_log = 'automl_errors.log',\n",
-    "                             path=project_folder,\n",
-    "                             compute_target = compute_target,\n",
+    "                             path = project_folder,\n",
+    "                             run_configuration=conda_run_config,\n",
     "                             data_script = project_folder + \"/get_data.py\",\n",
     "                             **automl_settings\n",
     "                            )\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. For remote runs the execution is asynchronous, so you will see the iterations get populated as they complete. You can interact with the widgets and models even when the experiment is running to retrieve the best model up to that point. Once you are satisfied with the model, you can cancel a particular iteration or the whole run.\n",
+    "In this example, we specify `show_output = False` to suppress console output while the run is in progress."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
-    "remote_run = experiment.submit(automl_config, show_output=False)"
+    "remote_run = experiment.submit(automl_config, show_output = False)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Exploring the Results\n",
+    "## Explore the Results\n",
     "\n",
     "#### Loading executed runs\n",
-    "In case you need to load a previously executed run given a run id please enable the below cell"
+    "In case you need to load a previously executed run, enable the cell below and replace the `run_id` value."
    ]
   },
   {
    "cell_type": "raw",
    "metadata": {},
    "source": [
-    "remote_run = AutoMLRun(experiment=experiment, run_id='AutoML_5db13491-c92a-4f1d-b622-8ab8d973a058')"
+    "remote_run = AutoMLRun(experiment = experiment, run_id = 'AutoML_5db13491-c92a-4f1d-b622-8ab8d973a058')"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Widget for monitoring runs\n",
+    "#### Widget for Monitoring Runs\n",
     "\n",
-    "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
     "\n",
-    "You can click on a pipeline to see run properties and output logs.  Logs are also available on the DSVM under /tmp/azureml_run/{iterationid}/azureml-logs\n",
+    "You can click on a pipeline to see run properties and output logs.  Logs are also available on the DSVM under `/tmp/azureml_run/{iterationid}/azureml-logs`\n",
     "\n",
-    "NOTE: The widget displays a link at the bottom. This links to a web-ui to explore the individual run details."
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
    ]
   },
   {
@@ -302,7 +329,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
     "RunDetails(remote_run).show() "
    ]
   },
@@ -312,7 +339,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# wait till the run finishes\n",
+    "# Wait until the run finishes.\n",
     "remote_run.wait_for_completion(show_output = True)"
    ]
   },
@@ -322,7 +349,7 @@
    "source": [
     "\n",
     "#### Retrieve All Child Runs\n",
-    "You can also use sdk methods to fetch all the child runs and see individual metrics that we log. "
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
    ]
   },
   {
@@ -335,7 +362,7 @@
     "metricslist = {}\n",
     "for run in children:\n",
     "    properties = run.get_properties()\n",
-    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
     "    metricslist[int(properties['iteration'])] = metrics\n",
     "\n",
     "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
@@ -346,9 +373,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Canceling runs\n",
+    "## Cancelling Runs\n",
     "\n",
-    "You can cancel ongoing remote runs using the *cancel()* and *cancel_iteration()* functions"
+    "You can cancel ongoing remote runs using the `cancel` and `cancel_iteration` functions."
    ]
   },
   {
@@ -357,10 +384,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Cancel the ongoing experiment and stop scheduling new iterations\n",
+    "# Cancel the ongoing experiment and stop scheduling new iterations.\n",
     "# remote_run.cancel()\n",
     "\n",
-    "# Cancel iteration 1 and move onto iteration 2\n",
+    "# Cancel iteration 1 and move onto iteration 2.\n",
     "# remote_run.cancel_iteration(1)"
    ]
   },
@@ -370,7 +397,7 @@
    "source": [
     "### Retrieve the Best Model\n",
     "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
    ]
   },
   {
@@ -388,8 +415,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Best Model based on any other metric\n",
-    "Show the run/model which has the smallest `log_loss` value."
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model which has the smallest `log_loss` value:"
    ]
   },
   {
@@ -408,8 +435,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Model from a specific iteration\n",
-    "Show the run and model from the 3rd iteration."
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
    ]
   },
   {
@@ -424,25 +451,6 @@
     "print(third_model)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Register fitted model for deployment"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "description = 'AutoML Model'\n",
-    "tags = None\n",
-    "remote_run.register_model(description=description, tags=tags)\n",
-    "remote_run.model_id # Use this id to deploy the model as a web service in Azure"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -459,8 +467,8 @@
    "outputs": [],
    "source": [
     "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[:10, :]\n",
-    "y_digits = digits.target[:10]\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
     "images = digits.images[:10]"
    ]
   },
@@ -468,7 +476,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Testing our best pipeline"
+    "#### Testing Our Best Fitted Model"
    ]
   },
   {
@@ -477,28 +485,26 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#Randomly select digits and test\n",
-    "for index in np.random.choice(len(y_digits), 2):\n",
+    "# Randomly select digits and test.\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
     "    print(index)\n",
-    "    predicted = fitted_model.predict(X_digits[index:index + 1])[0]\n",
-    "    label = y_digits[index]\n",
-    "    title = \"Label value = %d  Predicted value = %d \" % ( label,predicted)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
     "    fig = plt.figure(1, figsize=(3,3))\n",
     "    ax1 = fig.add_axes((0,0,.8,.8))\n",
     "    ax1.set_title(title)\n",
-    "    plt.imshow(images[index], cmap=plt.cm.gray_r, interpolation='nearest')\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
     "    plt.show()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/remote-execution-with-datastore/auto-ml-remote-execution-with-datastore.ipynb

@@ -13,15 +13,18 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 08: Remote Execution with Text file\n",
+    "# Automated Machine Learning: Remote Execution with DataStore\n",
     "\n",
-    "In this sample accesses a data file on a remote DSVM.  This is more efficient than reading the file from Blob storage in the get_data method.\n",
+    "This sample accesses a data file on a remote DSVM through DataStore. Advantages of using data store are:\n",
+    "1. DataStore secures the access details.\n",
+    "2. DataStore supports read, write to blob and file store\n",
+    "3. AutoML natively supports copying data from DataStore to DSVM\n",
     "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
     "In this notebook you would see\n",
-    "1. Configuring the DSVM to allow files to be access directly by the get_data method.\n",
-    "2. get_data returning data from a local file.\n",
+    "1. Storing data in DataStore.\n",
+    "2. get_data returning data from DataStore.\n",
     "\n"
    ]
   },
@@ -43,6 +46,7 @@
     "import logging\n",
     "import os\n",
     "import random\n",
+    "import time\n",
     "\n",
     "from matplotlib import pyplot as plt\n",
     "from matplotlib.pyplot import imshow\n",
@@ -51,6 +55,7 @@
     "from sklearn import datasets\n",
     "\n",
     "import azureml.core\n",
+    "from azureml.core.compute import DsvmCompute\n",
     "from azureml.core.experiment import Experiment\n",
     "from azureml.core.workspace import Workspace\n",
     "from azureml.train.automl import AutoMLConfig\n",
@@ -66,7 +71,7 @@
     "ws = Workspace.from_config()\n",
     "\n",
     "# choose a name for experiment\n",
-    "experiment_name = 'automl-remote-dsvm-file'\n",
+    "experiment_name = 'automl-remote-datastore-file'\n",
     "# project folder\n",
     "project_folder = './sample_projects/automl-remote-dsvm-file'\n",
     "\n",
@@ -119,26 +124,29 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.core.compute import DsvmCompute\n",
+    "compute_target_name = 'mydsvmc'\n",
     "\n",
-    "dsvm_name = 'mydsvm'\n",
     "try:\n",
-    "    dsvm_compute = DsvmCompute(ws, dsvm_name)\n",
-    "    print('found existing dsvm.')\n",
+    "    while ws.compute_targets[compute_target_name].provisioning_state == 'Creating':\n",
+    "        time.sleep(1)\n",
+    "        \n",
+    "    dsvm_compute = DsvmCompute(workspace=ws, name=compute_target_name)\n",
+    "    print('found existing:', dsvm_compute.name)\n",
     "except:\n",
-    "    print('creating new dsvm.')\n",
-    "    dsvm_config = DsvmCompute.provisioning_configuration(vm_size = \"Standard_D2_v2\")\n",
-    "    dsvm_compute = DsvmCompute.create(ws, name = dsvm_name, provisioning_configuration = dsvm_config)\n",
-    "    dsvm_compute.wait_for_completion(show_output = True)"
+    "    dsvm_config = DsvmCompute.provisioning_configuration(vm_size=\"Standard_D2_v2\")\n",
+    "    dsvm_compute = DsvmCompute.create(ws, name=compute_target_name, provisioning_configuration=dsvm_config)\n",
+    "    dsvm_compute.wait_for_completion(show_output=True)\n",
+    "    print(\"Waiting one minute for ssh to be accessible\")\n",
+    "    time.sleep(60) # Wait for ssh to be accessible"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Copy data file to the DSVM\n",
-    "Download the data file.\n",
-    "Copy the data file to the DSVM under the folder: /tmp/data"
+    "## Copy data file to local\n",
+    "\n",
+    "Download the data file.\n"
    ]
   },
   {
@@ -147,11 +155,114 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "df = pd.read_csv(\"https://automldemods.blob.core.windows.net/datasets/PlayaEvents2016,_1.6MB,_3.4k-rows.cleaned.2.tsv\",\n",
-    "                     delimiter=\"\\t\", quotechar='\"')\n",
-    "df.to_csv(\"data.tsv\", sep=\"\\t\", quotechar='\"', index=False)\n",
+    "mkdir data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from sklearn.datasets import fetch_20newsgroups\n",
+    "import csv\n",
     "\n",
-    "# Now copy the file data.tsv to the folder /tmp/data on the DSVM"
+    "remove = ('headers', 'footers', 'quotes')\n",
+    "categories = [\n",
+    "        'alt.atheism',\n",
+    "        'talk.religion.misc',\n",
+    "        'comp.graphics',\n",
+    "        'sci.space',\n",
+    "    ]\n",
+    "data_train = fetch_20newsgroups(subset = 'train', categories = categories,\n",
+    "                                    shuffle = True, random_state = 42,\n",
+    "                                    remove = remove)\n",
+    "    \n",
+    "pd.DataFrame(data_train.data).to_csv(\"data/X_train.tsv\", index=False, header=False, quoting=csv.QUOTE_ALL, sep=\"\\t\")\n",
+    "pd.DataFrame(data_train.target).to_csv(\"data/y_train.tsv\", index=False, header=False, sep=\"\\t\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Upload data to the cloud"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Now make the data accessible remotely by uploading that data from your local machine into Azure so it can be accessed for remote training. The datastore is a convenient construct associated with your workspace for you to upload/download data, and interact with it from your remote compute targets. It is backed by Azure blob storage account.\n",
+    "\n",
+    "The data.tsv files are uploaded into a directory named data at the root of the datastore."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Workspace, Datastore\n",
+    "#blob_datastore = Datastore(ws, blob_datastore_name)\n",
+    "ds = ws.get_default_datastore()\n",
+    "print(ds.datastore_type, ds.account_name, ds.container_name)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# ds.upload_files(\"data.tsv\")\n",
+    "ds.upload(src_dir='./data', target_path='data', overwrite=True, show_progress=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure & Run\n",
+    "\n",
+    "First let's create a DataReferenceConfigruation object to inform the system what data folder to download to the compute target.\n",
+    "The path_on_compute should be an absolute path to ensure that the data files are downloaded only once.   The get_data method should use this same path to access the data files."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.runconfig import DataReferenceConfiguration\n",
+    "dr = DataReferenceConfiguration(datastore_name=ds.name, \n",
+    "                   path_on_datastore='data', \n",
+    "                   path_on_compute='/tmp/azureml_runs',\n",
+    "                   mode='download', # download files from datastore to compute target\n",
+    "                   overwrite=False)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.runconfig import RunConfiguration\n",
+    "from azureml.core.conda_dependencies import CondaDependencies\n",
+    "\n",
+    "# create a new RunConfig object\n",
+    "conda_run_config = RunConfiguration(framework=\"python\")\n",
+    "\n",
+    "# Set compute target to the Linux DSVM\n",
+    "conda_run_config.target = dsvm_compute\n",
+    "# set the data reference of the run coonfiguration\n",
+    "conda_run_config.data_references = {ds.name: dr}\n",
+    "\n",
+    "cd = CondaDependencies.create(pip_packages=['azureml-sdk[automl]'], conda_packages=['numpy'])\n",
+    "conda_run_config.environment.python.conda_dependencies = cd"
    ]
   },
   {
@@ -161,7 +272,9 @@
     "## Create Get Data File\n",
     "For remote executions you should author a get_data.py file containing a get_data() function. This file should be in the root directory of the project. You can encapsulate code to read data either from a blob storage or local disk in this file.\n",
     "\n",
-    "The *get_data()* function returns a [dictionary](README.md#getdata)."
+    "The *get_data()* function returns a [dictionary](README.md#getdata).\n",
+    "\n",
+    "The read_csv uses the path_on_compute value specified in the DataReferenceConfiguration call plus the path_on_datastore folder and then the actual file name."
    ]
   },
   {
@@ -183,23 +296,12 @@
     "%%writefile $project_folder/get_data.py\n",
     "\n",
     "import pandas as pd\n",
-    "from sklearn.model_selection import train_test_split\n",
-    "from sklearn.preprocessing import LabelEncoder\n",
-    "import os\n",
     "\n",
     "def get_data():\n",
-    "    # Burning man 2016 data\n",
-    "    df = pd.read_csv('/tmp/data/data.tsv',\n",
-    "                     delimiter=\"\\t\", quotechar='\"')\n",
-    "    # get integer labels\n",
-    "    le = LabelEncoder()\n",
-    "    le.fit(df[\"Label\"].values)\n",
-    "    y = le.transform(df[\"Label\"].values)\n",
-    "    df = df.drop([\"Label\"], axis=1)\n",
+    "    X_train = pd.read_csv(\"/tmp/azureml_runs/data/X_train.tsv\", delimiter=\"\\t\", header=None, quotechar='\"')\n",
+    "    y_train = pd.read_csv(\"/tmp/azureml_runs/data/y_train.tsv\", delimiter=\"\\t\", header=None, quotechar='\"')\n",
     "\n",
-    "    df_train, _, y_train, _ = train_test_split(df, y, test_size=0.1, random_state=42)\n",
-    "\n",
-    "    return { \"X\" : df.values, \"y\" : y }"
+    "    return { \"X\" : X_train.values, \"y\" : y_train[0].values }"
    ]
   },
   {
@@ -210,16 +312,17 @@
     "\n",
     "You can specify automl_settings as **kwargs** as well. Also note that you can use the get_data() symantic for local excutions too. \n",
     "\n",
-    "<i>Note: For Remote DSVM and Batch AI you cannot pass Numpy arrays directly to the fit method.</i>\n",
+    "<i>Note: For Remote DSVM and Batch AI you cannot pass Numpy arrays directly to AutoMLConfig.</i>\n",
     "\n",
     "|Property|Description|\n",
     "|-|-|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration|\n",
     "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data|\n",
     "|**n_cross_validations**|Number of cross validation splits|\n",
-    "|**concurrent_iterations**|Max number of iterations that would be executed in parallel.  This should be less than the number of cores on the DSVM\n",
+    "|**max_concurrent_iterations**|Max number of iterations that would be executed in parallel.  This should be less than the number of cores on the DSVM\n",
     "|**preprocess**| *True/False* <br>Setting this to *True* enables Auto ML to perform preprocessing <br>on the input to handle *missing data*, and perform some common *feature extraction*|\n",
+    "|**enable_cache**|Setting this to *True* enables preprocess done once and reuse the same preprocessed data for all the iterations. Default value is True.|\n",
     "|**max_cores_per_iteration**| Indicates how many cores on the compute target would be used to train a single pipeline.<br> Default is *1*, you can set it to *-1* to use all cores|"
    ]
   },
@@ -230,18 +333,19 @@
    "outputs": [],
    "source": [
     "automl_settings = {\n",
-    "    \"max_time_sec\": 3600,\n",
-    "    \"iterations\": 10,\n",
+    "    \"iteration_timeout_minutes\": 60,\n",
+    "    \"iterations\": 4,\n",
     "    \"n_cross_validations\": 5,\n",
     "    \"primary_metric\": 'AUC_weighted',\n",
     "    \"preprocess\": True,\n",
-    "    \"max_cores_per_iteration\": 2,\n",
+    "    \"max_cores_per_iteration\": 1,\n",
     "    \"verbosity\": logging.INFO\n",
     "}\n",
     "automl_config = AutoMLConfig(task = 'classification',\n",
     "                             debug_log = 'automl_errors.log',\n",
     "                             path=project_folder,\n",
-    "                             compute_target = dsvm_compute,\n",
+    "                             run_configuration=conda_run_config,\n",
+    "                             #compute_target = dsvm_compute,\n",
     "                             data_script = project_folder + \"/get_data.py\",\n",
     "                             **automl_settings\n",
     "                            )"
@@ -251,7 +355,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Training the Model <a class=\"anchor\" id=\"Training-the-model-Remote-DSVM\"></a>\n",
+    "## Training the Models <a class=\"anchor\" id=\"Training-the-model-Remote-DSVM\"></a>\n",
     "\n",
     "For remote runs the execution is asynchronous, so you will see the iterations get populated as they complete. You can interact with the widgets/models even when the experiment is running to retreive the best model up to that point. Once you are satisfied with the model you can cancel a particular iteration or the whole run."
    ]
@@ -285,10 +389,20 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
     "RunDetails(remote_run).show() "
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Wait until the run finishes.\n",
+    "remote_run.wait_for_completion(show_output = True)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -319,7 +433,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Canceling runs\n",
+    "## Canceling Runs\n",
     "You can cancel ongoing remote runs using the *cancel()* and *cancel_iteration()* functions"
    ]
   },
@@ -336,13 +450,30 @@
     "# remote_run.cancel_iteration(1)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Pre-process cache cleanup\n",
+    "The preprocess data gets cache at user default file store. When the run is completed the cache can be cleaned by running below cell"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "remote_run.clean_preprocessor_cache()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "### Retrieve the Best Model\n",
     "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
+    "Below we select the best pipeline from our iterations. The *get_output* method returns the best run and the fitted model. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
    ]
   },
   {
@@ -392,7 +523,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Register fitted model for deployment"
+    "### Testing the Best Fitted Model <a class=\"anchor\" id=\"Testing-the-Fitted-Model-Remote-DSVM\"></a>\n"
    ]
   },
   {
@@ -401,62 +532,34 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "description = 'AutoML Model'\n",
-    "tags = None\n",
-    "remote_run.register_model(description=description, tags=tags)\n",
-    "remote_run.model_id # Use this id to deploy the model as a web service in Azure"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Testing the Fitted Model <a class=\"anchor\" id=\"Testing-the-Fitted-Model-Remote-DSVM\"></a>\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import sklearn\n",
-    "from sklearn.model_selection import train_test_split\n",
-    "from sklearn.preprocessing import LabelEncoder\n",
+    "# Load test data.\n",
     "from pandas_ml import ConfusionMatrix\n",
     "\n",
-    "df = pd.read_csv(\"https://automldemods.blob.core.windows.net/datasets/PlayaEvents2016,_1.6MB,_3.4k-rows.cleaned.2.tsv\",\n",
-    "                     delimiter=\"\\t\", quotechar='\"')\n",
+    "data_test = fetch_20newsgroups(subset = 'test', categories = categories,\n",
+    "                               shuffle = True, random_state = 42,\n",
+    "                               remove = remove)\n",
     "\n",
-    "# get integer labels\n",
-    "le = LabelEncoder()\n",
-    "le.fit(df[\"Label\"].values)\n",
-    "y = le.transform(df[\"Label\"].values)\n",
-    "df = df.drop([\"Label\"], axis=1)\n",
+    "X_test = np.array(data_test.data).reshape((len(data_test.data),1))\n",
+    "y_test = data_test.target\n",
     "\n",
-    "_, df_test, _, y_test = train_test_split(df, y, test_size=0.1, random_state=42)\n",
+    "# Test our best pipeline.\n",
     "\n",
-    "ypred = fitted_model.predict(df_test.values)\n",
-    "\n",
-    "ypred_strings = le.inverse_transform(ypred)\n",
-    "ytest_strings = le.inverse_transform(y_test)\n",
-    "\n",
-    "cm = ConfusionMatrix(ytest_strings, ypred_strings)\n",
+    "y_pred = fitted_model.predict(X_test)\n",
+    "y_pred_strings = [data_test.target_names[i] for i in y_pred]\n",
+    "y_test_strings = [data_test.target_names[i] for i in y_test]\n",
     "\n",
+    "cm = ConfusionMatrix(y_test_strings, y_pred_strings)\n",
     "print(cm)\n",
-    "\n",
     "cm.plot()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/remote-execution/auto-ml-remote-execution.ipynb

@@ -13,35 +13,35 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 03:  Remote Execution using DSVM (Ubuntu)\n",
+    "# Automated Machine Learning: Remote Execution using DSVM (Ubuntu)\n",
     "\n",
-    "In this example we use the scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) to showcase how you can use AutoML for a simple classification problem.\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use AutoML for a simple classification problem.\n",
     "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
-    "In this notebook you would see\n",
-    "1. Creating an Experiment using an existing Workspace\n",
-    "2. Attaching an existing DSVM to a workspace\n",
-    "3. Instantiating AutoMLConfig \n",
-    "4. Training the Model using the DSVM\n",
-    "5. Exploring the results\n",
-    "6. Testing the fitted model\n",
+    "In this notebook you wiil learn how to:\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Attach an existing DSVM to a workspace.\n",
+    "3. Configure AutoML using `AutoMLConfig`.\n",
+    "4. Train the model using the DSVM.\n",
+    "5. Explore the results.\n",
+    "6. Test the best fitted model.\n",
     "\n",
-    "In addition this notebook showcases the following features\n",
-    "- **Parallel** Executions for iterations\n",
-    "- Asyncronous tracking of progress\n",
-    "- **Cancelling** individual iterations or the entire run\n",
+    "In addition, this notebook showcases the following features:\n",
+    "- **Parallel** executions for iterations\n",
+    "- **Asynchronous** tracking of progress\n",
+    "- **Cancellation** of individual iterations or the entire run\n",
     "- Retrieving models for any iteration or logged metric\n",
-    "- specify automl settings as **kwargs**\n"
+    "- Specifying AutoML settings as `**kwargs`\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create Experiment\n",
+    "## Create an Experiment\n",
     "\n",
-    "As part of the setup you have already created a workspace. For AutoML you would need to create a <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
    ]
   },
   {
@@ -53,6 +53,7 @@
     "import logging\n",
     "import os\n",
     "import random\n",
+    "import time\n",
     "\n",
     "from matplotlib import pyplot as plt\n",
     "from matplotlib.pyplot import imshow\n",
@@ -75,12 +76,11 @@
    "source": [
     "ws = Workspace.from_config()\n",
     "\n",
-    "# choose a name for the run history container in the workspace\n",
+    "# Choose a name for the run history container in the workspace.\n",
     "experiment_name = 'automl-remote-dsvm4'\n",
-    "# project folder\n",
     "project_folder = './sample_projects/automl-remote-dsvm4'\n",
     "\n",
-    "experiment=Experiment(ws, experiment_name)\n",
+    "experiment = Experiment(ws, experiment_name)\n",
     "\n",
     "output = {}\n",
     "output['SDK version'] = azureml.core.VERSION\n",
@@ -100,7 +100,7 @@
    "source": [
     "## Diagnostics\n",
     "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
    ]
   },
   {
@@ -110,7 +110,7 @@
    "outputs": [],
    "source": [
     "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
+    "set_diagnostics_collection(send_diagnostics = True)"
    ]
   },
   {
@@ -118,9 +118,7 @@
    "metadata": {},
    "source": [
     "## Create a Remote Linux DSVM\n",
-    "Note: If creation fails with a message about Marketplace purchase eligibilty, go to portal.azure.com, start creating DSVM there, and select \"Want to create programmatically\" to enable programmatic creation. Once you've enabled it, you can exit without actually creating VM.\n",
-    "\n",
-    "**Note**: By default SSH runs on port 22 and you don't need to specify it. But if for security reasons you can switch to a different port (such as 5022), you can append the port number to the address. [Read more](https://render.githubusercontent.com/documentation/sdk/ssh-issue.md) on this."
+    "**Note:** If creation fails with a message about Marketplace purchase eligibilty, start creation of a DSVM through the [Azure portal](https://portal.azure.com), and select \"Want to create programmatically\" to enable programmatic creation. Once you've enabled this setting, you can exit the portal without actually creating the DSVM, and creation of the DSVM through the notebook should work.\n"
    ]
   },
   {
@@ -131,15 +129,36 @@
    "source": [
     "from azureml.core.compute import DsvmCompute\n",
     "\n",
-    "dsvm_name = 'mydsvm'\n",
+    "dsvm_name = 'mydsvma'\n",
     "try:\n",
     "    dsvm_compute = DsvmCompute(ws, dsvm_name)\n",
-    "    print('found existing dsvm.')\n",
+    "    print('Found an existing DSVM.')\n",
     "except:\n",
-    "    print('creating new dsvm.')\n",
+    "    print('Creating a new DSVM.')\n",
     "    dsvm_config = DsvmCompute.provisioning_configuration(vm_size = \"Standard_D2_v2\")\n",
     "    dsvm_compute = DsvmCompute.create(ws, name = dsvm_name, provisioning_configuration = dsvm_config)\n",
-    "    dsvm_compute.wait_for_completion(show_output = True)"
+    "    dsvm_compute.wait_for_completion(show_output = True)\n",
+    "    print(\"Waiting one minute for ssh to be accessible\")\n",
+    "    time.sleep(60) # Wait for ssh to be accessible"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.runconfig import RunConfiguration\n",
+    "from azureml.core.conda_dependencies import CondaDependencies\n",
+    "\n",
+    "# create a new RunConfig object\n",
+    "conda_run_config = RunConfiguration(framework=\"python\")\n",
+    "\n",
+    "# Set compute target to the Linux DSVM\n",
+    "conda_run_config.target = dsvm_compute\n",
+    "\n",
+    "cd = CondaDependencies.create(pip_packages=['azureml-sdk[automl]'], conda_packages=['numpy'])\n",
+    "conda_run_config.environment.python.conda_dependencies = cd"
    ]
   },
   {
@@ -147,7 +166,8 @@
    "metadata": {},
    "source": [
     "## Create Get Data File\n",
-    "For remote executions you should author a get_data.py file containing a get_data() function. This file should be in the root directory of the project. You can encapsulate code to read data either from a blob storage or local disk in this file."
+    "For remote executions you should author a `get_data.py` file containing a `get_data()` function. This file should be in the root directory of the project. You can encapsulate code to read data either from a blob storage or local disk in this file.\n",
+    "In this example, the `get_data()` function returns data using scikit-learn's [load_digits](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) method."
    ]
   },
   {
@@ -175,29 +195,29 @@
     "def get_data():\n",
     "    \n",
     "    digits = datasets.load_digits()\n",
-    "    X_digits = digits.data[100:,:]\n",
-    "    y_digits = digits.target[100:]\n",
+    "    X_train = digits.data[100:,:]\n",
+    "    y_train = digits.target[100:]\n",
     "\n",
-    "    return { \"X\" : X_digits, \"y\" : y_digits }"
+    "    return { \"X\" : X_train, \"y\" : y_train }"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Instantiate AutoML <a class=\"anchor\" id=\"Instatiate-AutoML-Remote-DSVM\"></a>\n",
+    "## Configure AutoML <a class=\"anchor\" id=\"Instantiate-AutoML-Remote-DSVM\"></a>\n",
     "\n",
-    "You can specify automl_settings as **kwargs** as well. Also note that you can use the get_data() symantic for local excutions too. \n",
+    "You can specify `automl_settings` as `**kwargs` as well. Also note that you can use a `get_data()` function for local excutions too.\n",
     "\n",
-    "<i>Note: For Remote DSVM and Batch AI you cannot pass Numpy arrays directly to the fit method.</i>\n",
+    "**Note:** When using Remote DSVM, you can't pass Numpy arrays directly to the fit method.\n",
     "\n",
     "|Property|Description|\n",
     "|-|-|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data|\n",
-    "|**n_cross_validations**|Number of cross validation splits|\n",
-    "|**concurrent_iterations**|Max number of iterations that would be executed in parallel.  This should be less than the number of cores on the DSVM."
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**max_concurrent_iterations**|Maximum number of iterations to execute in parallel. This should be less than the number of cores on the DSVM.|"
    ]
   },
   {
@@ -207,19 +227,19 @@
    "outputs": [],
    "source": [
     "automl_settings = {\n",
-    "    \"max_time_sec\": 600,\n",
+    "    \"iteration_timeout_minutes\": 10,\n",
     "    \"iterations\": 20,\n",
     "    \"n_cross_validations\": 5,\n",
     "    \"primary_metric\": 'AUC_weighted',\n",
     "    \"preprocess\": False,\n",
-    "    \"concurrent_iterations\": 2,\n",
+    "    \"max_concurrent_iterations\": 2,\n",
     "    \"verbosity\": logging.INFO\n",
     "}\n",
     "\n",
     "automl_config = AutoMLConfig(task = 'classification',\n",
     "                             debug_log = 'automl_errors.log',\n",
-    "                             path=project_folder, \n",
-    "                             compute_target = dsvm_compute,\n",
+    "                             path = project_folder, \n",
+    "                             run_configuration=conda_run_config,\n",
     "                             data_script = project_folder + \"/get_data.py\",\n",
     "                             **automl_settings\n",
     "                            )\n"
@@ -229,7 +249,18 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "<b>Note</b> that the first run on a new DSVM may take a several minutes to preparing the environment."
+    "**Note:** The first run on a new DSVM may take several minutes to prepare the environment."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. For remote runs the execution is asynchronous, so you will see the iterations get populated as they complete. You can interact with the widgets and models even when the experiment is running to retrieve the best model up to that point. Once you are satisfied with the model, you can cancel a particular iteration or the whole run.\n",
+    "\n",
+    "In this example, we specify `show_output = False` to suppress console output while the run is in progress."
    ]
   },
   {
@@ -238,37 +269,37 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "remote_run = experiment.submit(automl_config, show_output=False)"
+    "remote_run = experiment.submit(automl_config, show_output = False)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Exploring the Results\n",
+    "## Explore the Results\n",
     "\n",
-    "#### Loading executed runs\n",
-    "In case you need to load a previously executed run given a run id please enable the below cell"
+    "#### Loading Executed Runs\n",
+    "In case you need to load a previously executed run, enable the cell below and replace the `run_id` value."
    ]
   },
   {
    "cell_type": "raw",
    "metadata": {},
    "source": [
-    "remote_run = AutoMLRun(experiment=experiment, run_id='AutoML_480d3ed6-fc94-44aa-8f4e-0b945db9d3ef')"
+    "remote_run = AutoMLRun(experiment=experiment, run_id = 'AutoML_480d3ed6-fc94-44aa-8f4e-0b945db9d3ef')"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Widget for monitoring runs\n",
+    "#### Widget for Monitoring Runs\n",
     "\n",
-    "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
     "\n",
-    "You can click on a pipeline to see run properties and output logs.  Logs are also available on the DSVM under /tmp/azureml_run/{iterationid}/azureml-logs\n",
+    "You can click on a pipeline to see run properties and output logs.  Logs are also available on the DSVM under `/tmp/azureml_run/{iterationid}/azureml-logs`\n",
     "\n",
-    "NOTE: The widget displays a link at the bottom. This links to a web-ui to explore the individual run details."
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
    ]
   },
   {
@@ -277,7 +308,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
     "RunDetails(remote_run).show() "
    ]
   },
@@ -287,7 +318,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# wait till the run finishes\n",
+    "# Wait until the run finishes.\n",
     "remote_run.wait_for_completion(show_output = True)"
    ]
   },
@@ -297,7 +328,7 @@
    "source": [
     "\n",
     "#### Retrieve All Child Runs\n",
-    "You can also use sdk methods to fetch all the child runs and see individual metrics that we log. "
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
    ]
   },
   {
@@ -321,9 +352,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Canceling runs\n",
+    "## Cancelling Runs\n",
     "\n",
-    "You can cancel ongoing remote runs using the *cancel()* and *cancel_iteration()* functions"
+    "You can cancel ongoing remote runs using the `cancel` and `cancel_iteration` functions."
    ]
   },
   {
@@ -332,10 +363,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Cancel the ongoing experiment and stop scheduling new iterations\n",
+    "# Cancel the ongoing experiment and stop scheduling new iterations.\n",
     "# remote_run.cancel()\n",
     "\n",
-    "# Cancel iteration 1 and move onto iteration 2\n",
+    "# Cancel iteration 1 and move onto iteration 2.\n",
     "# remote_run.cancel_iteration(1)"
    ]
   },
@@ -345,7 +376,7 @@
    "source": [
     "### Retrieve the Best Model\n",
     "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
    ]
   },
   {
@@ -363,8 +394,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Best Model based on any other metric\n",
-    "Show the run/model which has the smallest `log_loss` value."
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model which has the smallest `log_loss` value:"
    ]
   },
   {
@@ -383,8 +414,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Model from a specific iteration\n",
-    "Show the run and model from the 3rd iteration."
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
    ]
   },
   {
@@ -394,7 +425,7 @@
    "outputs": [],
    "source": [
     "iteration = 3\n",
-    "third_run, third_model = remote_run.get_output(iteration=iteration)\n",
+    "third_run, third_model = remote_run.get_output(iteration = iteration)\n",
     "print(third_run)\n",
     "print(third_model)"
    ]
@@ -403,7 +434,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Testing the Fitted Model <a class=\"anchor\" id=\"Testing-the-Fitted-Model-Remote-DSVM\"></a>\n",
+    "### Test the Best Fitted Model <a class=\"anchor\" id=\"Testing-the-Fitted-Model-Remote-DSVM\"></a>\n",
     "\n",
     "#### Load Test Data"
    ]
@@ -415,8 +446,8 @@
    "outputs": [],
    "source": [
     "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[:10, :]\n",
-    "y_digits = digits.target[:10]\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
     "images = digits.images[:10]"
    ]
   },
@@ -424,7 +455,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Testing our best pipeline"
+    "#### Test Our Best Fitted Model"
    ]
   },
   {
@@ -433,21 +464,26 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#Randomly select digits and test\n",
-    "for index in np.random.choice(len(y_digits), 2):\n",
+    "# Randomly select digits and test.\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
     "    print(index)\n",
-    "    predicted = fitted_model.predict(X_digits[index:index + 1])[0]\n",
-    "    label = y_digits[index]\n",
-    "    title = \"Label value = %d  Predicted value = %d \" % ( label,predicted)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
     "    fig = plt.figure(1, figsize=(3,3))\n",
     "    ax1 = fig.add_axes((0,0,.8,.8))\n",
     "    ax1.set_title(title)\n",
-    "    plt.imshow(images[index], cmap=plt.cm.gray_r, interpolation='nearest')\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
     "    plt.show()"
    ]
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/sample-weight/auto-ml-sample-weight.ipynb

@@ -13,26 +13,22 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 11: Sample weight\n",
+    "# Automated Machine Learning: Sample Weight\n",
     "\n",
-    "In this example we use the scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) to showcase how you can use sample weight with the AutoML Classifier.\n",
-    "Sample weight is used where some sample values are more important than others.\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use sample weight with AutoML. Sample weight is used where some sample values are more important than others.\n",
     "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
-    "In this notebook you would see\n",
-    "1. How to specifying sample_weight\n",
-    "2. The difference that it makes to test results\n",
-    "\n"
+    "In this notebook you will learn how to configure AutoML to use `sample_weight` and you will see the difference sample weight makes to the test results.\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create Experiment\n",
+    "## Create an Experiment\n",
     "\n",
-    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
    ]
   },
   {
@@ -66,14 +62,13 @@
    "source": [
     "ws = Workspace.from_config()\n",
     "\n",
-    "# choose a name for experiment\n",
+    "# Choose names for the regular and the sample weight experiments.\n",
     "experiment_name = 'non_sample_weight_experiment'\n",
     "sample_weight_experiment_name = 'sample_weight_experiment'\n",
     "\n",
-    "# project folder\n",
     "project_folder = './sample_projects/automl-local-classification'\n",
     "\n",
-    "experiment=Experiment(ws, experiment_name)\n",
+    "experiment = Experiment(ws, experiment_name)\n",
     "sample_weight_experiment=Experiment(ws, sample_weight_experiment_name)\n",
     "\n",
     "output = {}\n",
@@ -94,7 +89,7 @@
    "source": [
     "## Diagnostics\n",
     "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
    ]
   },
   {
@@ -104,16 +99,16 @@
    "outputs": [],
    "source": [
     "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
+    "set_diagnostics_collection(send_diagnostics = True)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Instantiate Auto ML Config\n",
+    "## Configure AutoML\n",
     "\n",
-    "Instantiate two AutoMLConfig Objects. One will be used with sample_weight and one without."
+    "Instantiate two `AutoMLConfig` objects. One will be used with `sample_weight` and one without."
    ]
   },
   {
@@ -123,45 +118,45 @@
    "outputs": [],
    "source": [
     "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[100:,:]\n",
-    "y_digits = digits.target[100:]\n",
+    "X_train = digits.data[100:,:]\n",
+    "y_train = digits.target[100:]\n",
     "\n",
     "# The example makes the sample weight 0.9 for the digit 4 and 0.1 for all other digits.\n",
     "# This makes the model more likely to classify as 4 if the image it not clear.\n",
-    "sample_weight = np.array([(0.9 if x == 4 else 0.01) for x in y_digits])\n",
+    "sample_weight = np.array([(0.9 if x == 4 else 0.01) for x in y_train])\n",
     "\n",
     "automl_classifier = AutoMLConfig(task = 'classification',\n",
     "                                 debug_log = 'automl_errors.log',\n",
     "                                 primary_metric = 'AUC_weighted',\n",
-    "                                 max_time_sec = 3600,\n",
+    "                                 iteration_timeout_minutes = 60,\n",
     "                                 iterations = 10,\n",
     "                                 n_cross_validations = 2,\n",
     "                                 verbosity = logging.INFO,\n",
-    "                                 X = X_digits, \n",
-    "                                 y = y_digits,\n",
-    "                                 path=project_folder)\n",
+    "                                 X = X_train, \n",
+    "                                 y = y_train,\n",
+    "                                 path = project_folder)\n",
     "\n",
     "automl_sample_weight = AutoMLConfig(task = 'classification',\n",
     "                                    debug_log = 'automl_errors.log',\n",
     "                                    primary_metric = 'AUC_weighted',\n",
-    "                                    max_time_sec = 3600,\n",
+    "                                    iteration_timeout_minutes = 60,\n",
     "                                    iterations = 10,\n",
     "                                    n_cross_validations = 2,\n",
     "                                    verbosity = logging.INFO,\n",
-    "                                    X = X_digits, \n",
-    "                                    y = y_digits,\n",
+    "                                    X = X_train, \n",
+    "                                    y = y_train,\n",
     "                                    sample_weight = sample_weight,\n",
-    "                                    path=project_folder)"
+    "                                    path = project_folder)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Training the Models\n",
+    "## Train the Models\n",
     "\n",
-    "Call the submit method on the experiment and pass the configuration. For Local runs the execution is synchronous. Depending on the data and number of iterations this can run for while.\n",
-    "You will see the currently running iterations printing to the console."
+    "Call the `submit` method on the experiment objects and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
    ]
   },
   {
@@ -170,8 +165,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "local_run = experiment.submit(automl_classifier, show_output=True)\n",
-    "sample_weight_run = sample_weight_experiment.submit(automl_sample_weight, show_output=True)\n",
+    "local_run = experiment.submit(automl_classifier, show_output = True)\n",
+    "sample_weight_run = sample_weight_experiment.submit(automl_sample_weight, show_output = True)\n",
     "\n",
     "best_run, fitted_model = local_run.get_output()\n",
     "best_run_sample_weight, fitted_model_sample_weight = sample_weight_run.get_output()"
@@ -181,7 +176,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Testing the Fitted Models\n",
+    "### Test the Best Fitted Model\n",
     "\n",
     "#### Load Test Data"
    ]
@@ -193,8 +188,8 @@
    "outputs": [],
    "source": [
     "digits = datasets.load_digits()\n",
-    "X_digits = digits.data[:100, :]\n",
-    "y_digits = digits.target[:100]\n",
+    "X_test = digits.data[:100, :]\n",
+    "y_test = digits.target[:100]\n",
     "images = digits.images[:100]"
    ]
   },
@@ -202,7 +197,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Compare the pipelines\n",
+    "#### Compare the Models\n",
     "The prediction from the sample weight model is more likely to correctly predict 4's.  However, it is also more likely to predict 4 for some images that are not labelled as 4."
    ]
   },
@@ -212,22 +207,27 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#Randomly select digits and test\n",
-    "for index in range(0,len(y_digits)):\n",
-    "    predicted = fitted_model.predict(X_digits[index:index + 1])[0]\n",
-    "    predicted_sample_weight = fitted_model_sample_weight.predict(X_digits[index:index + 1])[0]\n",
-    "    label = y_digits[index]\n",
+    "# Randomly select digits and test.\n",
+    "for index in range(0,len(y_test)):\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    predicted_sample_weight = fitted_model_sample_weight.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
     "    if predicted == 4 or predicted_sample_weight == 4 or label == 4:\n",
-    "        title = \"Label value = %d  Predicted value = %d Prediced with sample weight = %d\" % ( label,predicted,predicted_sample_weight)\n",
+    "        title = \"Label value = %d  Predicted value = %d Prediced with sample weight = %d\" % (label, predicted, predicted_sample_weight)\n",
     "        fig = plt.figure(1, figsize=(3,3))\n",
     "        ax1 = fig.add_axes((0,0,.8,.8))\n",
     "        ax1.set_title(title)\n",
-    "        plt.imshow(images[index], cmap=plt.cm.gray_r, interpolation='nearest')\n",
+    "        plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
     "        plt.show()"
    ]
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/automated-machine-learning/sparse-data-train-test-split/auto-ml-sparse-data-train-test-split.ipynb

@@ -13,31 +13,31 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# AutoML 06: Custom CV splits, handling sparse data\n",
+    "# Automated Machine Learning: Train Test Split and Handling Sparse Data\n",
     "\n",
-    "In this example we use the scikit learn's [20newsgroup](In this example we use the scikit learn's [digit dataset](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_digits.html) to showcase how you can use AutoML for handling sparse data and specify custom cross validation splits.\n",
+    "In this example we use the scikit-learn's [20newsgroup](http://scikit-learn.org/stable/modules/generated/sklearn.datasets.fetch_20newsgroups.html) to showcase how you can use AutoML for handling sparse data and how to specify custom cross validations splits.\n",
     "\n",
-    "Make sure you have executed the [00.configuration](00.configuration.ipynb) before running this notebook.\n",
+    "Make sure you have executed the [configuration](../configuration.ipynb) before running this notebook.\n",
     "\n",
-    "In this notebook you would see\n",
-    "1. Creating an Experiment using an existing Workspace\n",
-    "2. Instantiating AutoMLConfig\n",
-    "4. Training the Model\n",
-    "5. Exploring the results\n",
-    "6. Testing the fitted model\n",
+    "In this notebook you will learn how to:\n",
+    "1. Create an `Experiment` in an existing `Workspace`.\n",
+    "2. Configure AutoML using `AutoMLConfig`.\n",
+    "4. Train the model.\n",
+    "5. Explore the results.\n",
+    "6. Test the best fitted model.\n",
     "\n",
     "In addition this notebook showcases the following features\n",
-    "- **Custom CV** splits \n",
-    "- Handling **Sparse Data** in the input"
+    "- Explicit train test splits \n",
+    "- Handling **sparse data** in the input"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create Experiment\n",
+    "## Create an Experiment\n",
     "\n",
-    "As part of the setup you have already created a <b>Workspace</b>. For AutoML you would need to create an <b>Experiment</b>. An <b>Experiment</b> is a named object in a <b>Workspace</b>, which is used to run experiments."
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
    ]
   },
   {
@@ -96,7 +96,7 @@
    "source": [
     "## Diagnostics\n",
     "\n",
-    "Opt-in diagnostics for better experience, quality, and security of future releases"
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
    ]
   },
   {
@@ -106,7 +106,7 @@
    "outputs": [],
    "source": [
     "from azureml.telemetry import set_diagnostics_collection\n",
-    "set_diagnostics_collection(send_diagnostics=True)"
+    "set_diagnostics_collection(send_diagnostics = True)"
    ]
   },
   {
@@ -133,21 +133,21 @@
     "    'comp.graphics',\n",
     "    'sci.space',\n",
     "]\n",
-    "data_train = fetch_20newsgroups(subset='train', categories=categories,\n",
-    "                                shuffle=True, random_state=42,\n",
-    "                                remove=remove)\n",
+    "data_train = fetch_20newsgroups(subset = 'train', categories = categories,\n",
+    "                                shuffle = True, random_state = 42,\n",
+    "                                remove = remove)\n",
     "\n",
-    "X_train, X_validation, y_train, y_validation = train_test_split(data_train.data, data_train.target, test_size=0.33, random_state=42)\n",
+    "X_train, X_valid, y_train, y_valid = train_test_split(data_train.data, data_train.target, test_size = 0.33, random_state = 42)\n",
     "\n",
     "\n",
-    "vectorizer = HashingVectorizer(stop_words='english', alternate_sign=False,\n",
-    "                               n_features=2**16)\n",
+    "vectorizer = HashingVectorizer(stop_words = 'english', alternate_sign = False,\n",
+    "                               n_features = 2**16)\n",
     "X_train = vectorizer.transform(X_train)\n",
-    "X_validation = vectorizer.transform(X_validation)\n",
+    "X_valid = vectorizer.transform(X_valid)\n",
     "\n",
     "summary_df = pd.DataFrame(index = ['No of Samples', 'No of Features'])\n",
     "summary_df['Train Set'] = [X_train.shape[0], X_train.shape[1]]\n",
-    "summary_df['Validation Set'] = [X_validation.shape[0], X_validation.shape[1]]\n",
+    "summary_df['Validation Set'] = [X_valid.shape[0], X_valid.shape[1]]\n",
     "summary_df"
    ]
   },
@@ -155,22 +155,22 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Instantiate Auto ML Config\n",
+    "## Configure AutoML\n",
     "\n",
-    "This defines the settings and data used to run the experiment.\n",
+    "Instantiate an `AutoMLConfig` object to specify the settings and data used to run the experiment.\n",
     "\n",
     "|Property|Description|\n",
     "|-|-|\n",
     "|**task**|classification or regression|\n",
-    "|**primary_metric**|This is the metric that you want to optimize.<br> Classification supports the following primary metrics <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>balanced_accuracy</i><br><i>average_precision_score_weighted</i><br><i>precision_score_weighted</i>|\n",
-    "|**max_time_sec**|Time limit in seconds for each iteration|\n",
-    "|**iterations**|Number of iterations. In each iteration Auto ML trains a specific pipeline with the data|\n",
-    "|**preprocess**| *True/False* <br>Setting this to *True* enables Auto ML to perform preprocessing <br>on the input to handle *missing data*, and perform some common *feature extraction*<br>*Note: If input data is Sparse you cannot use preprocess=True*|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**preprocess**|Setting this to *True* enables AutoML to perform preprocessing on the input to handle *missing data*, and to perform some common *feature extraction*.<br>**Note:** If input data is sparse, you cannot use *True*.|\n",
     "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
-    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification.  This should be an array of integers. |\n",
-    "|**X_valid**|(sparse) array-like, shape = [n_samples, n_features] for the custom Validation set|\n",
-    "|**y_valid**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. for the custom Validation set|\n",
-    "|**path**|Relative path to the project folder.  AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. This should be an array of integers.|\n",
+    "|**X_valid**|(sparse) array-like, shape = [n_samples, n_features] for the custom validation set.|\n",
+    "|**y_valid**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification for the custom validation set.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|"
    ]
   },
   {
@@ -180,27 +180,27 @@
    "outputs": [],
    "source": [
     "automl_config = AutoMLConfig(task = 'classification',\n",
-    "                             debug_log='automl_errors.log',\n",
-    "                             primary_metric='AUC_weighted',\n",
-    "                             max_time_sec=3600,\n",
-    "                             iterations=5,\n",
-    "                             preprocess=False,\n",
-    "                             verbosity=logging.INFO,\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             primary_metric = 'AUC_weighted',\n",
+    "                             iteration_timeout_minutes = 60,\n",
+    "                             iterations = 5,\n",
+    "                             preprocess = False,\n",
+    "                             verbosity = logging.INFO,\n",
     "                             X = X_train, \n",
     "                             y = y_train,\n",
-    "                             X_valid = X_validation, \n",
-    "                             y_valid = y_validation, \n",
-    "                             path=project_folder)"
+    "                             X_valid = X_valid, \n",
+    "                             y_valid = y_valid, \n",
+    "                             path = project_folder)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Training the Model\n",
+    "## Train the Models\n",
     "\n",
-    "You can call the submit method on the experiment object and pass the run configuration. For Local runs the execution is synchronous. Depending on the data and number of iterations this can run for while.\n",
-    "You will see the currently running iterations printing to the console."
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
    ]
   },
   {
@@ -216,18 +216,18 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Exploring the results"
+    "## Explore the Results"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Widget for monitoring runs\n",
+    "#### Widget for Monitoring Runs\n",
     "\n",
-    "The widget will sit on \"loading\" until the first iteration completed, then you will see an auto-updating graph and table show up. It refreshed once per minute, so you should see the graph update as child runs complete.\n",
+    "The widget will first report a \"loading\" status while running the first iteration. After completing the first iteration, an auto-updating graph and table will be shown. The widget will refresh once per minute, so you should see the graph update as child runs complete.\n",
     "\n",
-    "NOTE: The widget displays a link at the bottom. This links to a web-ui to explore the individual run details."
+    "**Note:** The widget displays a link at the bottom. Use this link to open a web interface to explore the individual run details."
    ]
   },
   {
@@ -236,7 +236,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
     "RunDetails(local_run).show() "
    ]
   },
@@ -246,7 +246,7 @@
    "source": [
     "\n",
     "#### Retrieve All Child Runs\n",
-    "You can also use sdk methods to fetch all the child runs and see individual metrics that we log. "
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
    ]
   },
   {
@@ -259,27 +259,20 @@
     "metricslist = {}\n",
     "for run in children:\n",
     "    properties = run.get_properties()\n",
-    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}\n",
     "    metricslist[int(properties['iteration'])] = metrics\n",
     "    \n",
     "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
     "rundata"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "### Retrieve the Best Model\n",
     "\n",
-    "Below we select the best pipeline from our iterations. The *get_output* method on automl_classifier returns the best run and the fitted model for the last *fit* invocation. There are overloads on *get_output* that allow you to retrieve the best run and fitted model for *any* logged metric or a particular *iteration*."
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
    ]
   },
   {
@@ -295,7 +288,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Best Model based on any other metric"
+    "#### Best Model Based on Any Other Metric\n",
+    "Show the run and the model which has the smallest `accuracy` value:"
    ]
   },
   {
@@ -305,14 +299,15 @@
    "outputs": [],
    "source": [
     "# lookup_metric = \"accuracy\"\n",
-    "# best_run, fitted_model = local_run.get_output(metric=lookup_metric)"
+    "# best_run, fitted_model = local_run.get_output(metric = lookup_metric)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Model from a specific iteration"
+    "#### Model from a Specific Iteration\n",
+    "Show the run and the model from the third iteration:"
    ]
   },
   {
@@ -322,14 +317,14 @@
    "outputs": [],
    "source": [
     "# iteration = 3\n",
-    "# best_run, fitted_model = local_run.get_output(iteration=iteration)"
+    "# best_run, fitted_model = local_run.get_output(iteration = iteration)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Register fitted model for deployment"
+    "### Testing the Best Fitted Model"
    ]
   },
   {
@@ -338,63 +333,34 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "description = 'AutoML Model'\n",
-    "tags = None\n",
-    "local_run.register_model(description=description, tags=tags)\n",
-    "local_run.model_id # Use this id to deploy the model as a web service in Azure"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Testing the Fitted Model "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "digits = datasets.load_digits()### Testing the Fitted Model\n",
-    "\n",
-    "#### Load Test Data\n",
-    "import sklearn\n",
+    "# Load test data.\n",
     "from pandas_ml import ConfusionMatrix\n",
     "\n",
-    "remove = ('headers', 'footers', 'quotes')\n",
-    "categories = [\n",
-    "    'alt.atheism',\n",
-    "    'talk.religion.misc',\n",
-    "    'comp.graphics',\n",
-    "    'sci.space',\n",
-    "]\n",
-    "\n",
-    "\n",
-    "data_test = fetch_20newsgroups(subset='test', categories=categories,\n",
-    "                                shuffle=True, random_state=42,\n",
-    "                                remove=remove)\n",
-    "\n",
-    "vectorizer = HashingVectorizer(stop_words='english', alternate_sign=False,\n",
-    "                               n_features=2**16)\n",
+    "data_test = fetch_20newsgroups(subset = 'test', categories = categories,\n",
+    "                               shuffle = True, random_state = 42,\n",
+    "                               remove = remove)\n",
     "\n",
     "X_test = vectorizer.transform(data_test.data)\n",
     "y_test = data_test.target\n",
     "\n",
-    "#### Testing our best pipeline\n",
+    "# Test our best pipeline.\n",
     "\n",
-    "ypred = fitted_model.predict(X_test)\n",
-    "ypred_strings = [categories[i] for i in ypred]\n",
-    "ytest_strings = [categories[i] for i in y_test]\n",
+    "y_pred = fitted_model.predict(X_test)\n",
+    "y_pred_strings = [data_test.target_names[i] for i in y_pred]\n",
+    "y_test_strings = [data_test.target_names[i] for i in y_test]\n",
     "\n",
-    "cm = ConfusionMatrix(ytest_strings, ypred_strings)\n",
+    "cm = ConfusionMatrix(y_test_strings, y_pred_strings)\n",
     "print(cm)\n",
     "cm.plot()"
    ]
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/azure-databricks/01.Installation_and_Configuration.ipynb

@@ -0,0 +1,179 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Azure ML & Azure Databricks notebooks by Parashar Shah.\n",
+        "\n",
+        "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+        "\n",
+        "Licensed under the MIT License."
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "We support installing AML SDK as library from GUI. When attaching a library follow this https://docs.databricks.com/user-guide/libraries.html and add the below string as your PyPi package. You can select the option to attach the library to all clusters or just one cluster.\n",
+        "\n",
+        "**azureml-sdk**\n",
+        "* Source: Upload Python Egg or PyPi\n",
+        "* PyPi Name: `azureml-sdk[databricks]`\n",
+        "* Select Install Library"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import azureml.core\n",
+        "\n",
+        "# Check core SDK version number - based on build number of preview/master.\n",
+        "print(\"SDK version:\", azureml.core.VERSION)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "![04ACI](files/tables/image2b.JPG)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "Please specify the Azure subscription Id, resource group name, workspace name, and the region in which you want to create the Azure Machine Learning Workspace.\n",
+        "\n",
+        "You can get the value of your Azure subscription ID from the Azure Portal, and then selecting Subscriptions from the menu on the left.\n",
+        "\n",
+        "For the resource_group, use the name of the resource group that contains your Azure Databricks Workspace.\n",
+        "\n",
+        "NOTE: If you provide a resource group name that does not exist, the resource group will be automatically created. This may or may not succeed in your environment, depending on the permissions you have on your Azure Subscription."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "# subscription_id = \"<your-subscription-id>\"\n",
+        "# resource_group = \"<your-existing-resource-group>\"\n",
+        "# workspace_name = \"<a-new-or-existing-workspace; it is unrelated to Databricks workspace>\"\n",
+        "# workspace_region = \"<your-resource group-region>\""
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "# import the Workspace class and check the azureml SDK version\n",
+        "# exist_ok checks if workspace exists or not.\n",
+        "\n",
+        "from azureml.core import Workspace\n",
+        "\n",
+        "ws = Workspace.create(name = workspace_name,\n",
+        "                      subscription_id = subscription_id,\n",
+        "                      resource_group = resource_group, \n",
+        "                      location = workspace_region,\n",
+        "                      exist_ok=True)"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "#get workspace details\n",
+        "ws.get_details()"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "ws = Workspace(workspace_name = workspace_name,\n",
+        "               subscription_id = subscription_id,\n",
+        "               resource_group = resource_group)\n",
+        "\n",
+        "# persist the subscription id, resource group name, and workspace name in aml_config/config.json.\n",
+        "ws.write_config()\n",
+        "##if you need to give a different path/filename please use this\n",
+        "##write_config(path=\"/databricks/driver/aml_config/\",file_name=<alias_conf.cfg>)"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "help(Workspace)"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "# import the Workspace class and check the azureml SDK version\n",
+        "from azureml.core import Workspace\n",
+        "\n",
+        "ws = Workspace.from_config()\n",
+        "#ws = Workspace.from_config(<full path>)\n",
+        "print('Workspace name: ' + ws.name, \n",
+        "      'Azure region: ' + ws.location, \n",
+        "      'Subscription id: ' + ws.subscription_id, \n",
+        "      'Resource group: ' + ws.resource_group, sep = '\\n')"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {},
+      "outputs": [],
+      "source": []
+    }
+  ],
+  "metadata": {
+    "authors": [
+      {
+        "name": "pasha"
+      },
+      {
+        "name": "wamartin"
+      }
+    ],
+    "kernelspec": {
+      "display_name": "Python 3.6",
+      "language": "python",
+      "name": "python36"
+    },
+    "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.7.0"
+    },
+    "name": "01.Installation_and_Configuration",
+    "notebookId": 3836944406456490
+  },
+  "nbformat": 4,
+  "nbformat_minor": 1
+}

how-to-use-azureml/azure-databricks/02.Ingest_data.ipynb

@@ -0,0 +1,182 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Azure ML & Azure Databricks notebooks by Parashar Shah.\n",
+    "\n",
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "![04ACI](files/tables/image1.JPG)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#Data Ingestion"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "import urllib"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Download AdultCensusIncome.csv from Azure CDN. This file has 32,561 rows.\n",
+    "basedataurl = \"https://amldockerdatasets.azureedge.net\"\n",
+    "datafile = \"AdultCensusIncome.csv\"\n",
+    "datafile_dbfs = os.path.join(\"/dbfs\", datafile)\n",
+    "\n",
+    "if os.path.isfile(datafile_dbfs):\n",
+    "    print(\"found {} at {}\".format(datafile, datafile_dbfs))\n",
+    "else:\n",
+    "    print(\"downloading {} to {}\".format(datafile, datafile_dbfs))\n",
+    "    urllib.request.urlretrieve(os.path.join(basedataurl, datafile), datafile_dbfs)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Create a Spark dataframe out of the csv file.\n",
+    "data_all = sqlContext.read.format('csv').options(header='true', inferSchema='true', ignoreLeadingWhiteSpace='true', ignoreTrailingWhiteSpace='true').load(datafile)\n",
+    "print(\"({}, {})\".format(data_all.count(), len(data_all.columns)))\n",
+    "data_all.printSchema()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#renaming columns\n",
+    "columns_new = [col.replace(\"-\", \"_\") for col in data_all.columns]\n",
+    "data_all = data_all.toDF(*columns_new)\n",
+    "data_all.printSchema()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "display(data_all.limit(5))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#Data Preparation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Choose feature columns and the label column.\n",
+    "label = \"income\"\n",
+    "xvars = set(data_all.columns) - {label}\n",
+    "\n",
+    "print(\"label = {}\".format(label))\n",
+    "print(\"features = {}\".format(xvars))\n",
+    "\n",
+    "data = data_all.select([*xvars, label])\n",
+    "\n",
+    "# Split data into train and test.\n",
+    "train, test = data.randomSplit([0.75, 0.25], seed=123)\n",
+    "\n",
+    "print(\"train ({}, {})\".format(train.count(), len(train.columns)))\n",
+    "print(\"test ({}, {})\".format(test.count(), len(test.columns)))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#Data Persistence"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Write the train and test data sets to intermediate storage\n",
+    "train_data_path = \"AdultCensusIncomeTrain\"\n",
+    "test_data_path = \"AdultCensusIncomeTest\"\n",
+    "\n",
+    "train_data_path_dbfs = os.path.join(\"/dbfs\", \"AdultCensusIncomeTrain\")\n",
+    "test_data_path_dbfs = os.path.join(\"/dbfs\", \"AdultCensusIncomeTest\")\n",
+    "\n",
+    "train.write.mode('overwrite').parquet(train_data_path)\n",
+    "test.write.mode('overwrite').parquet(test_data_path)\n",
+    "print(\"train and test datasets saved to {} and {}\".format(train_data_path_dbfs, test_data_path_dbfs))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "pasha"
+   },
+   {
+    "name": "wamartin"
+   }
+  ],
+  "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.7.0"
+  },
+  "name": "02.Ingest_data",
+  "notebookId": 3836944406456362
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}

how-to-use-azureml/azure-databricks/03.Build_model_runHistory.ipynb

@@ -0,0 +1,396 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Azure ML & Azure Databricks notebooks by Parashar Shah.\n",
+    "\n",
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "![04ACI](files/tables/image2.JPG)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#Model Building"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "import pprint\n",
+    "import numpy as np\n",
+    "\n",
+    "from pyspark.ml import Pipeline, PipelineModel\n",
+    "from pyspark.ml.feature import OneHotEncoder, StringIndexer, VectorAssembler\n",
+    "from pyspark.ml.classification import LogisticRegression\n",
+    "from pyspark.ml.evaluation import BinaryClassificationEvaluator\n",
+    "from pyspark.ml.tuning import CrossValidator, ParamGridBuilder"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##TESTONLY\n",
+    "# import auth creds from notebook parameters\n",
+    "tenant = dbutils.widgets.get('tenant_id')\n",
+    "username = dbutils.widgets.get('service_principal_id')\n",
+    "password = dbutils.widgets.get('service_principal_password')\n",
+    "\n",
+    "auth = azureml.core.authentication.ServicePrincipalAuthentication(tenant, username, password)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# import the Workspace class and check the azureml SDK version\n",
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace.from_config(auth = auth)\n",
+    "print('Workspace name: ' + ws.name, \n",
+    "      'Azure region: ' + ws.location, \n",
+    "      'Subscription id: ' + ws.subscription_id, \n",
+    "      'Resource group: ' + ws.resource_group, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##PUBLISHONLY\n",
+    "## import the Workspace class and check the azureml SDK version\n",
+    "#from azureml.core import Workspace\n",
+    "#\n",
+    "#ws = Workspace.from_config()\n",
+    "#print('Workspace name: ' + ws.name, \n",
+    "#      'Azure region: ' + ws.location, \n",
+    "#      'Subscription id: ' + ws.subscription_id, \n",
+    "#      'Resource group: ' + ws.resource_group, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#get the train and test datasets\n",
+    "train_data_path = \"AdultCensusIncomeTrain\"\n",
+    "test_data_path = \"AdultCensusIncomeTest\"\n",
+    "\n",
+    "train = spark.read.parquet(train_data_path)\n",
+    "test = spark.read.parquet(test_data_path)\n",
+    "\n",
+    "print(\"train: ({}, {})\".format(train.count(), len(train.columns)))\n",
+    "print(\"test: ({}, {})\".format(test.count(), len(test.columns)))\n",
+    "\n",
+    "train.printSchema()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#Define Model"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "label = \"income\"\n",
+    "dtypes = dict(train.dtypes)\n",
+    "dtypes.pop(label)\n",
+    "\n",
+    "si_xvars = []\n",
+    "ohe_xvars = []\n",
+    "featureCols = []\n",
+    "for idx,key in enumerate(dtypes):\n",
+    "    if dtypes[key] == \"string\":\n",
+    "        featureCol = \"-\".join([key, \"encoded\"])\n",
+    "        featureCols.append(featureCol)\n",
+    "        \n",
+    "        tmpCol = \"-\".join([key, \"tmp\"])\n",
+    "        # string-index and one-hot encode the string column\n",
+    "        #https://spark.apache.org/docs/2.3.0/api/java/org/apache/spark/ml/feature/StringIndexer.html\n",
+    "        #handleInvalid: Param for how to handle invalid data (unseen labels or NULL values). \n",
+    "        #Options are 'skip' (filter out rows with invalid data), 'error' (throw an error), \n",
+    "        #or 'keep' (put invalid data in a special additional bucket, at index numLabels). Default: \"error\"\n",
+    "        si_xvars.append(StringIndexer(inputCol=key, outputCol=tmpCol, handleInvalid=\"skip\"))\n",
+    "        ohe_xvars.append(OneHotEncoder(inputCol=tmpCol, outputCol=featureCol))\n",
+    "    else:\n",
+    "        featureCols.append(key)\n",
+    "\n",
+    "# string-index the label column into a column named \"label\"\n",
+    "si_label = StringIndexer(inputCol=label, outputCol='label')\n",
+    "\n",
+    "# assemble the encoded feature columns in to a column named \"features\"\n",
+    "assembler = VectorAssembler(inputCols=featureCols, outputCol=\"features\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.run import Run\n",
+    "from azureml.core.experiment import Experiment\n",
+    "import numpy as np\n",
+    "import os\n",
+    "import shutil\n",
+    "\n",
+    "model_name = \"AdultCensus_runHistory.mml\"\n",
+    "model_dbfs = os.path.join(\"/dbfs\", model_name)\n",
+    "run_history_name = 'spark-ml-notebook'\n",
+    "\n",
+    "# start a training run by defining an experiment\n",
+    "myexperiment = Experiment(ws, \"Ignite_AI_Talk\")\n",
+    "root_run = myexperiment.start_logging()\n",
+    "\n",
+    "# Regularization Rates - \n",
+    "regs = [0.0001, 0.001, 0.01, 0.1]\n",
+    " \n",
+    "# try a bunch of regularization rate in a Logistic Regression model\n",
+    "for reg in regs:\n",
+    "    print(\"Regularization rate: {}\".format(reg))\n",
+    "    # create a bunch of child runs\n",
+    "    with root_run.child_run(\"reg-\" + str(reg)) as run:\n",
+    "        # create a new Logistic Regression model.\n",
+    "        lr = LogisticRegression(regParam=reg)\n",
+    "        \n",
+    "        # put together the pipeline\n",
+    "        pipe = Pipeline(stages=[*si_xvars, *ohe_xvars, si_label, assembler, lr])\n",
+    "\n",
+    "        # train the model\n",
+    "        model_p = pipe.fit(train)\n",
+    "        \n",
+    "        # make prediction\n",
+    "        pred = model_p.transform(test)\n",
+    "        \n",
+    "        # evaluate. note only 2 metrics are supported out of the box by Spark ML.\n",
+    "        bce = BinaryClassificationEvaluator(rawPredictionCol='rawPrediction')\n",
+    "        au_roc = bce.setMetricName('areaUnderROC').evaluate(pred)\n",
+    "        au_prc = bce.setMetricName('areaUnderPR').evaluate(pred)\n",
+    "\n",
+    "        print(\"Area under ROC: {}\".format(au_roc))\n",
+    "        print(\"Area Under PR: {}\".format(au_prc))\n",
+    "      \n",
+    "        # log reg, au_roc, au_prc and feature names in run history\n",
+    "        run.log(\"reg\", reg)\n",
+    "        run.log(\"au_roc\", au_roc)\n",
+    "        run.log(\"au_prc\", au_prc)\n",
+    "        run.log_list(\"columns\", train.columns)\n",
+    "\n",
+    "        # save model\n",
+    "        model_p.write().overwrite().save(model_name)\n",
+    "        \n",
+    "        # upload the serialized model into run history record\n",
+    "        mdl, ext = model_name.split(\".\")\n",
+    "        model_zip = mdl + \".zip\"\n",
+    "        shutil.make_archive(mdl, 'zip', model_dbfs)\n",
+    "        run.upload_file(\"outputs/\" + model_name, model_zip)        \n",
+    "        #run.upload_file(\"outputs/\" + model_name, path_or_stream = model_dbfs) #cannot deal with folders\n",
+    "\n",
+    "        # now delete the serialized model from local folder since it is already uploaded to run history \n",
+    "        shutil.rmtree(model_dbfs)\n",
+    "        os.remove(model_zip)\n",
+    "        \n",
+    "# Declare run completed\n",
+    "root_run.complete()\n",
+    "root_run_id = root_run.id\n",
+    "print (\"run id:\", root_run.id)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "metrics = root_run.get_metrics(recursive=True)\n",
+    "best_run_id = max(metrics, key = lambda k: metrics[k]['au_roc'])\n",
+    "print(best_run_id, metrics[best_run_id]['au_roc'], metrics[best_run_id]['reg'])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#Get the best run\n",
+    "child_runs = {}\n",
+    "\n",
+    "for r in root_run.get_children():\n",
+    "    child_runs[r.id] = r\n",
+    "   \n",
+    "best_run = child_runs[best_run_id]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#Download the model from the best run to a local folder\n",
+    "best_model_file_name = \"best_model.zip\"\n",
+    "best_run.download_file(name = 'outputs/' + model_name, output_file_path = best_model_file_name)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#Model Evaluation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##unzip the model to dbfs (as load() seems to require that) and load it.\n",
+    "if os.path.isfile(model_dbfs) or os.path.isdir(model_dbfs):\n",
+    "    shutil.rmtree(model_dbfs)\n",
+    "shutil.unpack_archive(best_model_file_name, model_dbfs)\n",
+    "\n",
+    "model_p_best = PipelineModel.load(model_name)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# make prediction\n",
+    "pred = model_p_best.transform(test)\n",
+    "output = pred[['hours_per_week','age','workclass','marital_status','income','prediction']]\n",
+    "display(output.limit(5))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# evaluate. note only 2 metrics are supported out of the box by Spark ML.\n",
+    "bce = BinaryClassificationEvaluator(rawPredictionCol='rawPrediction')\n",
+    "au_roc = bce.setMetricName('areaUnderROC').evaluate(pred)\n",
+    "au_prc = bce.setMetricName('areaUnderPR').evaluate(pred)\n",
+    "\n",
+    "print(\"Area under ROC: {}\".format(au_roc))\n",
+    "print(\"Area Under PR: {}\".format(au_prc))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#Model Persistence"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##NOTE: by default the model is saved to and loaded from /dbfs/ instead of cwd!\n",
+    "model_p_best.write().overwrite().save(model_name)\n",
+    "print(\"saved model to {}\".format(model_dbfs))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%sh\n",
+    "\n",
+    "ls -la /dbfs/AdultCensus_runHistory.mml/*"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "dbutils.notebook.exit(\"success\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "pasha"
+   },
+   {
+    "name": "wamartin"
+   }
+  ],
+  "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.7.0"
+  },
+  "name": "03.Build_model_runHistory",
+  "notebookId": 3836944406456339
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}

how-to-use-azureml/azure-databricks/04.Deploy_to_ACI.ipynb

@@ -0,0 +1,354 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Azure ML & Azure Databricks notebooks by Parashar Shah.\n",
+    "\n",
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Please ensure you have run all previous notebooks in sequence before running this.\n",
+    "\n",
+    "Please Register Azure Container Instance(ACI) using Azure Portal: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services#portal in your subscription before using the SDK to deploy your ML model to ACI."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "![04ACI](files/tables/image3.JPG)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##TESTONLY\n",
+    "# import auth creds from notebook parameters\n",
+    "tenant = dbutils.widgets.get('tenant_id')\n",
+    "username = dbutils.widgets.get('service_principal_id')\n",
+    "password = dbutils.widgets.get('service_principal_password')\n",
+    "\n",
+    "auth = azureml.core.authentication.ServicePrincipalAuthentication(tenant, username, password)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Workspace\n",
+    "\n",
+    "#'''\n",
+    "ws = Workspace.from_config(auth = auth)\n",
+    "print('Workspace name: ' + ws.name, \n",
+    "      'Azure region: ' + ws.location, \n",
+    "      'Subscription id: ' + ws.subscription_id, \n",
+    "      'Resource group: ' + ws.resource_group, sep = '\\n')\n",
+    "#'''"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##PUBLISHONLY\n",
+    "#from azureml.core import Workspace\n",
+    "#import azureml.core\n",
+    "#\n",
+    "## Check core SDK version number\n",
+    "#print(\"SDK version:\", azureml.core.VERSION)\n",
+    "#\n",
+    "##'''\n",
+    "#ws = Workspace.from_config()\n",
+    "#print('Workspace name: ' + ws.name, \n",
+    "#      'Azure region: ' + ws.location, \n",
+    "#      'Subscription id: ' + ws.subscription_id, \n",
+    "#      'Resource group: ' + ws.resource_group, sep = '\\n')\n",
+    "##'''"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##NOTE: service deployment always gets the model from the current working dir.\n",
+    "import os\n",
+    "\n",
+    "model_name = \"AdultCensus_runHistory.mml\" # \n",
+    "model_name_dbfs = os.path.join(\"/dbfs\", model_name)\n",
+    "\n",
+    "print(\"copy model from dbfs to local\")\n",
+    "model_local = \"file:\" + os.getcwd() + \"/\" + model_name\n",
+    "dbutils.fs.cp(model_name, model_local, True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#Register the model\n",
+    "from azureml.core.model import Model\n",
+    "mymodel = Model.register(model_path = model_name, # this points to a local file\n",
+    "                       model_name = model_name, # this is the name the model is registered as, am using same name for both path and name.                 \n",
+    "                       description = \"ADB trained model by Parashar\",\n",
+    "                       workspace = ws)\n",
+    "\n",
+    "print(mymodel.name, mymodel.description, mymodel.version)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#%%writefile score_sparkml.py\n",
+    "score_sparkml = \"\"\"\n",
+    " \n",
+    "import json\n",
+    " \n",
+    "def init():\n",
+    "    # One-time initialization of PySpark and predictive model\n",
+    "    import pyspark\n",
+    "    from azureml.core.model import Model\n",
+    "    from pyspark.ml import PipelineModel\n",
+    " \n",
+    "    global trainedModel\n",
+    "    global spark\n",
+    " \n",
+    "    spark = pyspark.sql.SparkSession.builder.appName(\"ADB and AML notebook by Parashar\").getOrCreate()\n",
+    "    model_name = \"{model_name}\" #interpolated\n",
+    "    model_path = Model.get_model_path(model_name)\n",
+    "    trainedModel = PipelineModel.load(model_path)\n",
+    "    \n",
+    "def run(input_json):\n",
+    "    if isinstance(trainedModel, Exception):\n",
+    "        return json.dumps({{\"trainedModel\":str(trainedModel)}})\n",
+    "      \n",
+    "    try:\n",
+    "        sc = spark.sparkContext\n",
+    "        input_list = json.loads(input_json)\n",
+    "        input_rdd = sc.parallelize(input_list)\n",
+    "        input_df = spark.read.json(input_rdd)\n",
+    "    \n",
+    "        # Compute prediction\n",
+    "        prediction = trainedModel.transform(input_df)\n",
+    "        #result = prediction.first().prediction\n",
+    "        predictions = prediction.collect()\n",
+    " \n",
+    "        #Get each scored result\n",
+    "        preds = [str(x['prediction']) for x in predictions]\n",
+    "        result = \",\".join(preds)\n",
+    "        # you can return any data type as long as it is JSON-serializable\n",
+    "        return result.tolist()\n",
+    "    except Exception as e:\n",
+    "        result = str(e)\n",
+    "        return result\n",
+    "    \n",
+    "\"\"\".format(model_name=model_name)\n",
+    " \n",
+    "exec(score_sparkml)\n",
+    " \n",
+    "with open(\"score_sparkml.py\", \"w\") as file:\n",
+    "    file.write(score_sparkml)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.conda_dependencies import CondaDependencies \n",
+    "\n",
+    "myacienv = CondaDependencies.create(conda_packages=['scikit-learn','numpy','pandas']) #showing how to add libs as an eg. - not needed for this model.\n",
+    "\n",
+    "with open(\"mydeployenv.yml\",\"w\") as f:\n",
+    "    f.write(myacienv.serialize_to_string())"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#deploy to ACI\n",
+    "from azureml.core.webservice import AciWebservice, Webservice\n",
+    "\n",
+    "myaci_config = AciWebservice.deploy_configuration(\n",
+    "    cpu_cores = 2, \n",
+    "    memory_gb = 2, \n",
+    "    tags = {'name':'Databricks Azure ML ACI'}, \n",
+    "    description = 'This is for ADB and AML example. Azure Databricks & Azure ML SDK demo with ACI by Parashar.')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# this will take 10-15 minutes to finish\n",
+    "\n",
+    "service_name = \"aciws\"\n",
+    "runtime = \"spark-py\" \n",
+    "driver_file = \"score_sparkml.py\"\n",
+    "my_conda_file = \"mydeployenv.yml\"\n",
+    "\n",
+    "# image creation\n",
+    "from azureml.core.image import ContainerImage\n",
+    "myimage_config = ContainerImage.image_configuration(execution_script = driver_file, \n",
+    "                                    runtime = runtime, \n",
+    "                                    conda_file = my_conda_file)\n",
+    "\n",
+    "# Webservice creation\n",
+    "myservice = Webservice.deploy_from_model(\n",
+    "  workspace=ws, \n",
+    "  name=service_name,\n",
+    "  deployment_config = myaci_config,\n",
+    "  models = [mymodel],\n",
+    "  image_config = myimage_config\n",
+    "    )\n",
+    "\n",
+    "myservice.wait_for_deployment(show_output=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "help(Webservice)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# List images by ws\n",
+    "\n",
+    "for i in ContainerImage.list(workspace = ws):\n",
+    "    print('{}(v.{} [{}]) stored at {} with build log {}'.format(i.name, i.version, i.creation_state, i.image_location, i.image_build_log_uri))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#for using the Web HTTP API \n",
+    "print(myservice.scoring_uri)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import json\n",
+    "\n",
+    "#get the some sample data\n",
+    "test_data_path = \"AdultCensusIncomeTest\"\n",
+    "test = spark.read.parquet(test_data_path).limit(5)\n",
+    "\n",
+    "test_json = json.dumps(test.toJSON().collect())\n",
+    "\n",
+    "print(test_json)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#using data defined above predict if income is >50K (1) or <=50K (0)\n",
+    "myservice.run(input_data=test_json)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#comment to not delete the web service\n",
+    "#myservice.delete()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "pasha"
+   },
+   {
+    "name": "wamartin"
+   }
+  ],
+  "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.7.0"
+  },
+  "name": "04.DeploytoACI",
+  "notebookId": 3836944406456376
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}

how-to-use-azureml/azure-databricks/06.AutoML_Databricks_local.ipynb

@@ -0,0 +1,634 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# AutoML : Classification with Local Compute on Azure DataBricks\n",
+    "\n",
+    "In this example we use the scikit-learn's [digit dataset](http://scikit-learn.org/stable/datasets/index.html#optical-recognition-of-handwritten-digits-dataset) to showcase how you can use AutoML for a simple classification problem.\n",
+    "\n",
+    "In this notebook you will learn how to:\n",
+    "1. Create Azure Machine Learning Workspace object and initialize your notebook directory to easily reload this object from a configuration file.\n",
+    "2. Create an `Experiment` in an existing `Workspace`.\n",
+    "3. Configure AutoML using `AutoMLConfig`.\n",
+    "4. Train the model using AzureDataBricks.\n",
+    "5. Explore the results.\n",
+    "6. Test the best fitted model.\n",
+    "\n",
+    "Prerequisites:\n",
+    "Before running this notebook, please follow the readme for installing necessary libraries to your cluster."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Register Machine Learning Services Resource Provider\n",
+    "Microsoft.MachineLearningServices only needs to be registed once in the subscription. To register it:\n",
+    "Start the Azure portal.\n",
+    "Select your All services and then Subscription.\n",
+    "Select the subscription that you want to use.\n",
+    "Click on Resource providers\n",
+    "Click the Register link next to Microsoft.MachineLearningServices"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Check the Azure ML Core SDK Version to Validate Your Installation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "\n",
+    "print(\"SDK Version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize an Azure ML Workspace\n",
+    "### What is an Azure ML Workspace and Why Do I Need One?\n",
+    "\n",
+    "An Azure ML workspace is an Azure resource that organizes and coordinates the actions of many other Azure resources to assist in executing and sharing machine learning workflows.  In particular, an Azure ML workspace coordinates storage, databases, and compute resources providing added functionality for machine learning experimentation, operationalization, and the monitoring of operationalized models.\n",
+    "\n",
+    "\n",
+    "### What do I Need?\n",
+    "\n",
+    "To create or access an Azure ML workspace, you will need to import the Azure ML library and specify following information:\n",
+    "* A name for your workspace. You can choose one.\n",
+    "* Your subscription id. Use the `id` value from the `az account show` command output above.\n",
+    "* The resource group name. The resource group organizes Azure resources and provides a default region for the resources in the group. The resource group will be created if it doesn't exist. Resource groups can be created and viewed in the [Azure portal](https://portal.azure.com)\n",
+    "* Supported regions include `eastus2`, `eastus`,`westcentralus`, `southeastasia`, `westeurope`, `australiaeast`, `westus2`, `southcentralus`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##PUBLISHONLY\n",
+    "#subscription_id = \"<Your SubscriptionId>\"\n",
+    "#resource_group = \"<Resource group - new or existing>\"\n",
+    "#workspace_name = \"<workspace to be created>\"\n",
+    "#workspace_region = \"<azureregion>\" #eg. eastus2, westcentralus, westeurope"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Creating a Workspace\n",
+    "If you already have access to an Azure ML workspace you want to use, you can skip this cell.  Otherwise, this cell will create an Azure ML workspace for you in the specified subscription, provided you have the correct permissions for the given `subscription_id`.\n",
+    "\n",
+    "This will fail when:\n",
+    "1. The workspace already exists.\n",
+    "2. You do not have permission to create a workspace in the resource group.\n",
+    "3. You are not a subscription owner or contributor and no Azure ML workspaces have ever been created in this subscription.\n",
+    "\n",
+    "If workspace creation fails for any reason other than already existing, please work with your IT administrator to provide you with the appropriate permissions or to provision the required resources.\n",
+    "\n",
+    "**Note:** Creation of a new workspace can take several minutes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##TESTONLY\n",
+    "# import auth creds from notebook parameters\n",
+    "tenant = dbutils.widgets.get('tenant_id')\n",
+    "username = dbutils.widgets.get('service_principal_id')\n",
+    "password = dbutils.widgets.get('service_principal_password')\n",
+    "\n",
+    "auth = azureml.core.authentication.ServicePrincipalAuthentication(tenant, username, password)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##TESTONLY\n",
+    "subscription_id  = dbutils.widgets.get('subscription_id')\n",
+    "resource_group = dbutils.widgets.get('resource_group')\n",
+    "workspace_name = dbutils.widgets.get('workspace_name')\n",
+    "workspace_region = dbutils.widgets.get('workspace_region')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import the Workspace class and check the Azure ML SDK version.\n",
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace.create(name = workspace_name,\n",
+    "                      subscription_id = subscription_id,\n",
+    "                      resource_group = resource_group, \n",
+    "                      location = workspace_region,\n",
+    "                      auth = auth,\n",
+    "                      exist_ok=True)\n",
+    "ws.get_details()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##PUBLISHONLY\n",
+    "#from azureml.core import Workspace\n",
+    "#import azureml.core\n",
+    "#\n",
+    "## Check core SDK version number\n",
+    "#print(\"SDK version:\", azureml.core.VERSION)\n",
+    "#\n",
+    "##'''\n",
+    "#ws = Workspace.from_config()\n",
+    "#print('Workspace name: ' + ws.name, \n",
+    "#      'Azure region: ' + ws.location, \n",
+    "#      'Subscription id: ' + ws.subscription_id, \n",
+    "#      'Resource group: ' + ws.resource_group, sep = '\\n')\n",
+    "##'''"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configuring Your Local Environment\n",
+    "You can validate that you have access to the specified workspace and write a configuration file to the default configuration location, `./aml_config/config.json`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##TESTONLY\n",
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace(workspace_name = workspace_name,\n",
+    "               subscription_id = subscription_id,\n",
+    "               resource_group = resource_group,\n",
+    "               auth = auth)\n",
+    "\n",
+    "# Persist the subscription id, resource group name, and workspace name in aml_config/config.json.\n",
+    "ws.write_config()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##PUBLISHONLY\n",
+    "#from azureml.core import Workspace\n",
+    "#\n",
+    "#ws = Workspace(workspace_name = workspace_name,\n",
+    "#               subscription_id = subscription_id,\n",
+    "#               resource_group = resource_group)\n",
+    "#\n",
+    "## Persist the subscription id, resource group name, and workspace name in aml_config/config.json.\n",
+    "#ws.write_config()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create a Folder to Host Sample Projects\n",
+    "Finally, create a folder where all the sample projects will be hosted."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "\n",
+    "sample_projects_folder = './sample_projects'\n",
+    "\n",
+    "if not os.path.isdir(sample_projects_folder):\n",
+    "    os.mkdir(sample_projects_folder)\n",
+    "    \n",
+    "print('Sample projects will be created in {}.'.format(sample_projects_folder))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an Experiment\n",
+    "\n",
+    "As part of the setup you have already created an Azure ML `Workspace` object. For AutoML you will need to create an `Experiment` object, which is a named object in a `Workspace` used to run experiments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import logging\n",
+    "import os\n",
+    "import random\n",
+    "import time\n",
+    "\n",
+    "from matplotlib import pyplot as plt\n",
+    "from matplotlib.pyplot import imshow\n",
+    "import numpy as np\n",
+    "import pandas as pd\n",
+    "\n",
+    "import azureml.core\n",
+    "from azureml.core.experiment import Experiment\n",
+    "from azureml.core.workspace import Workspace\n",
+    "from azureml.train.automl import AutoMLConfig\n",
+    "from azureml.train.automl.run import AutoMLRun"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##TESTONLY\n",
+    "ws = Workspace.from_config(auth = auth)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "##PUBLISHONLY\n",
+    "#ws = Workspace.from_config(auth = auth)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Choose a name for the experiment and specify the project folder.\n",
+    "experiment_name = 'automl-local-classification'\n",
+    "project_folder = './sample_projects/automl-local-classification'\n",
+    "\n",
+    "experiment = Experiment(ws, experiment_name)\n",
+    "\n",
+    "output = {}\n",
+    "output['SDK version'] = azureml.core.VERSION\n",
+    "output['Subscription ID'] = ws.subscription_id\n",
+    "output['Workspace Name'] = ws.name\n",
+    "output['Resource Group'] = ws.resource_group\n",
+    "output['Location'] = ws.location\n",
+    "output['Project Directory'] = project_folder\n",
+    "output['Experiment Name'] = experiment.name\n",
+    "pd.set_option('display.max_colwidth', -1)\n",
+    "pd.DataFrame(data = output, index = ['']).T"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "set_diagnostics_collection(send_diagnostics = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Load Training Data Using DataPrep"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.dataprep as dprep\n",
+    "# You can use `auto_read_file` which intelligently figures out delimiters and datatypes of a file.\n",
+    "# The data referenced here was pulled from `sklearn.datasets.load_digits()`.\n",
+    "simple_example_data_root = 'https://dprepdata.blob.core.windows.net/automl-notebook-data/'\n",
+    "X_train = dprep.auto_read_file(simple_example_data_root + 'X.csv').skip(1)  # Remove the header row.\n",
+    "\n",
+    "# You can also use `read_csv` and `to_*` transformations to read (with overridable delimiter)\n",
+    "# and convert column types manually.\n",
+    "# Here we read a comma delimited file and convert all columns to integers.\n",
+    "y_train = dprep.read_csv(simple_example_data_root + 'y.csv').to_long(dprep.ColumnSelector(term='.*', use_regex = True))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Review the Data Preparation Result\n",
+    "You can peek the result of a Dataflow at any range using skip(i) and head(j). Doing so evaluates only j records for all the steps in the Dataflow, which makes it fast even against large datasets."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "X_train.skip(1).head(5)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure AutoML\n",
+    "\n",
+    "Instantiate an `AutoMLConfig` object to specify the settings and data used to run the experiment.\n",
+    "\n",
+    "|Property|Description|\n",
+    "|-|-|\n",
+    "|**task**|classification or regression|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Classification supports the following primary metrics: <br><i>accuracy</i><br><i>AUC_weighted</i><br><i>average_precision_score_weighted</i><br><i>norm_macro_recall</i><br><i>precision_score_weighted</i>|\n",
+    "|**primary_metric**|This is the metric that you want to optimize. Regression supports the following primary metrics: <br><i>spearman_correlation</i><br><i>normalized_root_mean_squared_error</i><br><i>r2_score</i><br><i>normalized_mean_absolute_error</i>|\n",
+    "|**iteration_timeout_minutes**|Time limit in minutes for each iteration.|\n",
+    "|**iterations**|Number of iterations. In each iteration AutoML trains a specific pipeline with the data.|\n",
+    "|**n_cross_validations**|Number of cross validation splits.|\n",
+    "|**spark_context**|Spark Context object. for Databricks, use spark_context=sc|\n",
+    "|**max_cuncurrent_iterations**|Maximum number of iterations to execute in parallel. This should be less than the number of cores on the ADB..|\n",
+    "|**X**|(sparse) array-like, shape = [n_samples, n_features]|\n",
+    "|**y**|(sparse) array-like, shape = [n_samples, ], [n_samples, n_classes]<br>Multi-class targets. An indicator matrix turns on multilabel classification. This should be an array of integers.|\n",
+    "|**path**|Relative path to the project folder. AutoML stores configuration files for the experiment under this folder. You can specify a new empty folder.|\n",
+    "|**concurrent_iterations**|number of concurrent runs <= total cores in all worker nodes in your Databricks cluster|\n",
+    "|**exit_score**|Target score for experiment. It is associated with the metric. eg. exit_score=0.995 will exit experiment after that|"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "automl_config = AutoMLConfig(task = 'classification',\n",
+    "                             debug_log = 'automl_errors.log',\n",
+    "                             primary_metric = 'AUC_weighted',\n",
+    "                             iteration_timeout_minutes = 10,\n",
+    "                             iterations = 30,\n",
+    "                             n_cross_validations = 10,\n",
+    "                             max_concurrent_iterations = 8, #change it based on number of cores in worker nodes\n",
+    "                             verbosity = logging.INFO,\n",
+    "                             spark_context=sc, #databricks/spark related\n",
+    "                             X = X_train, \n",
+    "                             y = y_train,\n",
+    "                             enable_cache=False,\n",
+    "                             path = project_folder)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Train the Models\n",
+    "\n",
+    "Call the `submit` method on the experiment object and pass the run configuration. Execution of local runs is synchronous. Depending on the data and the number of iterations this can run for a while.\n",
+    "In this example, we specify `show_output = True` to print currently running iterations to the console."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "local_run = experiment.submit(automl_config, show_output = True) # for higher runs please use show_output=False and use the below"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explore the Results"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Portal URL for Monitoring Runs\n",
+    "\n",
+    "The following will provide a link to the web interface to explore individual run details and status. In the future we might support output displayed in the notebook."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(local_run.get_portal_url())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The following will show the child runs and waits for the parent run to complete."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Retrieve All Child Runs after the experiment is completed (in portal)\n",
+    "You can also use SDK methods to fetch all the child runs and see individual metrics that we log."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "children = list(local_run.get_children())\n",
+    "metricslist = {}\n",
+    "for run in children:\n",
+    "    properties = run.get_properties()\n",
+    "    metrics = {k: v for k, v in run.get_metrics().items() if isinstance(v, float)}    \n",
+    "    metricslist[int(properties['iteration'])] = metrics\n",
+    "\n",
+    "rundata = pd.DataFrame(metricslist).sort_index(1)\n",
+    "rundata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Retrieve the Best Model after the above run is complete \n",
+    "\n",
+    "Below we select the best pipeline from our iterations. The `get_output` method returns the best run and the fitted model. The Model includes the pipeline and any pre-processing.  Overloads on `get_output` allow you to retrieve the best run and fitted model for *any* logged metric or for a particular *iteration*."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "best_run, fitted_model = local_run.get_output()\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Best Model Based on Any Other Metric after the above run is complete based on the child run\n",
+    "Show the run and the model that has the smallest `log_loss` value:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "lookup_metric = \"log_loss\"\n",
+    "best_run, fitted_model = local_run.get_output(metric = lookup_metric)\n",
+    "print(best_run)\n",
+    "print(fitted_model)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Test the Best Fitted Model\n",
+    "\n",
+    "#### Load Test Data - you can split the dataset beforehand & pass Train dataset to AutoML and use Test dataset to evaluate the best model."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from sklearn import datasets\n",
+    "digits = datasets.load_digits()\n",
+    "X_test = digits.data[:10, :]\n",
+    "y_test = digits.target[:10]\n",
+    "images = digits.images[:10]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Testing Our Best Fitted Model\n",
+    "We will try to predict digits and see how our model works. This is just an example to show you."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Randomly select digits and test.\n",
+    "for index in np.random.choice(len(y_test), 2, replace = False):\n",
+    "    print(index)\n",
+    "    predicted = fitted_model.predict(X_test[index:index + 1])[0]\n",
+    "    label = y_test[index]\n",
+    "    title = \"Label value = %d  Predicted value = %d \" % (label, predicted)\n",
+    "    fig = plt.figure(1, figsize = (3,3))\n",
+    "    ax1 = fig.add_axes((0,0,.8,.8))\n",
+    "    ax1.set_title(title)\n",
+    "    plt.imshow(images[index], cmap = plt.cm.gray_r, interpolation = 'nearest')\n",
+    "    display(fig)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "savitam"
+   },
+   {
+    "name": "wamartin"
+   }
+  ],
+  "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.7.0"
+  },
+  "name": "auto-ml-classification-local-adb",
+  "notebookId": 3836944406456411
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}

how-to-use-azureml/azure-databricks/automl_adb_readme.md

@@ -0,0 +1,47 @@
+**PREVIEW capability** 
+
+Automated ML now supports Azure Databricks as a local compute to perform training (**public preview**). Azure Databricks is a managed Spark offering on Azure and customers already use it for advanced analytics. It provides a collaborative Notebook based environment with CPU or GPU based compute cluster. 
+- Customers who use Azure Databricks for advanced analytics can now use the same cluster to run automated machine learning experiments. 
+- You can keep the data within the same cluster. 
+- You can leverage the local worker nodes with autoscale and auto termination capabilities. 
+- You can use multiple cores of your Azure Databricks cluster to perform simultenous training. 
+- You can further tune the model generated by automated machine learning if you chose to. 
+- Every run (including the best run) is available as a pipeline. 
+- The model from the pipeline can be registered in Azure ML SDK workspace and then deployed to Azure managed compute (ACI or AKS) using the Azure Machine learning SDK.
+
+**Create Azure Databricks Cluster:**
+
+Select New Cluster and fill in following detail:
+ - Cluster name: _yourclustername_
+ - Cluster Mode: Any. **High Concurrency** preferred
+ - Databricks Runtime: Any 4.x runtime.
+ - Python version: **3**
+ - Workers: 2 or higher.  
+ - Max. number of **concurrent iterations** in Automated ML settings is **<=** to the number of **worker nodes** in your Databricks cluster.
+ - Worker node VM types: **Memory optimized VM** preferred. 
+ - Uncheck _Enable Autoscaling_
+
+
+It will take few minutes to create the cluster. Please ensure that the cluster state is running before proceeding further.
+
+**Install Azure ML with Automated ML SDK on your Azure Databricks cluster**
+
+- Select Import library
+
+- Source: Upload Python Egg or PyPI
+
+- PyPi Name: **azureml-sdk[automl_databricks]**
+
+- Click Install Library
+
+- Do not select _Attach automatically to all clusters_. In case you have selected earlier then you can go to your Home folder and deselect it.
+
+- Select the check box _Attach_ next to your cluster name
+
+(More details on how to attach and detach libs are here - [https://docs.databricks.com/user-guide/libraries.html#attach-a-library-to-a-cluster](https://docs.databricks.com/user-guide/libraries.html#attach-a-library-to-a-cluster) )
+
+- Ensure that there are no errors until Status changes to _Attached_. It may take a couple of minutes.
+
+**Note** - If you have the old build the please deselect it from cluster’s installed libs > move to trash. Install the new build and restart the cluster. And if still there is an issue then detach and reattach your cluster.
+
+**Now you can run the Automated ML sample notebook on your Azure Databricks cluster. Please let us know your feedback.**

how-to-use-azureml/deployment/enable-app-insights-in-production-service/enable-app-insights-in-production-service.ipynb

@@ -0,0 +1,415 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Enabling App Insights for Services in Production\n",
+    "With this notebook, you can learn how to enable App Insights for standard service monitoring, plus, we provide examples for doing custom logging within a scoring files in a model. \n",
+    "\n",
+    "\n",
+    "## What does Application Insights monitor?\n",
+    "It monitors request rates, response times, failure rates, etc. For more information visit [App Insights docs.](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-overview)\n",
+    "\n",
+    "\n",
+    "## What is different compared to standard production deployment process?\n",
+    "If you want to enable generic App Insights for a service run:\n",
+    "```python\n",
+    "aks_service= Webservice(ws, \"aks-w-dc2\")\n",
+    "aks_service.update(enable_app_insights=True)```\n",
+    "Where \"aks-w-dc2\" is your service name. You can also do this from the Azure Portal under your Workspace--> deployments--> Select deployment--> Edit--> Advanced Settings--> Select \"Enable AppInsights diagnostics\"\n",
+    "\n",
+    "If you want to log custom traces, you will follow the standard deplyment process for AKS and you will:\n",
+    "1. Update scoring file.\n",
+    "2. Update aks configuration.\n",
+    "3. Build new image and deploy it. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 1. Import your dependencies"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Workspace, Run\n",
+    "from azureml.core.compute import AksCompute, ComputeTarget\n",
+    "from azureml.core.webservice import Webservice, AksWebservice\n",
+    "from azureml.core.image import Image\n",
+    "from azureml.core.model import Model\n",
+    "\n",
+    "import azureml.core\n",
+    "print(azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 2. Set up your configuration and create a workspace\n",
+    "Follow Notebook 00 instructions to do this.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 3. Register Model\n",
+    "Register an existing trained model, add descirption and tags."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#Register the model\n",
+    "from azureml.core.model import Model\n",
+    "model = Model.register(model_path = \"sklearn_regression_model.pkl\", # this points to a local file\n",
+    "                       model_name = \"sklearn_regression_model.pkl\", # this is the name the model is registered as\n",
+    "                       tags = {'area': \"diabetes\", 'type': \"regression\"},\n",
+    "                       description = \"Ridge regression model to predict diabetes\",\n",
+    "                       workspace = ws)\n",
+    "\n",
+    "print(model.name, model.description, model.version)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 4. *Update your scoring file with custom print statements*\n",
+    "Here is an example:\n",
+    "### a. In your init function add:\n",
+    "```python\n",
+    "print (\"model initialized\" + time.strftime(\"%H:%M:%S\"))```\n",
+    "\n",
+    "### b. In your run function add:\n",
+    "```python\n",
+    "print (\"saving input data\" + time.strftime(\"%H:%M:%S\"))\n",
+    "print (\"saving prediction data\" + time.strftime(\"%H:%M:%S\"))```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%writefile score.py\n",
+    "import pickle\n",
+    "import json\n",
+    "import numpy \n",
+    "from sklearn.externals import joblib\n",
+    "from sklearn.linear_model import Ridge\n",
+    "from azureml.core.model import Model\n",
+    "from azureml.monitoring import ModelDataCollector\n",
+    "import time\n",
+    "\n",
+    "def init():\n",
+    "    global model\n",
+    "    #Print statement for appinsights custom traces:\n",
+    "    print (\"model initialized\" + time.strftime(\"%H:%M:%S\"))\n",
+    "    \n",
+    "    # note here \"sklearn_regression_model.pkl\" is the name of the model registered under the workspace\n",
+    "    # this call should return the path to the model.pkl file on the local disk.\n",
+    "    model_path = Model.get_model_path(model_name = 'sklearn_regression_model.pkl')\n",
+    "    \n",
+    "    # deserialize the model file back into a sklearn model\n",
+    "    model = joblib.load(model_path)\n",
+    "    \n",
+    "    global inputs_dc, prediction_dc\n",
+    "    \n",
+    "    # this setup will help us save our inputs under the \"inputs\" path in our Azure Blob\n",
+    "    inputs_dc = ModelDataCollector(model_name=\"sklearn_regression_model\", identifier=\"inputs\", feature_names=[\"feat1\", \"feat2\"]) \n",
+    "    \n",
+    "    # this setup will help us save our ipredictions under the \"predictions\" path in our Azure Blob\n",
+    "    prediction_dc = ModelDataCollector(\"sklearn_regression_model\", identifier=\"predictions\", feature_names=[\"prediction1\", \"prediction2\"]) \n",
+    "  \n",
+    "# note you can pass in multiple rows for scoring\n",
+    "def run(raw_data):\n",
+    "    global inputs_dc, prediction_dc\n",
+    "    try:\n",
+    "        data = json.loads(raw_data)['data']\n",
+    "        data = numpy.array(data)\n",
+    "        result = model.predict(data)\n",
+    "        \n",
+    "        #Print statement for appinsights custom traces:\n",
+    "        print (\"saving input data\" + time.strftime(\"%H:%M:%S\"))\n",
+    "        \n",
+    "        #this call is saving our input data into our blob\n",
+    "        inputs_dc.collect(data) \n",
+    "        #this call is saving our prediction data into our blob\n",
+    "        prediction_dc.collect(result)\n",
+    "        \n",
+    "        #Print statement for appinsights custom traces:\n",
+    "        print (\"saving prediction data\" + time.strftime(\"%H:%M:%S\"))\n",
+    "        # you can return any data type as long as it is JSON-serializable\n",
+    "        return result.tolist()\n",
+    "    except Exception as e:\n",
+    "        error = str(e)\n",
+    "        print (error + time.strftime(\"%H:%M:%S\"))\n",
+    "        return error"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 5. *Create myenv.yml file*"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.conda_dependencies import CondaDependencies \n",
+    "\n",
+    "myenv = CondaDependencies.create(conda_packages=['numpy','scikit-learn'])\n",
+    "\n",
+    "with open(\"myenv.yml\",\"w\") as f:\n",
+    "    f.write(myenv.serialize_to_string())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 6. Create your new Image"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.image import ContainerImage\n",
+    "\n",
+    "image_config = ContainerImage.image_configuration(execution_script = \"score.py\",\n",
+    "                                                  runtime = \"python\",\n",
+    "                                                  conda_file = \"myenv.yml\",\n",
+    "                                                  description = \"Image with ridge regression model\",\n",
+    "                                                  tags = {'area': \"diabetes\", 'type': \"regression\"}\n",
+    "                                                 )\n",
+    "\n",
+    "image = ContainerImage.create(name = \"myimage1\",\n",
+    "                              # this is the model object\n",
+    "                              models = [model],\n",
+    "                              image_config = image_config,\n",
+    "                              workspace = ws)\n",
+    "\n",
+    "image.wait_for_creation(show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 7. Deploy to AKS service"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Create AKS compute if you haven't done so (Notebook 11)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Use the default configuration (can also provide parameters to customize)\n",
+    "prov_config = AksCompute.provisioning_configuration()\n",
+    "\n",
+    "aks_name = 'my-aks-test2' \n",
+    "# Create the cluster\n",
+    "aks_target = ComputeTarget.create(workspace = ws, \n",
+    "                                  name = aks_name, \n",
+    "                                  provisioning_configuration = prov_config)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%time\n",
+    "aks_target.wait_for_completion(show_output = True)\n",
+    "print(aks_target.provisioning_state)\n",
+    "print(aks_target.provisioning_errors)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If you already have a cluster you can attach the service to it:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "```python \n",
+    "%%time\n",
+    "resource_id = '/subscriptions/<subscriptionid>/resourcegroups/<resourcegroupname>/providers/Microsoft.ContainerService/managedClusters/<aksservername>'\n",
+    "create_name= 'myaks4'\n",
+    "attach_config = AksCompute.attach_configuration(resource_id=resource_id)\n",
+    "aks_target = ComputeTarget.attach(workspace = ws, \n",
+    "                                  name = create_name, \n",
+    "                                  attach_configuration=attach_config)\n",
+    "## Wait for the operation to complete\n",
+    "aks_target.wait_for_provisioning(True)```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### a. *Activate App Insights through updating AKS Webservice configuration*\n",
+    "In order to enable App Insights in your service you will need to update your AKS configuration file:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#Set the web service configuration\n",
+    "aks_config = AksWebservice.deploy_configuration(enable_app_insights=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### b. Deploy your service"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%time\n",
+    "aks_service_name ='aks-w-dc3'\n",
+    "\n",
+    "aks_service = Webservice.deploy_from_image(workspace = ws, \n",
+    "                                           name = aks_service_name,\n",
+    "                                           image = image,\n",
+    "                                           deployment_config = aks_config,\n",
+    "                                           deployment_target = aks_target\n",
+    "                                           )\n",
+    "aks_service.wait_for_deployment(show_output = True)\n",
+    "print(aks_service.state)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 8. Test your service "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%time\n",
+    "import json\n",
+    "\n",
+    "test_sample = json.dumps({'data': [\n",
+    "    [1,28,13,45,54,6,57,8,8,10], \n",
+    "    [101,9,8,37,6,45,4,3,2,41]\n",
+    "]})\n",
+    "test_sample = bytes(test_sample,encoding='utf8')\n",
+    "\n",
+    "prediction = aks_service.run(input_data=test_sample)\n",
+    "print(prediction)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 9. See your service telemetry in App Insights\n",
+    "1. Go to the [Azure Portal](https://portal.azure.com/)\n",
+    "2. All resources--> Select the subscription/resource group where you created your Workspace--> Select the App Insights type\n",
+    "3. Click on the AppInsights resource. You'll see a highlevel dashboard with information on Requests, Server response time and availability.\n",
+    "4. Click on the top banner \"Analytics\"\n",
+    "5. In the \"Schema\" section select \"traces\" and run your query.\n",
+    "6. Voila! All your custom traces should be there."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Disable App Insights"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "aks_service.update(enable_app_insights=False)"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "marthalc"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/deployment/enable-data-collection-for-models-in-aks/enable-data-collection-for-models-in-aks.ipynb

@@ -102,7 +102,7 @@
     "### b. In your init function add:\n",
     "```python \n",
     "global inputs_dc, prediction_d\n",
-    "inputs_dc = ModelDataCollector(\"best_model\", identifier=\"inputs\", feature_names=[\"feat1\", \"feat2\", \"feat3\". \"feat4\", \"feat5\", \"Feat6\"])\n",
+    "inputs_dc = ModelDataCollector(\"best_model\", identifier=\"inputs\", feature_names=[\"feat1\", \"feat2\", \"feat3\", \"feat4\", \"feat5\", \"Feat6\"])\n",
     "prediction_dc = ModelDataCollector(\"best_model\", identifier=\"predictions\", feature_names=[\"prediction1\", \"prediction2\"])```\n",
     "    \n",
     "* Identifier: Identifier is later used for building the folder structure in your Blob, it can be used to divide \"raw\" data versus \"processed\".\n",
@@ -156,11 +156,12 @@
     "        inputs_dc.collect(data) #this call is saving our input data into our blob\n",
     "        prediction_dc.collect(result)#this call is saving our prediction data into our blob\n",
     "        print (\"saving prediction data\" + time.strftime(\"%H:%M:%S\"))\n",
-    "        return json.dumps({\"result\": result.tolist()})\n",
+    "        # you can return any data type as long as it is JSON-serializable\n",
+    "        return result.tolist()\n",
     "    except Exception as e:\n",
-    "        result = str(e)\n",
-    "        print (result + time.strftime(\"%H:%M:%S\"))\n",
-    "        return json.dumps({\"error\": result})"
+    "        error = str(e)\n",
+    "        print (error + time.strftime(\"%H:%M:%S\"))\n",
+    "        return error"
    ]
   },
   {
@@ -284,9 +285,10 @@
     "    %%time\n",
     "    resource_id = '/subscriptions/<subscriptionid>/resourcegroups/<resourcegroupname>/providers/Microsoft.ContainerService/managedClusters/<aksservername>'\n",
     "    create_name= 'myaks4'\n",
-    "    aks_target = AksCompute.attach(workspace = ws, \n",
+    "    attach_config = AksCompute.attach_configuration(resource_id=resource_id)\n",
+    "    aks_target = ComputeTarget.attach(workspace = ws, \n",
     "                                      name = create_name, \n",
-    "                                      #esource_id=resource_id)\n",
+    "                                      attach_configuration=attach_config)\n",
     "    ## Wait for the operation to complete\n",
     "    aks_target.wait_for_provisioning(True)```"
    ]
@@ -424,6 +426,11 @@
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "marthalc"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/deployment/onnx/README.md

@@ -0,0 +1,28 @@
+# ONNX on Azure Machine Learning
+
+These tutorials show how to create and deploy [ONNX](http://onnx.ai) models in Azure Machine Learning environments using [ONNX Runtime](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-build-deploy-onnx) for inference. Once deployed as a web service, you can ping the model with your own set of images to be analyzed!
+
+## Tutorials
+- [Obtain ONNX model from ONNX Model Zoo and deploy with ONNX Runtime inference - Handwritten Digit Classification (MNIST)](https://github.com/Azure/MachineLearningNotebooks/blob/master/onnx/onnx-inference-mnist-deploy.ipynb)
+- [Obtain ONNX model from ONNX Model Zoo and deploy with ONNX Runtime inference - Facial Expression Recognition (Emotion FER+)](https://github.com/Azure/MachineLearningNotebooks/blob/master/onnx/onnx-inference-facial-emotion-recognition-deploy.ipynb)
+- [Obtain ONNX model from ONNX Model Zoo and deploy with ONNX Runtime inference - Image Recognition (ResNet50)](https://github.com/Azure/MachineLearningNotebooks/blob/master/onnx/onnx-modelzoo-aml-deploy-resnet50.ipynb)
+- [Convert ONNX model from CoreML and deploy - TinyYOLO](https://github.com/Azure/MachineLearningNotebooks/blob/master/onnx/onnx-convert-aml-deploy-tinyyolo.ipynb)
+- [Train ONNX model in PyTorch and deploy - MNIST](https://github.com/Azure/MachineLearningNotebooks/blob/master/onnx/onnx-train-pytorch-aml-deploy-mnist.ipynb)
+
+
+## Documentation
+- [ONNX Runtime Python API Documentation](http://aka.ms/onnxruntime-python)
+- [Azure Machine Learning API Documentation](http://aka.ms/aml-docs)
+
+## Related Articles
+- [Building and Deploying ONNX Runtime Models](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-build-deploy-onnx)
+- [Azure AI – Making AI Real for Business](https://aka.ms/aml-blog-overview) 
+- [What’s new in Azure Machine Learning](https://aka.ms/aml-blog-whats-new)
+
+
+## License
+Copyright (c) Microsoft Corporation. All rights reserved.  
+Licensed under the MIT License.
+
+## Acknowledgements
+These tutorials were developed by Vinitra Swamy and Prasanth Pulavarthi of the Microsoft AI Frameworks team and adapted for presentation at Microsoft Ignite 2018.

how-to-use-azureml/deployment/onnx/onnx-convert-aml-deploy-tinyyolo.ipynb

@@ -0,0 +1,435 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# YOLO Real-time Object Detection using ONNX on AzureML\n",
+    "\n",
+    "This example shows how to convert the TinyYOLO model from CoreML to ONNX and operationalize it as a web service using Azure Machine Learning services and the ONNX Runtime.\n",
+    "\n",
+    "## What is ONNX\n",
+    "ONNX is an open format for representing machine learning and deep learning models. ONNX enables open and interoperable AI by enabling data scientists and developers to use the tools of their choice without worrying about lock-in and flexibility to deploy to a variety of platforms. ONNX is developed and supported by a community of partners including Microsoft, Facebook, and Amazon. For more information, explore the [ONNX website](http://onnx.ai).\n",
+    "\n",
+    "## YOLO Details\n",
+    "You Only Look Once (YOLO) is a state-of-the-art, real-time object detection system. For more information about YOLO, please visit the [YOLO website](https://pjreddie.com/darknet/yolo/)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prerequisites\n",
+    "\n",
+    "To make the best use of your time, make sure you have done the following:\n",
+    "\n",
+    "* Understand the [architecture and terms](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture) introduced by Azure Machine Learning\n",
+    "* Go through the [00.configuration.ipynb](../00.configuration.ipynb) notebook to:\n",
+    "    * install the AML SDK\n",
+    "    * create a workspace and its configuration file (config.json)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Check core SDK version number\n",
+    "import azureml.core\n",
+    "\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Install necessary packages\n",
+    "\n",
+    "You'll need to run the following commands to use this tutorial:\n",
+    "\n",
+    "```sh\n",
+    "pip install onnxmltools\n",
+    "pip install coremltools  # use this on Linux and Mac\n",
+    "pip install git+https://github.com/apple/coremltools  # use this on Windows\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Convert model to ONNX\n",
+    "\n",
+    "First we download the CoreML model. We use the CoreML model listed at https://coreml.store/tinyyolo. This may take a few minutes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import urllib.request\n",
+    "\n",
+    "onnx_model_url = \"https://s3-us-west-2.amazonaws.com/coreml-models/TinyYOLO.mlmodel\"\n",
+    "urllib.request.urlretrieve(onnx_model_url, filename=\"TinyYOLO.mlmodel\")\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Then we use ONNXMLTools to convert the model."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import onnxmltools\n",
+    "import coremltools\n",
+    "\n",
+    "# Load a CoreML model\n",
+    "coreml_model = coremltools.utils.load_spec('TinyYOLO.mlmodel')\n",
+    "\n",
+    "# Convert from CoreML into ONNX\n",
+    "onnx_model = onnxmltools.convert_coreml(coreml_model, 'TinyYOLOv2')\n",
+    "\n",
+    "# Save ONNX model\n",
+    "onnxmltools.utils.save_model(onnx_model, 'tinyyolov2.onnx')\n",
+    "\n",
+    "import os\n",
+    "print(os.path.getsize('tinyyolov2.onnx'))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Deploying as a web service with Azure ML\n",
+    "\n",
+    "### Load Azure ML workspace\n",
+    "\n",
+    "We begin by instantiating a workspace object from the existing workspace created earlier in the configuration notebook."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.location, ws.resource_group, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Registering your model with Azure ML\n",
+    "\n",
+    "Now we upload the model and register it in the workspace."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.model import Model\n",
+    "\n",
+    "model = Model.register(model_path = \"tinyyolov2.onnx\",\n",
+    "                       model_name = \"tinyyolov2\",\n",
+    "                       tags = {\"onnx\": \"demo\"},\n",
+    "                       description = \"TinyYOLO\",\n",
+    "                       workspace = ws)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Displaying your registered models\n",
+    "\n",
+    "You can optionally list out all the models that you have registered in this workspace."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "models = ws.models\n",
+    "for name, m in models.items():\n",
+    "    print(\"Name:\", name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Write scoring file\n",
+    "\n",
+    "We are now going to deploy our ONNX model on Azure ML using the ONNX Runtime. We begin by writing a score.py file that will be invoked by the web service call. The `init()` function is called once when the container is started so we load the model using the ONNX Runtime into a global session object."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%writefile score.py\n",
+    "import json\n",
+    "import time\n",
+    "import sys\n",
+    "import os\n",
+    "from azureml.core.model import Model\n",
+    "import numpy as np    # we're going to use numpy to process input and output data\n",
+    "import onnxruntime    # to inference ONNX models, we use the ONNX Runtime\n",
+    "\n",
+    "def init():\n",
+    "    global session\n",
+    "    model = Model.get_model_path(model_name = 'tinyyolov2')\n",
+    "    session = onnxruntime.InferenceSession(model)\n",
+    "\n",
+    "def preprocess(input_data_json):\n",
+    "    # convert the JSON data into the tensor input\n",
+    "    return np.array(json.loads(input_data_json)['data']).astype('float32')\n",
+    "\n",
+    "def postprocess(result):\n",
+    "    return np.array(result).tolist()\n",
+    "\n",
+    "def run(input_data_json):\n",
+    "    try:\n",
+    "        start = time.time()   # start timer\n",
+    "        input_data = preprocess(input_data_json)\n",
+    "        input_name = session.get_inputs()[0].name  # get the id of the first input of the model   \n",
+    "        result = session.run([], {input_name: input_data})\n",
+    "        end = time.time()     # stop timer\n",
+    "        return {\"result\": postprocess(result),\n",
+    "                \"time\": end - start}\n",
+    "    except Exception as e:\n",
+    "        result = str(e)\n",
+    "        return {\"error\": result}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Create container image\n",
+    "First we create a YAML file that specifies which dependencies we would like to see in our container."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.conda_dependencies import CondaDependencies \n",
+    "\n",
+    "myenv = CondaDependencies.create(pip_packages=[\"numpy\",\"onnxruntime\",\"azureml-core\"])\n",
+    "\n",
+    "with open(\"myenv.yml\",\"w\") as f:\n",
+    "    f.write(myenv.serialize_to_string())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Then we have Azure ML create the container. This step will likely take a few minutes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.image import ContainerImage\n",
+    "\n",
+    "image_config = ContainerImage.image_configuration(execution_script = \"score.py\",\n",
+    "                                                  runtime = \"python\",\n",
+    "                                                  conda_file = \"myenv.yml\",\n",
+    "                                                  description = \"TinyYOLO ONNX Demo\",\n",
+    "                                                  tags = {\"demo\": \"onnx\"}\n",
+    "                                                 )\n",
+    "\n",
+    "\n",
+    "image = ContainerImage.create(name = \"onnxyolo\",\n",
+    "                              models = [model],\n",
+    "                              image_config = image_config,\n",
+    "                              workspace = ws)\n",
+    "\n",
+    "image.wait_for_creation(show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In case you need to debug your code, the next line of code accesses the log file."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(image.image_build_log_uri)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We're all set! Let's get our model chugging.\n",
+    "\n",
+    "### Deploy the container image"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.webservice import AciWebservice\n",
+    "\n",
+    "aciconfig = AciWebservice.deploy_configuration(cpu_cores = 1, \n",
+    "                                               memory_gb = 1, \n",
+    "                                               tags = {'demo': 'onnx'}, \n",
+    "                                               description = 'web service for TinyYOLO ONNX model')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The following cell will likely take a few minutes to run as well."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.webservice import Webservice\n",
+    "from random import randint\n",
+    "\n",
+    "aci_service_name = 'onnx-tinyyolo'+str(randint(0,100))\n",
+    "print(\"Service\", aci_service_name)\n",
+    "\n",
+    "aci_service = Webservice.deploy_from_image(deployment_config = aciconfig,\n",
+    "                                           image = image,\n",
+    "                                           name = aci_service_name,\n",
+    "                                           workspace = ws)\n",
+    "\n",
+    "aci_service.wait_for_deployment(True)\n",
+    "print(aci_service.state)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In case the deployment fails, you can check the logs. Make sure to delete your aci_service before trying again."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if aci_service.state != 'Healthy':\n",
+    "    # run this command for debugging.\n",
+    "    print(aci_service.get_logs())\n",
+    "    aci_service.delete()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Success!\n",
+    "\n",
+    "If you've made it this far, you've deployed a working web service that does object detection using an ONNX model. You can get the URL for the webservice with the code below."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(aci_service.scoring_uri)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "When you are eventually done using the web service, remember to delete it."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#aci_service.delete()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "onnx"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.5.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/deployment/onnx/onnx-inference-facial-expression-recognition-deploy.ipynb

@@ -12,7 +12,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Facial Expression Recognition using ONNX Runtime on AzureML\n",
+    "# Facial Expression Recognition (FER+) using ONNX Runtime on Azure ML\n",
     "\n",
     "This example shows how to deploy an image classification neural network using the Facial Expression Recognition ([FER](https://www.kaggle.com/c/challenges-in-representation-learning-facial-expression-recognition-challenge/data)) dataset and Open Neural Network eXchange format ([ONNX](http://aka.ms/onnxdocarticle)) on the Azure Machine Learning platform. This tutorial will show you how to deploy a FER+ model from the [ONNX model zoo](https://github.com/onnx/models), use it to make predictions using ONNX Runtime Inference, and deploy it as a web service in Azure.\n",
     "\n",
@@ -34,32 +34,54 @@
     "## Prerequisites\n",
     "\n",
     "### 1. Install Azure ML SDK and create a new workspace\n",
-    "Please follow [00.configuration.ipynb](https://github.com/Azure/MachineLearningNotebooks/blob/master/00.configuration.ipynb) notebook.\n",
-    "\n",
+    "Please follow [Azure ML configuration notebook](https://github.com/Azure/MachineLearningNotebooks/blob/master/00.configuration.ipynb) to set up your environment.\n",
     "\n",
     "### 2. Install additional packages needed for this Notebook\n",
-    "You need to install the popular plotting library `matplotlib`, the image manipulation library `PIL`, and the `onnx` library in the conda environment where Azure Maching Learning SDK is installed.\n",
+    "You need to install the popular plotting library `matplotlib`, the image manipulation library `opencv`, and the `onnx` library in the conda environment where Azure Maching Learning SDK is installed.\n",
     "\n",
     "```sh\n",
-    "(myenv) $ pip install matplotlib onnx Pillow\n",
+    "(myenv) $ pip install matplotlib onnx opencv-python\n",
     "```\n",
     "\n",
+    "**Debugging tip**: Make sure that to activate your virtual environment (myenv) before you re-launch this notebook using the `jupyter notebook` comand. Choose the respective Python kernel for your new virtual environment using the `Kernel > Change Kernel` menu above. If you have completed the steps correctly, the upper right corner of your screen should state `Python [conda env:myenv]` instead of `Python [default]`.\n",
+    "\n",
     "### 3. Download sample data and pre-trained ONNX model from ONNX Model Zoo.\n",
     "\n",
-    "[Download the ONNX Emotion FER+ model and corresponding test data](https://www.cntk.ai/OnnxModels/emotion_ferplus/opset_7/emotion_ferplus.tar.gz) and place them in the same folder as this tutorial notebook. You can unzip the file through the following line of code.\n",
+    "In the following lines of code, we download [the trained ONNX Emotion FER+ model and corresponding test data](https://github.com/onnx/models/tree/master/emotion_ferplus) and place them in the same folder as this tutorial notebook. For more information about the FER+ dataset, please visit Microsoft Researcher Emad Barsoum's [FER+ source data repository](https://github.com/ebarsoum/FERPlus)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# urllib is a built-in Python library to download files from URLs\n",
     "\n",
-    "```sh\n",
-    "(myenv) $ tar xvzf emotion_ferplus.tar.gz\n",
-    "```\n",
+    "# Objective: retrieve the latest version of the ONNX Emotion FER+ model files from the\n",
+    "# ONNX Model Zoo and save it in the same folder as this tutorial\n",
     "\n",
-    "More information can be found about the ONNX FER+ model on [github](https://github.com/onnx/models/tree/master/emotion_ferplus). For more information about the FER+ dataset, please visit Microsoft Researcher Emad Barsoum's [FER+ source data repository](https://github.com/ebarsoum/FERPlus)."
+    "import urllib.request\n",
+    "\n",
+    "onnx_model_url = \"https://www.cntk.ai/OnnxModels/emotion_ferplus/opset_7/emotion_ferplus.tar.gz\"\n",
+    "\n",
+    "urllib.request.urlretrieve(onnx_model_url, filename=\"emotion_ferplus.tar.gz\")\n",
+    "\n",
+    "# the ! magic command tells our jupyter notebook kernel to run the following line of \n",
+    "# code from the command line instead of the notebook kernel\n",
+    "\n",
+    "# We use tar and xvcf to unzip the files we just retrieved from the ONNX model zoo\n",
+    "\n",
+    "!tar xvzf emotion_ferplus.tar.gz"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Load Azure ML workspace\n",
+    "## Deploy a VM with your ONNX model in the Cloud\n",
+    "\n",
+    "### Load Azure ML workspace\n",
     "\n",
     "We begin by instantiating a workspace object from the existing workspace created earlier in the configuration notebook."
    ]
@@ -136,9 +158,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "models = ws.models()\n",
-    "for m in models:\n",
-    "    print(\"Name:\", m.name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
+    "models = ws.models\n",
+    "for name, m in models.items():\n",
+    "    print(\"Name:\", name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
    ]
   },
   {
@@ -147,9 +169,9 @@
    "source": [
     "### ONNX FER+ Model Methodology\n",
     "\n",
-    "The image classification model we are using is pre-trained using Microsoft's deep learning cognitive toolkit, [CNTK](https://github.com/Microsoft/CNTK), from the [ONNX model zoo](http://github.com/onnx/models). The model zoo has many other models that can be deployed on cloud providers like AzureML without any additional training. To ensure that our cloud deployed model works, we use testing data from the famous FER+ data set, provided as part of the [trained Emotion Recognition model](https://github.com/onnx/models/tree/master/emotion_ferplus) in the ONNX model zoo.\n",
+    "The image classification model we are using is pre-trained using Microsoft's deep learning cognitive toolkit, [CNTK](https://github.com/Microsoft/CNTK), from the [ONNX model zoo](http://github.com/onnx/models). The model zoo has many other models that can be deployed on cloud providers like AzureML without any additional training. To ensure that our cloud deployed model works, we use testing data from the well-known FER+ data set, provided as part of the [trained Emotion Recognition model](https://github.com/onnx/models/tree/master/emotion_ferplus) in the ONNX model zoo.\n",
     "\n",
-    "The original Facial Emotion Recognition (FER) Dataset was released in 2013, but some of the labels are not entirely appropriate for the expression. In the FER+ Dataset, each photo was evaluated by at least 10 croud sourced reviewers, creating a better basis for ground truth. \n",
+    "The original Facial Emotion Recognition (FER) Dataset was released in 2013 by Pierre-Luc Carrier and Aaron Courville as part of a [Kaggle Competition](https://www.kaggle.com/c/challenges-in-representation-learning-facial-expression-recognition-challenge/data), but some of the labels are not entirely appropriate for the expression. In the FER+ Dataset, each photo was evaluated by at least 10 croud sourced reviewers, creating a more accurate basis for ground truth. \n",
     "\n",
     "You can see the difference of label quality in the sample model input below. The FER labels are the first word below each image, and the FER+ labels are the second word below each image.\n",
     "\n",
@@ -202,20 +224,18 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Deploy our model on Azure ML"
+    "### Specify our Score and Environment Files"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We are now going to deploy our ONNX Model on AML with inference in ONNX Runtime. We begin by writing a score.py file, which will help us run the model in our Azure ML virtual machine (VM), and then specify our environment by writing a yml file.\n",
-    "\n",
-    "You will also notice that we import the onnxruntime library to do runtime inference on our ONNX models (passing in input and evaluating out model's predicted output). More information on the API and commands can be found in the [ONNX Runtime documentation](https://aka.ms/onnxruntime).\n",
+    "We are now going to deploy our ONNX Model on AML with inference in ONNX Runtime. We begin by writing a score.py file, which will help us run the model in our Azure ML virtual machine (VM), and then specify our environment by writing a yml file. You will also notice that we import the onnxruntime library to do runtime inference on our ONNX models (passing in input and evaluating out model's predicted output). More information on the API and commands can be found in the [ONNX Runtime documentation](https://aka.ms/onnxruntime).\n",
     "\n",
     "### Write Score File\n",
     "\n",
-    "A score file is what tells our Azure cloud service what to do. After initializing our model using azureml.core.model, we start an ONNX Runtime GPU inference session to evaluate the data passed in on our function calls."
+    "A score file is what tells our Azure cloud service what to do. After initializing our model using azureml.core.model, we start an ONNX Runtime inference session to evaluate the data passed in on our function calls."
    ]
   },
   {
@@ -248,10 +268,13 @@
     "    try:\n",
     "        # load in our data, convert to readable format\n",
     "        data = np.array(json.loads(input_data)['data']).astype('float32')\n",
+    "        \n",
     "        start = time.time()\n",
     "        r = session.run([output_name], {input_name : data})\n",
     "        end = time.time()\n",
+    "        \n",
     "        result = emotion_map(postprocess(r[0]))\n",
+    "        \n",
     "        result_dict = {\"result\": result,\n",
     "                      \"time_in_sec\": [end - start]}\n",
     "    except Exception as e:\n",
@@ -260,9 +283,12 @@
     "    return json.dumps(result_dict)\n",
     "\n",
     "def emotion_map(classes, N=1):\n",
-    "    \"\"\"Take the most probable labels (output of postprocess) and returns the top N emotional labels that fit the picture.\"\"\"\n",
+    "    \"\"\"Take the most probable labels (output of postprocess) and returns the \n",
+    "    top N emotional labels that fit the picture.\"\"\"\n",
+    "    \n",
+    "    emotion_table = {'neutral':0, 'happiness':1, 'surprise':2, 'sadness':3, \n",
+    "                     'anger':4, 'disgust':5, 'fear':6, 'contempt':7}\n",
     "    \n",
-    "    emotion_table = {'neutral':0, 'happiness':1, 'surprise':2, 'sadness':3, 'anger':4, 'disgust':5, 'fear':6, 'contempt':7}\n",
     "    emotion_keys = list(emotion_table.keys())\n",
     "    emotions = []\n",
     "    for i in range(N):\n",
@@ -276,8 +302,8 @@
     "    return e_x / e_x.sum(axis=0)\n",
     "\n",
     "def postprocess(scores):\n",
-    "    \"\"\"This function takes the scores generated by the network and returns the class IDs in decreasing \n",
-    "    order of probability.\"\"\"\n",
+    "    \"\"\"This function takes the scores generated by the network and \n",
+    "    returns the class IDs in decreasing order of probability.\"\"\"\n",
     "    prob = softmax(scores)\n",
     "    prob = np.squeeze(prob)\n",
     "    classes = np.argsort(prob)[::-1]\n",
@@ -299,11 +325,7 @@
    "source": [
     "from azureml.core.conda_dependencies import CondaDependencies \n",
     "\n",
-    "myenv = CondaDependencies()\n",
-    "myenv.add_pip_package(\"numpy\")\n",
-    "myenv.add_pip_package(\"azureml-core\")\n",
-    "myenv.add_pip_package(\"onnxruntime\")\n",
-    "\n",
+    "myenv = CondaDependencies.create(pip_packages=[\"numpy\", \"onnxruntime\", \"azureml-core\"])\n",
     "\n",
     "with open(\"myenv.yml\",\"w\") as f:\n",
     "    f.write(myenv.serialize_to_string())"
@@ -329,11 +351,11 @@
     "image_config = ContainerImage.image_configuration(execution_script = \"score.py\",\n",
     "                                                  runtime = \"python\",\n",
     "                                                  conda_file = \"myenv.yml\",\n",
-    "                                                  description = \"test\",\n",
+    "                                                  description = \"Emotion ONNX Runtime container\",\n",
     "                                                  tags = {\"demo\": \"onnx\"})\n",
     "\n",
     "\n",
-    "image = ContainerImage.create(name = \"onnxtest\",\n",
+    "image = ContainerImage.create(name = \"onnximage\",\n",
     "                              # this is the model object\n",
     "                              models = [model],\n",
     "                              image_config = image_config,\n",
@@ -346,8 +368,6 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Debugging\n",
-    "\n",
     "In case you need to debug your code, the next line of code accesses the log file."
    ]
   },
@@ -364,9 +384,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We're all set! Let's get our model chugging.\n",
+    "We're all done specifying what we want our virtual machine to do. Let's configure and deploy our container image.\n",
     "\n",
-    "## Deploy the container image"
+    "### Deploy the container image"
    ]
   },
   {
@@ -439,23 +459,56 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Testing and Evaluation"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Useful Helper Functions\n",
+    "## Testing and Evaluation\n",
+    "\n",
+    "### Useful Helper Functions\n",
     "\n",
     "We preprocess and postprocess our data (see score.py file) using the helper functions specified in the [ONNX FER+ Model page in the Model Zoo repository](https://github.com/onnx/models/tree/master/emotion_ferplus)."
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def emotion_map(classes, N=1):\n",
+    "    \"\"\"Take the most probable labels (output of postprocess) and returns the \n",
+    "    top N emotional labels that fit the picture.\"\"\"\n",
+    "    \n",
+    "    emotion_table = {'neutral':0, 'happiness':1, 'surprise':2, 'sadness':3, \n",
+    "                     'anger':4, 'disgust':5, 'fear':6, 'contempt':7}\n",
+    "    \n",
+    "    emotion_keys = list(emotion_table.keys())\n",
+    "    emotions = []\n",
+    "    for i in range(N):\n",
+    "        emotions.append(emotion_keys[classes[i]])\n",
+    "    return emotions\n",
+    "\n",
+    "def softmax(x):\n",
+    "    \"\"\"Compute softmax values (probabilities from 0 to 1) for each possible label.\"\"\"\n",
+    "    x = x.reshape(-1)\n",
+    "    e_x = np.exp(x - np.max(x))\n",
+    "    return e_x / e_x.sum(axis=0)\n",
+    "\n",
+    "def postprocess(scores):\n",
+    "    \"\"\"This function takes the scores generated by the network and \n",
+    "    returns the class IDs in decreasing order of probability.\"\"\"\n",
+    "    prob = softmax(scores)\n",
+    "    prob = np.squeeze(prob)\n",
+    "    classes = np.argsort(prob)[::-1]\n",
+    "    return classes"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Load Test Data"
+    "### Load Test Data\n",
+    "\n",
+    "These are already in your directory from your ONNX model download (from the model zoo).\n",
+    "\n",
+    "Notice that our Model Zoo files have a .pb extension. This is because they are [protobuf files (Protocol Buffers)](https://developers.google.com/protocol-buffers/docs/pythontutorial), so we need to read in our data through our ONNX TensorProto reader into a format we can work with, like numerical arrays."
    ]
   },
   {
@@ -475,8 +528,6 @@
     "import json\n",
     "import os\n",
     "\n",
-    "from score import emotion_map, softmax, postprocess\n",
-    "\n",
     "test_inputs = []\n",
     "test_outputs = []\n",
     "\n",
@@ -499,7 +550,7 @@
     "        tensor.ParseFromString(f.read())\n",
     "    \n",
     "    output_data = numpy_helper.to_array(tensor)\n",
-    "    output_processed = emotion_map(postprocess(output_data))[0]\n",
+    "    output_processed = emotion_map(postprocess(output_data[0]))[0]\n",
     "    test_outputs.append(output_processed)"
    ]
   },
@@ -512,7 +563,7 @@
    },
    "source": [
     "### Show some sample images\n",
-    "We use `matplotlib` to plot 3 test images from the model zoo with their labels over them."
+    "We use `matplotlib` to plot 3 test images from the dataset."
    ]
   },
   {
@@ -532,7 +583,7 @@
     "    plt.axhline('')\n",
     "    plt.axvline('')\n",
     "    plt.text(x = 10, y = -10, s = test_outputs[test_image], fontsize = 18)\n",
-    "    plt.imshow(test_inputs[test_image].reshape(64, 64), cmap = plt.cm.Greys)\n",
+    "    plt.imshow(test_inputs[test_image].reshape(64, 64), cmap = plt.cm.gray)\n",
     "plt.show()"
    ]
   },
@@ -571,7 +622,7 @@
     "        print(r['error'])\n",
     "        break\n",
     "        \n",
-    "    result = r['result'][0][0]\n",
+    "    result = r['result'][0]\n",
     "    time_ms = np.round(r['time_in_sec'][0] * 1000, 2)\n",
     "    \n",
     "    ground_truth = test_outputs[i]\n",
@@ -583,7 +634,7 @@
     "\n",
     "    # use different color for misclassified sample\n",
     "    font_color = 'red' if ground_truth != result else 'black'\n",
-    "    clr_map = plt.cm.gray if ground_truth != result else plt.cm.Greys\n",
+    "    clr_map = plt.cm.Greys if ground_truth != result else plt.cm.gray\n",
     "\n",
     "    # ground truth labels are in blue\n",
     "    plt.text(x = 10, y = -70, s = ground_truth, fontsize = 18, color = 'blue')\n",
@@ -611,15 +662,30 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from PIL import Image\n",
+    "# Preprocessing functions take your image and format it so it can be passed\n",
+    "# as input into our ONNX model\n",
     "\n",
-    "def preprocess(image_path):\n",
-    "    input_shape = (1, 1, 64, 64)\n",
-    "    img = Image.open(image_path)\n",
-    "    img = img.resize((64, 64), Image.ANTIALIAS)\n",
-    "    img_data = np.array(img)\n",
-    "    img_data = np.resize(img_data, input_shape)\n",
-    "    return img_data"
+    "import cv2\n",
+    "\n",
+    "def rgb2gray(rgb):\n",
+    "    \"\"\"Convert the input image into grayscale\"\"\"\n",
+    "    return np.dot(rgb[...,:3], [0.299, 0.587, 0.114])\n",
+    "\n",
+    "def resize_img(img):\n",
+    "    \"\"\"Resize image to MNIST model input dimensions\"\"\"\n",
+    "    img = cv2.resize(img, dsize=(64, 64), interpolation=cv2.INTER_AREA)\n",
+    "    img.resize((1, 1, 64, 64))\n",
+    "    return img\n",
+    "\n",
+    "def preprocess(img):\n",
+    "    \"\"\"Resize input images and convert them to grayscale.\"\"\"\n",
+    "    if img.shape == (64, 64):\n",
+    "        img.resize((1, 1, 64, 64))\n",
+    "        return img\n",
+    "    \n",
+    "    grayscale = rgb2gray(img)\n",
+    "    processed_img = resize_img(grayscale)\n",
+    "    return processed_img"
    ]
   },
   {
@@ -634,14 +700,19 @@
     "# Any PNG or JPG image file should work\n",
     "# Make sure to include the entire path with // instead of /\n",
     "\n",
-    "# e.g. your_test_image = \"C://Users//vinitra.swamy//Pictures//emotion_test_images//img_1.png\"\n",
+    "# e.g. your_test_image = \"C:/Users/vinitra.swamy/Pictures/face.png\"\n",
     "\n",
     "your_test_image = \"<path to file>\"\n",
     "\n",
+    "import matplotlib.image as mpimg\n",
+    "\n",
     "if your_test_image != \"<path to file>\":\n",
-    "    img = preprocess(your_test_image)\n",
+    "    img = mpimg.imread(your_test_image)\n",
     "    plt.subplot(1,3,1)\n",
-    "    plt.imshow(img.reshape((64,64)), cmap = plt.cm.gray)\n",
+    "    plt.imshow(img, cmap = plt.cm.Greys)\n",
+    "    print(\"Old Dimensions: \", img.shape)\n",
+    "    img = preprocess(img)\n",
+    "    print(\"New Dimensions: \", img.shape)\n",
     "else:\n",
     "    img = None"
    ]
@@ -659,7 +730,7 @@
     "\n",
     "    try:\n",
     "        r = json.loads(aci_service.run(input_data))\n",
-    "        result = r['result'][0][0]\n",
+    "        result = r['result'][0]\n",
     "        time_ms = np.round(r['time_in_sec'][0] * 1000, 2)\n",
     "    except Exception as e:\n",
     "        print(str(e))\n",
@@ -668,12 +739,13 @@
     "    plt.subplot(1,8,1)\n",
     "    plt.axhline('')\n",
     "    plt.axvline('')\n",
-    "    plt.text(x = -10, y = -35, s = \"Model prediction: \", fontsize = 14)\n",
-    "    plt.text(x = -10, y = -20, s = \"Inference time: \", fontsize = 14)\n",
-    "    plt.text(x = 100, y = -35, s = str(result), fontsize = 14)\n",
-    "    plt.text(x = 100, y = -20, s = str(time_ms) + \" ms\", fontsize = 14)\n",
-    "    plt.text(x = -10, y = -8, s = \"Input image: \", fontsize = 14)\n",
-    "    plt.imshow(img.reshape(64, 64), cmap = plt.cm.gray)    "
+    "    plt.text(x = -10, y = -40, s = \"Model prediction: \", fontsize = 14)\n",
+    "    plt.text(x = -10, y = -25, s = \"Inference time: \", fontsize = 14)\n",
+    "    plt.text(x = 100, y = -40, s = str(result), fontsize = 14)\n",
+    "    plt.text(x = 100, y = -25, s = str(time_ms) + \" ms\", fontsize = 14)\n",
+    "    plt.text(x = -10, y = -10, s = \"Model Input image: \", fontsize = 14)\n",
+    "    plt.imshow(img.reshape((64, 64)), cmap = plt.cm.gray)    \n",
+    "     "
    ]
   },
   {
@@ -708,10 +780,15 @@
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "viswamy"
+   }
+  ],
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3.6",
    "language": "python",
-   "name": "python3"
+   "name": "python36"
   },
   "language_info": {
    "codemirror_mode": {
@@ -723,7 +800,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.5"
+   "version": "3.6.6"
   },
   "msauthor": "vinitra.swamy"
  },

how-to-use-azureml/deployment/onnx/onnx-inference-mnist-deploy.ipynb

@@ -12,7 +12,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Handwritten Digit Classification (MNIST) using ONNX Runtime on AzureML\n",
+    "# Handwritten Digit Classification (MNIST) using ONNX Runtime on Azure ML\n",
     "\n",
     "This example shows how to deploy an image classification neural network using the Modified National Institute of Standards and Technology ([MNIST](http://yann.lecun.com/exdb/mnist/)) dataset and Open Neural Network eXchange format ([ONNX](http://aka.ms/onnxdocarticle)) on the Azure Machine Learning platform. MNIST is a popular dataset consisting of 70,000 grayscale images. Each image is a handwritten digit of 28x28 pixels, representing number from 0 to 9. This tutorial will show you how to deploy a MNIST model from the [ONNX model zoo](https://github.com/onnx/models), use it to make predictions using ONNX Runtime Inference, and deploy it as a web service in Azure.\n",
     "\n",
@@ -22,9 +22,9 @@
     "\n",
     "#### Tutorial Objectives:\n",
     "\n",
-    "1. Describe the MNIST dataset and pretrained Convolutional Neural Net ONNX model, stored in the ONNX model zoo.\n",
-    "2. Deploy and run the pretrained MNIST ONNX model on an Azure Machine Learning instance\n",
-    "3. Predict labels for test set data points in the cloud using ONNX Runtime and Azure ML"
+    "- Describe the MNIST dataset and pretrained Convolutional Neural Net ONNX model, stored in the ONNX model zoo.\n",
+    "- Deploy and run the pretrained MNIST ONNX model on an Azure Machine Learning instance\n",
+    "- Predict labels for test set data points in the cloud using ONNX Runtime and Azure ML"
    ]
   },
   {
@@ -34,31 +34,61 @@
     "## Prerequisites\n",
     "\n",
     "### 1. Install Azure ML SDK and create a new workspace\n",
-    "Please follow [00.configuration.ipynb](https://github.com/Azure/MachineLearningNotebooks/blob/master/00.configuration.ipynb) notebook.\n",
+    "Please follow [Azure ML configuration notebook](https://github.com/Azure/MachineLearningNotebooks/blob/master/00.configuration.ipynb) to set up your environment.\n",
     "\n",
-    "### 2. Install additional packages needed for this Notebook\n",
-    "You need to install the popular plotting library `matplotlib`, the image manipulation library `opencv`, and the `onnx` library in the conda environment where Azure Maching Learning SDK is installed.\n",
+    "### 2. Install additional packages needed for this tutorial notebook\n",
+    "You need to install the popular plotting library `matplotlib`, the image manipulation library `opencv`, and the `onnx` library in the conda environment where Azure Maching Learning SDK is installed. \n",
     "\n",
     "```sh\n",
     "(myenv) $ pip install matplotlib onnx opencv-python\n",
     "```\n",
     "\n",
+    "**Debugging tip**: Make sure that you run the \"jupyter notebook\" command to launch this notebook after activating your virtual environment. Choose the respective Python kernel for your new virtual environment using the `Kernel > Change Kernel` menu above. If you have completed the steps correctly, the upper right corner of your screen should state `Python [conda env:myenv]` instead of `Python [default]`.\n",
+    "\n",
     "### 3. Download sample data and pre-trained ONNX model from ONNX Model Zoo.\n",
     "\n",
-    "[Download the ONNX MNIST model and corresponding test data](https://www.cntk.ai/OnnxModels/mnist/opset_7/mnist.tar.gz) and place them in the same folder as this tutorial notebook. You can unzip the file through the following line of code.\n",
+    "In the following lines of code, we download [the trained ONNX MNIST model and corresponding test data](https://github.com/onnx/models/tree/master/mnist) and place them in the same folder as this tutorial notebook. For more information about the MNIST dataset, please visit [Yan LeCun's website](http://yann.lecun.com/exdb/mnist/)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# urllib is a built-in Python library to download files from URLs\n",
     "\n",
-    "```sh\n",
-    "(myenv) $ tar xvzf mnist.tar.gz\n",
-    "```\n",
+    "# Objective: retrieve the latest version of the ONNX MNIST model files from the\n",
+    "# ONNX Model Zoo and save it in the same folder as this tutorial\n",
     "\n",
-    "More information can be found about the ONNX MNIST model on [github](https://github.com/onnx/models/tree/master/mnist). For more information about the MNIST dataset, please visit [Yan LeCun's website](http://yann.lecun.com/exdb/mnist/)."
+    "import urllib.request\n",
+    "\n",
+    "onnx_model_url = \"https://www.cntk.ai/OnnxModels/mnist/opset_7/mnist.tar.gz\"\n",
+    "\n",
+    "urllib.request.urlretrieve(onnx_model_url, filename=\"mnist.tar.gz\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# the ! magic command tells our jupyter notebook kernel to run the following line of \n",
+    "# code from the command line instead of the notebook kernel\n",
+    "\n",
+    "# We use tar and xvcf to unzip the files we just retrieved from the ONNX model zoo\n",
+    "\n",
+    "!tar xvzf mnist.tar.gz"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Load Azure ML workspace\n",
+    "## Deploy a VM with your ONNX model in the Cloud\n",
+    "\n",
+    "### Load Azure ML workspace\n",
     "\n",
     "We begin by instantiating a workspace object from the existing workspace created earlier in the configuration notebook."
    ]
@@ -113,11 +143,11 @@
    "source": [
     "from azureml.core.model import Model\n",
     "\n",
-    "model = Model.register(model_path = model_dir + \"//model.onnx\",\n",
+    "model = Model.register(workspace = ws,\n",
+    "                       model_path = model_dir + \"/\" + \"model.onnx\",\n",
     "                       model_name = \"mnist_1\",\n",
     "                       tags = {\"onnx\": \"demo\"},\n",
-    "                       description = \"MNIST image classification CNN from ONNX Model Zoo\",\n",
-    "                       workspace = ws)"
+    "                       description = \"MNIST image classification CNN from ONNX Model Zoo\",)"
    ]
   },
   {
@@ -135,9 +165,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "models = ws.models()\n",
-    "for m in models:\n",
-    "    print(\"Name:\", m.name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
+    "models = ws.models\n",
+    "for name, m in models.items():\n",
+    "    print(\"Name:\", name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
    ]
   },
   {
@@ -188,16 +218,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Deploy our model on Azure ML"
+    "### Specify our Score and Environment Files"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We are now going to deploy our ONNX Model on AML with inference in ONNX Runtime. We begin by writing a score.py file, which will help us run the model in our Azure ML virtual machine (VM), and then specify our environment by writing a yml file.\n",
-    "\n",
-    "You will also notice that we import the onnxruntime library to do runtime inference on our ONNX models (passing in input and evaluating out model's predicted output). More information on the API and commands can be found in the [ONNX Runtime documentation](https://aka.ms/onnxruntime).\n",
+    "We are now going to deploy our ONNX Model on AML with inference in ONNX Runtime. We begin by writing a score.py file, which will help us run the model in our Azure ML virtual machine (VM), and then specify our environment by writing a yml file. You will also notice that we import the onnxruntime library to do runtime inference on our ONNX models (passing in input and evaluating out model's predicted output). More information on the API and commands can be found in the [ONNX Runtime documentation](https://aka.ms/onnxruntime).\n",
     "\n",
     "### Write Score File\n",
     "\n",
@@ -248,7 +276,7 @@
     "    return json.dumps(result_dict)\n",
     "\n",
     "def choose_class(result_prob):\n",
-    "    \"\"\"We use argmax to determine the right label to choose from our output, after calling softmax on the 10 numbers we receive\"\"\"\n",
+    "    \"\"\"We use argmax to determine the right label to choose from our output\"\"\"\n",
     "    return int(np.argmax(result_prob, axis=0))"
    ]
   },
@@ -256,14 +284,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Write Environment File"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This step creates a YAML file that specifies which dependencies we would like to see in our Linux Virtual Machine."
+    "### Write Environment File\n",
+    "\n",
+    "This step creates a YAML environment file that specifies which dependencies we would like to see in our Linux Virtual Machine."
    ]
   },
   {
@@ -274,11 +297,7 @@
    "source": [
     "from azureml.core.conda_dependencies import CondaDependencies \n",
     "\n",
-    "myenv = CondaDependencies()\n",
-    "myenv.add_pip_package(\"numpy\")\n",
-    "myenv.add_pip_package(\"azureml-core\")\n",
-    "myenv.add_pip_package(\"onnxruntime\")\n",
-    "\n",
+    "myenv = CondaDependencies.create(pip_packages=[\"numpy\", \"onnxruntime\", \"azureml-core\"])\n",
     "\n",
     "with open(\"myenv.yml\",\"w\") as f:\n",
     "    f.write(myenv.serialize_to_string())"
@@ -289,7 +308,6 @@
    "metadata": {},
    "source": [
     "### Create the Container Image\n",
-    "\n",
     "This step will likely take a few minutes."
    ]
   },
@@ -304,11 +322,11 @@
     "image_config = ContainerImage.image_configuration(execution_script = \"score.py\",\n",
     "                                                  runtime = \"python\",\n",
     "                                                  conda_file = \"myenv.yml\",\n",
-    "                                                  description = \"test\",\n",
-    "                                                  tags = {\"demo\": \"onnx\"})                                                 )\n",
+    "                                                  description = \"MNIST ONNX Runtime container\",\n",
+    "                                                  tags = {\"demo\": \"onnx\"}) \n",
     "\n",
     "\n",
-    "image = ContainerImage.create(name = \"onnxtest\",\n",
+    "image = ContainerImage.create(name = \"onnximage\",\n",
     "                              # this is the model object\n",
     "                              models = [model],\n",
     "                              image_config = image_config,\n",
@@ -321,8 +339,6 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Debugging\n",
-    "\n",
     "In case you need to debug your code, the next line of code accesses the log file."
    ]
   },
@@ -339,9 +355,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We're all set! Let's get our model chugging.\n",
+    "We're all done specifying what we want our virtual machine to do. Let's configure and deploy our container image.\n",
     "\n",
-    "## Deploy the container image"
+    "### Deploy the container image"
    ]
   },
   {
@@ -414,16 +430,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Testing and Evaluation"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Load Test Data\n",
+    "## Testing and Evaluation\n",
     "\n",
-    "These are already in your directory from your ONNX model download (from the model zoo). If you didn't place your model and test data in the same directory as this notebook, edit the \"model_dir\" filename below."
+    "### Load Test Data\n",
+    "\n",
+    "These are already in your directory from your ONNX model download (from the model zoo).\n",
+    "\n",
+    "Notice that our Model Zoo files have a .pb extension. This is because they are [protobuf files (Protocol Buffers)](https://developers.google.com/protocol-buffers/docs/pythontutorial), so we need to read in our data through our ONNX TensorProto reader into a format we can work with, like numerical arrays."
    ]
   },
   {
@@ -579,7 +592,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Preprocessing functions\n",
+    "# Preprocessing functions take your image and format it so it can be passed\n",
+    "# as input into our ONNX model\n",
+    "\n",
     "import cv2\n",
     "\n",
     "def rgb2gray(rgb):\n",
@@ -587,12 +602,17 @@
     "    return np.dot(rgb[...,:3], [0.299, 0.587, 0.114])\n",
     "\n",
     "def resize_img(img):\n",
+    "    \"\"\"Resize image to MNIST model input dimensions\"\"\"\n",
     "    img = cv2.resize(img, dsize=(28, 28), interpolation=cv2.INTER_AREA)\n",
     "    img.resize((1, 1, 28, 28))\n",
     "    return img\n",
     "\n",
     "def preprocess(img):\n",
     "    \"\"\"Resize input images and convert them to grayscale.\"\"\"\n",
+    "    if img.shape == (28, 28):\n",
+    "        img.resize((1, 1, 28, 28))\n",
+    "        return img\n",
+    "    \n",
     "    grayscale = rgb2gray(img)\n",
     "    processed_img = resize_img(grayscale)\n",
     "    return processed_img"
@@ -608,12 +628,11 @@
     "# Make sure your image is square and the dimensions are equal (i.e. 100 * 100 pixels or 28 * 28 pixels)\n",
     "\n",
     "# Any PNG or JPG image file should work\n",
-    "# Make sure to include the entire path with // instead of /\n",
-    "\n",
-    "# e.g. your_test_image = \"C://Users//vinitra.swamy//Pictures//digit.png\"\n",
     "\n",
     "your_test_image = \"<path to file>\"\n",
     "\n",
+    "# e.g. your_test_image = \"C:/Users/vinitra.swamy/Pictures/handwritten_digit.png\"\n",
+    "\n",
     "import matplotlib.image as mpimg\n",
     "\n",
     "if your_test_image != \"<path to file>\":\n",
@@ -738,16 +757,21 @@
     "- ensured that your deep learning model is working perfectly (in the cloud) on test data, and checked it against some of your own!\n",
     "\n",
     "Next steps:\n",
-    "- Check out another interesting application based on a Microsoft Research computer vision paper that lets you set up a [facial emotion recognition model](https://github.com/Azure/MachineLearningNotebooks/tree/master/onnx/onnx-inference-emotion-recognition.ipynb) in the cloud! This tutorial deploys a pre-trained ONNX Computer Vision model in an Azure ML virtual machine with GPU support.\n",
+    "- Check out another interesting application based on a Microsoft Research computer vision paper that lets you set up a [facial emotion recognition model](https://github.com/Azure/MachineLearningNotebooks/tree/master/onnx/onnx-inference-emotion-recognition.ipynb) in the cloud! This tutorial deploys a pre-trained ONNX Computer Vision model in an Azure ML virtual machine.\n",
     "- Contribute to our [open source ONNX repository on github](http://github.com/onnx/onnx) and/or add to our [ONNX model zoo](http://github.com/onnx/models)"
    ]
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "viswamy"
+   }
+  ],
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3.6",
    "language": "python",
-   "name": "python3"
+   "name": "python36"
   },
   "language_info": {
    "codemirror_mode": {
@@ -759,7 +783,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.5"
+   "version": "3.6.6"
   },
   "msauthor": "vinitra.swamy"
  },

how-to-use-azureml/deployment/onnx/onnx-modelzoo-aml-deploy-resnet50.ipynb

@@ -0,0 +1,419 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# ResNet50 Image Classification using ONNX and AzureML\n",
+    "\n",
+    "This example shows how to deploy the ResNet50 ONNX model as a web service using Azure Machine Learning services and the ONNX Runtime.\n",
+    "\n",
+    "## What is ONNX\n",
+    "ONNX is an open format for representing machine learning and deep learning models. ONNX enables open and interoperable AI by enabling data scientists and developers to use the tools of their choice without worrying about lock-in and flexibility to deploy to a variety of platforms. ONNX is developed and supported by a community of partners including Microsoft, Facebook, and Amazon. For more information, explore the [ONNX website](http://onnx.ai).\n",
+    "\n",
+    "## ResNet50 Details\n",
+    "ResNet classifies the major object in an input image into a set of 1000 pre-defined classes. For more information about the ResNet50 model and how it was created can be found on the [ONNX Model Zoo github](https://github.com/onnx/models/tree/master/models/image_classification/resnet). "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prerequisites\n",
+    "\n",
+    "To make the best use of your time, make sure you have done the following:\n",
+    "\n",
+    "* Understand the [architecture and terms](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture) introduced by Azure Machine Learning\n",
+    "* Go through the [00.configuration.ipynb](../00.configuration.ipynb) notebook to:\n",
+    "    * install the AML SDK\n",
+    "    * create a workspace and its configuration file (config.json)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Check core SDK version number\n",
+    "import azureml.core\n",
+    "\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Download pre-trained ONNX model from ONNX Model Zoo.\n",
+    "\n",
+    "Download the [ResNet50v2 model and test data](https://s3.amazonaws.com/onnx-model-zoo/resnet/resnet50v2/resnet50v2.tar.gz) and extract it in the same folder as this tutorial notebook.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import urllib.request\n",
+    "\n",
+    "onnx_model_url = \"https://s3.amazonaws.com/onnx-model-zoo/resnet/resnet50v2/resnet50v2.tar.gz\"\n",
+    "urllib.request.urlretrieve(onnx_model_url, filename=\"resnet50v2.tar.gz\")\n",
+    "\n",
+    "!tar xvzf resnet50v2.tar.gz"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Deploying as a web service with Azure ML"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Load your Azure ML workspace\n",
+    "\n",
+    "We begin by instantiating a workspace object from the existing workspace created earlier in the configuration notebook."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Workspace\n",
+    "\n",
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.location, ws.resource_group, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Register your model with Azure ML\n",
+    "\n",
+    "Now we upload the model and register it in the workspace."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.model import Model\n",
+    "\n",
+    "model = Model.register(model_path = \"resnet50v2/resnet50v2.onnx\",\n",
+    "                       model_name = \"resnet50v2\",\n",
+    "                       tags = {\"onnx\": \"demo\"},\n",
+    "                       description = \"ResNet50v2 from ONNX Model Zoo\",\n",
+    "                       workspace = ws)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Displaying your registered models\n",
+    "\n",
+    "You can optionally list out all the models that you have registered in this workspace."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "models = ws.models\n",
+    "for name, m in models.items():\n",
+    "    print(\"Name:\", name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Write scoring file\n",
+    "\n",
+    "We are now going to deploy our ONNX model on Azure ML using the ONNX Runtime. We begin by writing a score.py file that will be invoked by the web service call. The `init()` function is called once when the container is started so we load the model using the ONNX Runtime into a global session object."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%writefile score.py\n",
+    "import json\n",
+    "import time\n",
+    "import sys\n",
+    "import os\n",
+    "from azureml.core.model import Model\n",
+    "import numpy as np    # we're going to use numpy to process input and output data\n",
+    "import onnxruntime    # to inference ONNX models, we use the ONNX Runtime\n",
+    "\n",
+    "def softmax(x):\n",
+    "    x = x.reshape(-1)\n",
+    "    e_x = np.exp(x - np.max(x))\n",
+    "    return e_x / e_x.sum(axis=0)\n",
+    "\n",
+    "def init():\n",
+    "    global session\n",
+    "    model = Model.get_model_path(model_name = 'resnet50v2')\n",
+    "    session = onnxruntime.InferenceSession(model, None)\n",
+    "\n",
+    "def preprocess(input_data_json):\n",
+    "    # convert the JSON data into the tensor input\n",
+    "    img_data = np.array(json.loads(input_data_json)['data']).astype('float32')\n",
+    "    \n",
+    "    #normalize\n",
+    "    mean_vec = np.array([0.485, 0.456, 0.406])\n",
+    "    stddev_vec = np.array([0.229, 0.224, 0.225])\n",
+    "    norm_img_data = np.zeros(img_data.shape).astype('float32')\n",
+    "    for i in range(img_data.shape[0]):\n",
+    "        norm_img_data[i,:,:] = (img_data[i,:,:]/255 - mean_vec[i]) / stddev_vec[i]\n",
+    "\n",
+    "    return norm_img_data\n",
+    "\n",
+    "def postprocess(result):\n",
+    "    return softmax(np.array(result)).tolist()\n",
+    "\n",
+    "def run(input_data_json):\n",
+    "    try:\n",
+    "        start = time.time()\n",
+    "        # load in our data which is expected as NCHW 224x224 image\n",
+    "        input_data = preprocess(input_data_json)\n",
+    "        input_name = session.get_inputs()[0].name  # get the id of the first input of the model   \n",
+    "        result = session.run([], {input_name: input_data})\n",
+    "        end = time.time()     # stop timer\n",
+    "        return {\"result\": postprocess(result),\n",
+    "                \"time\": end - start}\n",
+    "    except Exception as e:\n",
+    "        result = str(e)\n",
+    "        return {\"error\": result}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Create container image"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "First we create a YAML file that specifies which dependencies we would like to see in our container."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.conda_dependencies import CondaDependencies \n",
+    "\n",
+    "myenv = CondaDependencies.create(pip_packages=[\"numpy\",\"onnxruntime\",\"azureml-core\"])\n",
+    "\n",
+    "with open(\"myenv.yml\",\"w\") as f:\n",
+    "    f.write(myenv.serialize_to_string())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Then we have Azure ML create the container. This step will likely take a few minutes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.image import ContainerImage\n",
+    "\n",
+    "image_config = ContainerImage.image_configuration(execution_script = \"score.py\",\n",
+    "                                                  runtime = \"python\",\n",
+    "                                                  conda_file = \"myenv.yml\",\n",
+    "                                                  description = \"ONNX ResNet50 Demo\",\n",
+    "                                                  tags = {\"demo\": \"onnx\"}\n",
+    "                                                 )\n",
+    "\n",
+    "\n",
+    "image = ContainerImage.create(name = \"onnxresnet50v2\",\n",
+    "                              models = [model],\n",
+    "                              image_config = image_config,\n",
+    "                              workspace = ws)\n",
+    "\n",
+    "image.wait_for_creation(show_output = True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In case you need to debug your code, the next line of code accesses the log file."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(image.image_build_log_uri)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We're all set! Let's get our model chugging.\n",
+    "\n",
+    "### Deploy the container image"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.webservice import AciWebservice\n",
+    "\n",
+    "aciconfig = AciWebservice.deploy_configuration(cpu_cores = 1, \n",
+    "                                               memory_gb = 1, \n",
+    "                                               tags = {'demo': 'onnx'}, \n",
+    "                                               description = 'web service for ResNet50 ONNX model')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The following cell will likely take a few minutes to run as well."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.webservice import Webservice\n",
+    "from random import randint\n",
+    "\n",
+    "aci_service_name = 'onnx-demo-resnet50'+str(randint(0,100))\n",
+    "print(\"Service\", aci_service_name)\n",
+    "\n",
+    "aci_service = Webservice.deploy_from_image(deployment_config = aciconfig,\n",
+    "                                           image = image,\n",
+    "                                           name = aci_service_name,\n",
+    "                                           workspace = ws)\n",
+    "\n",
+    "aci_service.wait_for_deployment(True)\n",
+    "print(aci_service.state)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In case the deployment fails, you can check the logs. Make sure to delete your aci_service before trying again."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if aci_service.state != 'Healthy':\n",
+    "    # run this command for debugging.\n",
+    "    print(aci_service.get_logs())\n",
+    "    aci_service.delete()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Success!\n",
+    "\n",
+    "If you've made it this far, you've deployed a working web service that does image classification using an ONNX model. You can get the URL for the webservice with the code below."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(aci_service.scoring_uri)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "When you are eventually done using the web service, remember to delete it."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#aci_service.delete()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "onnx"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.5.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/deployment/production-deploy-to-aks/production-deploy-to-aks.ipynb

@@ -122,9 +122,11 @@
     "        data = json.loads(raw_data)['data']\n",
     "        data = numpy.array(data)\n",
     "        result = model.predict(data)\n",
+    "        # you can return any data type as long as it is JSON-serializable\n",
+    "        return result.tolist()\n",
     "    except Exception as e:\n",
-    "        result = str(e)\n",
-    "    return json.dumps({\"result\": result.tolist()})"
+    "        error = str(e)\n",
+    "        return error"
    ]
   },
   {
@@ -222,7 +224,8 @@
     "\n",
     "create_name='my-existing-aks' \n",
     "# Create the cluster\n",
-    "aks_target = AksCompute.attach(workspace=ws, name=create_name, resource_id=resource_id)\n",
+    "attach_config = AksCompute.attach_configuration(resource_id=resource_id)\n",
+    "aks_target = ComputeTarget.attach(workspace=ws, name=create_name, attach_configuration=attach_config)\n",
     "# Wait for the operation to complete\n",
     "aks_target.wait_for_completion(True)\n",
     "'''"
@@ -312,6 +315,11 @@
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "raymondl"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",
@@ -327,7 +335,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.5"
+   "version": "3.6.6"
   }
  },
  "nbformat": 4,

how-to-use-azureml/deployment/register-model-create-image-deploy-service/register-model-create-image-deploy-service.ipynb

@@ -129,9 +129,9 @@
    },
    "outputs": [],
    "source": [
-    "regression_models = ws.models(tags=['area'])\n",
-    "for name, m in regression_models.items():\n",
-    "    print(\"Name:\", name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
+    "regression_models = Model.list(workspace=ws, tags=['area'])\n",
+    "for m in regression_models:\n",
+    "    print(\"Name:\", m.name,\"\\tVersion:\", m.version, \"\\tDescription:\", m.description, m.tags)"
    ]
   },
   {
@@ -192,9 +192,11 @@
     "        data = json.loads(raw_data)['data']\n",
     "        data = numpy.array(data)\n",
     "        result = model.predict(data)\n",
+    "        # you can return any datatype as long as it is JSON-serializable\n",
+    "        return result.tolist()\n",
     "    except Exception as e:\n",
-    "        result = str(e)\n",
-    "    return json.dumps({\"result\": result.tolist()})"
+    "        error = str(e)\n",
+    "        return error"
    ]
   },
   {
@@ -363,7 +365,7 @@
     "]})\n",
     "test_sample = bytes(test_sample,encoding = 'utf8')\n",
     "\n",
-    "prediction = aci_service.run(input_data = test_sample)\n",
+    "prediction = aci_service.run(input_data=test_sample)\n",
     "print(prediction)"
    ]
   },
@@ -387,16 +389,14 @@
    "source": [
     "aci_service.delete()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "raymondl"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",
@@ -412,7 +412,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.5"
+   "version": "3.6.6"
   }
  },
  "nbformat": 4,

how-to-use-azureml/machine-learning-pipelines/README.md

@@ -0,0 +1,49 @@
+# Azure Machine Learning Pipeline
+
+## Overview
+
+The [Azure Machine Learning Pipelines](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-ml-pipelines) enables data scientists to create and manage multiple simple and complex workflows concurrently. A typical pipeline would have multiple tasks to prepare data, train, deploy and evaluate models. Individual steps in the pipeline can make use of diverse compute options (for example: CPU for data preparation and GPU for training) and languages. 
+
+The Python-based Azure Machine Learning Pipeline SDK provides interfaces to work with Azure Machine Learning Pipelines. To get started quickly, the SDK includes imperative constructs for sequencing and parallelization of steps. With the use of declarative data dependencies, optimized execution of the tasks can be achieved. The SDK can be easily used from Jupyter Notebook or any other preferred IDE. The SDK includes a framework of pre-built modules for common tasks such as data transfer and compute provisioning.
+
+Data management and reuse across pipelines and pipeline runs is simplified using named and strictly versioned data sources and named inputs and outputs for processing tasks. Pipelines enable collaboration across teams of data scientists by recording all intermediate tasks and data.
+
+### Why build pipelines?
+
+With pipelines, you can optimize your workflow with simplicity, speed, portability, and reuse. When building pipelines with Azure Machine Learning, you can focus on what you know best — machine learning — rather than infrastructure.
+
+Using distinct steps makes it possible to rerun only the steps you need as you tweak and test your workflow. Once the pipeline is designed, there is often more fine-tuning around the training loop of the pipeline. When you rerun a pipeline, the execution jumps to the steps that need to be rerun, such as an updated training script, and skips what hasn't changed. The same paradigm applies to unchanged scripts and metadata.
+
+With Azure Machine Learning, you can use distinct toolkits and frameworks for each step in your pipeline. Azure coordinates between the various compute targets you use so that your intermediate data can be shared with the downstream compute targets easily.
+
+![MLLifecycle](aml-pipelines-concept.png)
+
+
+### Azure Machine Learning Pipelines Features
+Azure Machine Learning Pipelines optimize for simplicity, speed, and efficiency. The following key concepts make it possible for a data scientist to focus on ML rather than infrastructure.
+
+**Unattended execution**: Schedule a few scripts to run in parallel or in sequence in a reliable and unattended manner. Since data prep and modeling can last days or weeks, you can now focus on other tasks while your pipeline is running.
+
+**Mixed and diverse compute**: Use multiple pipelines that are reliably coordinated across heterogeneous and scalable computes and storages. Individual pipeline steps can be run on different compute targets, such as HDInsight, GPU Data Science VMs, and Databricks, to make efficient use of available compute options.
+
+**Reusability**: Pipelines can be templatized for specific scenarios such as retraining and batch scoring. They can be triggered from external systems via simple REST calls.
+
+**Tracking and versioning**: Instead of manually tracking data and result paths as you iterate, use the pipelines SDK to explicitly name and version your data sources, inputs, and outputs as well as manage scripts and data separately for increased productivity.
+
+### Notebooks 
+
+In this directory, there are two types of notebooks: 
+
+* The first type of notebooks will introduce you to core Azure Machine Learning Pipelines features. These notebooks below belong in this category, and are designed to go in sequence; they're all located in the "intro-to-pipelines" folder:
+
+1. [aml-pipelines-getting-started.ipynb](https://aka.ms/pl-get-started)
+2. [aml-pipelines-with-data-dependency-steps.ipynb](https://aka.ms/pl-data-dep)
+3. [aml-pipelines-publish-and-run-using-rest-endpoint.ipynb](https://aka.ms/pl-pub-rep)
+4. [aml-pipelines-data-transfer.ipynb](https://aka.ms/pl-data-trans)
+5. [aml-pipelines-use-databricks-as-compute-target.ipynb](https://aka.ms/pl-databricks)
+6. [aml-pipelines-use-adla-as-compute-target.ipynb] (https://aka.ms/pl-adla)
+
+* The second type of notebooks illustrate more sophisticated scenarios, and are independent of each other. These notebooks include:
+
+1. [pipeline-batch-scoring.ipynb](https://aka.ms/pl-batch-score)
+2. [pipeline-style-transfer.ipynb] (https://aka.ms/pl-style-trans)

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-data-transfer.ipynb

@@ -0,0 +1,332 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Azure Machine Learning Pipeline with DataTranferStep\n",
+    "This notebook is used to demonstrate the use of DataTranferStep in Azure Machine Learning Pipeline.\n",
+    "\n",
+    "In certain cases, you will need to transfer data from one data location to another. For example, your data may be in Files storage and you may want to move it to Blob storage. Or, if your data is in an ADLS account and you want to make it available in the Blob storage. The built-in **DataTransferStep** class helps you transfer data in these situations.\n",
+    "\n",
+    "The below example shows how to move data in an ADLS account to Blob storage."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Azure Machine Learning and Pipeline SDK-specific imports"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "import azureml.core\n",
+    "from azureml.core.compute import ComputeTarget, DatabricksCompute, DataFactoryCompute\n",
+    "from azureml.exceptions import ComputeTargetException\n",
+    "from azureml.core import Workspace, Run, Experiment\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData\n",
+    "from azureml.pipeline.steps import AdlaStep\n",
+    "from azureml.core.datastore import Datastore\n",
+    "from azureml.data.data_reference import DataReference\n",
+    "from azureml.data.sql_data_reference import SqlDataReference\n",
+    "from azureml.core import attach_legacy_compute_target\n",
+    "from azureml.data.stored_procedure_parameter import StoredProcedureParameter, StoredProcedureParameterType\n",
+    "from azureml.pipeline.steps import DataTransferStep\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize Workspace\n",
+    "\n",
+    "Initialize a workspace object from persisted configuration. Make sure the config file is present at .\\config.json\n",
+    "\n",
+    "If you don't have a config.json file, please go through the configuration Notebook located here:\n",
+    "https://github.com/Azure/MachineLearningNotebooks. \n",
+    "\n",
+    "This sets you up with a working config file that has information on your workspace, subscription id, etc. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "create workspace"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Register Datastores\n",
+    "\n",
+    "In the code cell below, you will need to fill in the appropriate values for the workspace name, datastore name, subscription id, resource group, store name, tenant id, client id, and client secret that are associated with your ADLS datastore. \n",
+    "\n",
+    "For background on registering your data store, consult this article:\n",
+    "\n",
+    "https://docs.microsoft.com/en-us/azure/data-lake-store/data-lake-store-service-to-service-authenticate-using-active-directory"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "workspace = ws.name\n",
+    "datastore_name='MyAdlsDatastore'\n",
+    "subscription_id=os.getenv(\"ADL_SUBSCRIPTION_62\" \"<my-subscription-id>\"), # subscription id of ADLS account\n",
+    "resource_group=os.getenv(\"ADL_RESOURCE_GROUP_62\" \"<my-resource-group>\"), # resource group of ADLS account\n",
+    "store_name=os.getenv(\"ADL_STORENAME_62\", \"<my-datastore-name>\"), # ADLS account name\n",
+    "tenant_id=os.getenv(\"ADL_TENANT_62\", \"<my-tenant-id>\") # tenant id of service principal\n",
+    "client_id=os.getenv(\"ADL_CLIENTID_62\", \"<my-client-id>\") # client id of service principal\n",
+    "client_secret=os.getenv(\"ADL_CLIENT_SECRET_62\", \"<my-client-secret>\") # the secret of service principal\n",
+    "\n",
+    "try:\n",
+    "    adls_datastore = Datastore.get(ws, datastore_name)\n",
+    "    print(\"found datastore with name: %s\" % datastore_name)\n",
+    "except:\n",
+    "    adls_datastore = Datastore.register_azure_data_lake(\n",
+    "        workspace=ws,\n",
+    "        datastore_name=datastore_name,\n",
+    "        subscription_id=subscription_id, # subscription id of ADLS account\n",
+    "        resource_group=resource_group, # resource group of ADLS account\n",
+    "        store_name=store_name, # ADLS account name\n",
+    "        tenant_id=tenant_id, # tenant id of service principal\n",
+    "        client_id=client_id, # client id of service principal\n",
+    "        client_secret=client_secret) # the secret of service principal\n",
+    "    print(\"registered datastore with name: %s\" % datastore_name)\n",
+    "\n",
+    "\n",
+    "\n",
+    "blob_datastore_name='MyBlobDatastore'\n",
+    "account_name=os.getenv(\"BLOB_ACCOUNTNAME_62\", \"<my-account-name>\") # Storage account name\n",
+    "container_name=os.getenv(\"BLOB_CONTAINER_62\", \"<my-container-name>\") # Name of Azure blob container\n",
+    "account_key=os.getenv(\"BLOB_ACCOUNT_KEY_62\", \"<my-account-key>\") # Storage account key\n",
+    "\n",
+    "try:\n",
+    "    blob_datastore = Datastore.get(ws, blob_datastore_name)\n",
+    "    print(\"found blob datastore with name: %s\" % blob_datastore_name)\n",
+    "except:\n",
+    "    blob_datastore = Datastore.register_azure_blob_container(\n",
+    "        workspace=ws,\n",
+    "        datastore_name=blob_datastore_name,\n",
+    "        account_name=account_name, # Storage account name\n",
+    "        container_name=container_name, # Name of Azure blob container\n",
+    "        account_key=account_key) # Storage account key\"\n",
+    "    print(\"registered blob datastore with name: %s\" % blob_datastore_name)\n",
+    "\n",
+    "# CLI:\n",
+    "# az ml datastore register-blob -n <datastore-name> -a <account-name> -c <container-name> -k <account-key> [-t <sas-token>]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create DataReferences"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "adls_datastore = Datastore(workspace=ws, name=\"MyAdlsDatastore\")\n",
+    "\n",
+    "# adls\n",
+    "adls_data_ref = DataReference(\n",
+    "    datastore=adls_datastore,\n",
+    "    data_reference_name=\"adls_test_data\",\n",
+    "    path_on_datastore=\"testdata\")\n",
+    "\n",
+    "blob_datastore = Datastore(workspace=ws, name=\"MyBlobDatastore\")\n",
+    "\n",
+    "# blob data\n",
+    "blob_data_ref = DataReference(\n",
+    "    datastore=blob_datastore,\n",
+    "    data_reference_name=\"blob_test_data\",\n",
+    "    path_on_datastore=\"testdata\")\n",
+    "\n",
+    "print(\"obtained adls, blob data references\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Setup Data Factory Account"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "data_factory_name = 'adftest'\n",
+    "\n",
+    "def get_or_create_data_factory(workspace, factory_name):\n",
+    "    try:\n",
+    "        return DataFactoryCompute(workspace, factory_name)\n",
+    "    except ComputeTargetException as e:\n",
+    "        if 'ComputeTargetNotFound' in e.message:\n",
+    "            print('Data factory not found, creating...')\n",
+    "            provisioning_config = DataFactoryCompute.provisioning_configuration()\n",
+    "            data_factory = ComputeTarget.create(workspace, factory_name, provisioning_config)\n",
+    "            data_factory.wait_for_provisioning()\n",
+    "            return data_factory\n",
+    "        else:\n",
+    "            raise e\n",
+    "            \n",
+    "data_factory_compute = get_or_create_data_factory(ws, data_factory_name)\n",
+    "\n",
+    "print(\"setup data factory account complete\")\n",
+    "\n",
+    "# CLI:\n",
+    "# Create: az ml computetarget setup datafactory -n <name>\n",
+    "# BYOC: az ml computetarget attach datafactory -n <name> -i <resource-id>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create a DataTransferStep"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**DataTransferStep** is used to transfer data between Azure Blob, Azure Data Lake Store, and Azure SQL database.\n",
+    "\n",
+    "- **name:** Name of module\n",
+    "- **source_data_reference:** Input connection that serves as source of data transfer operation.\n",
+    "- **destination_data_reference:** Input connection that serves as destination of data transfer operation.\n",
+    "- **compute_target:** Azure Data Factory to use for transferring data.\n",
+    "- **allow_reuse:** Whether the step should reuse results of previous DataTransferStep when run with same inputs. Set as False to force data to be transferred again.\n",
+    "\n",
+    "Optional arguments to explicitly specify whether a path corresponds to a file or a directory. These are useful when storage contains both file and directory with the same name or when creating a new destination path.\n",
+    "\n",
+    "- **source_reference_type:** An optional string specifying the type of source_data_reference. Possible values include: 'file', 'directory'. When not specified, we use the type of existing path or directory if it's a new path.\n",
+    "- **destination_reference_type:** An optional string specifying the type of destination_data_reference. Possible values include: 'file', 'directory'. When not specified, we use the type of existing path or directory if it's a new path."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "transfer_adls_to_blob = DataTransferStep(\n",
+    "    name=\"transfer_adls_to_blob\",\n",
+    "    source_data_reference=adls_data_ref,\n",
+    "    destination_data_reference=blob_data_ref,\n",
+    "    compute_target=data_factory_compute)\n",
+    "\n",
+    "print(\"data transfer step created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Build and Submit the Experiment"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline = Pipeline(\n",
+    "    description=\"data_transfer_101\",\n",
+    "    workspace=ws,\n",
+    "    steps=[transfer_adls_to_blob])\n",
+    "\n",
+    "pipeline_run = Experiment(ws, \"Data_Transfer_example\").submit(pipeline)\n",
+    "pipeline_run.wait_for_completion()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### View Run Details"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Next: Databricks as a Compute Target\n",
+    "To use Databricks as a compute target from Azure Machine Learning Pipeline, a DatabricksStep is used. This [notebook](./aml-pipelines-use-databricks-as-compute-target.ipynb) demonstrates the use of a DatabricksStep in an Azure Machine Learning Pipeline."
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "diray"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-getting-started.ipynb

@@ -0,0 +1,606 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Azure Machine Learning Pipelines: Getting Started\n",
+    "\n",
+    "## Overview\n",
+    "\n",
+    "Read [Azure Machine Learning Pipelines](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-ml-pipelines) overview, or the [readme article](../README.md) on Azure Machine Learning Pipelines to get more information.\n",
+    " \n",
+    "\n",
+    "This Notebook shows basic construction of a **pipeline** that runs jobs unattended in different compute clusters. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prerequisites and Azure Machine Learning Basics\n",
+    "Make sure you go through the configuration Notebook located at https://github.com/Azure/MachineLearningNotebooks first if you haven't. This sets you up with a working config file that has information on your workspace, subscription id, etc. \n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Azure Machine Learning Imports\n",
+    "\n",
+    "In this first code cell, we import key Azure Machine Learning modules that we will use below. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "from azureml.core import Workspace, Run, Experiment, Datastore\n",
+    "from azureml.core.compute import AmlCompute\n",
+    "from azureml.core.compute import ComputeTarget\n",
+    "from azureml.core.compute import DataFactoryCompute\n",
+    "from azureml.widgets import RunDetails\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Pipeline-specific SDK imports\n",
+    "\n",
+    "Here, we import key pipeline modules, whose use will be illustrated in the examples below."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.data.data_reference import DataReference\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData, StepSequence\n",
+    "from azureml.pipeline.steps import PythonScriptStep\n",
+    "from azureml.pipeline.steps import DataTransferStep\n",
+    "from azureml.pipeline.core import PublishedPipeline\n",
+    "from azureml.pipeline.core.graph import PipelineParameter\n",
+    "\n",
+    "print(\"Pipeline SDK-specific imports completed\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Initialize Workspace\n",
+    "\n",
+    "Initialize a [workspace](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.workspace(class%29) object from persisted configuration."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "create workspace"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')\n",
+    "\n",
+    "# Default datastore (Azure file storage)\n",
+    "def_file_store = ws.get_default_datastore() \n",
+    "# The above call is equivalent to Datastore(ws, \"workspacefilestore\") or simply Datastore(ws)\n",
+    "print(\"Default datastore's name: {}\".format(def_file_store.name))\n",
+    "\n",
+    "# Blob storage associated with the workspace\n",
+    "# The following call GETS the Azure Blob Store associated with your workspace.\n",
+    "# Note that workspaceblobstore is **the name of this store and CANNOT BE CHANGED and must be used as is** \n",
+    "def_blob_store = Datastore(ws, \"workspaceblobstore\")\n",
+    "print(\"Blobstore's name: {}\".format(def_blob_store.name))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# project folder\n",
+    "project_folder = '.'\n",
+    "    \n",
+    "print('Sample projects will be created in {}.'.format(project_folder))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Required data and script files for the the tutorial\n",
+    "Sample files required to finish this tutorial are already copied to the project folder specified above. Even though the .py provided in the samples don't have much \"ML work,\" as a data scientist, you will work on this extensively as part of your work. To complete this tutorial, the contents of these files are not very important. The one-line files are for demostration purpose only."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Datastore concepts\n",
+    "A [Datastore](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.datastore(class) is a place where data can be stored that is then made accessible to a compute either by means of mounting or copying the data to the compute target. \n",
+    "\n",
+    "A Datastore can either be backed by an Azure File Storage (default) or by an Azure Blob Storage.\n",
+    "\n",
+    "In this next step, we will upload the training and test set into the workspace's default storage (File storage), and another piece of data to Azure Blob Storage. When to use [Azure Blobs](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction), [Azure Files](https://docs.microsoft.com/en-us/azure/storage/files/storage-files-introduction), or [Azure Disks](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/managed-disks-overview) is [detailed here](https://docs.microsoft.com/en-us/azure/storage/common/storage-decide-blobs-files-disks).\n",
+    "\n",
+    "**Please take good note of the concept of the datastore.**"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Upload data to default datastore\n",
+    "Default datastore on workspace is the Azure  File storage. The workspace has a Blob storage associated with it as well. Let's upload a file to each of these storages."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# get_default_datastore() gets the default Azure File Store associated with your workspace.\n",
+    "# Here we are reusing the def_file_store object we obtained earlier\n",
+    "\n",
+    "# target_path is the directory at the destination\n",
+    "def_file_store.upload_files(['./20news.pkl'], \n",
+    "                                  target_path = '20newsgroups', \n",
+    "                                  overwrite = True, \n",
+    "                                  show_progress = True)\n",
+    "\n",
+    "# Here we are reusing the def_blob_store we created earlier\n",
+    "def_blob_store.upload_files([\"./20news.pkl\"], target_path=\"20newsgroups\", overwrite=True)\n",
+    "\n",
+    "print(\"Upload calls completed\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### (Optional) See your files using Azure Portal\n",
+    "Once you successfully uploaded the files, you can browse to them (or upload more files) using [Azure Portal](https://portal.azure.com). At the portal, make sure you have selected **AzureML Nursery** as your subscription (click *Resource Groups* and then select the subscription). Then look for your **Machine Learning Workspace** (it has your *alias* as the name). It has a link to your storage. Click on the storage link. It will take you to a page where you can see [Blobs](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction), [Files](https://docs.microsoft.com/en-us/azure/storage/files/storage-files-introduction), [Tables](https://docs.microsoft.com/en-us/azure/storage/tables/table-storage-overview), and [Queues](https://docs.microsoft.com/en-us/azure/storage/queues/storage-queues-introduction). We have just uploaded a file to the Blob storage and another one to the File storage. You should be able to see both of these files in their respective locations. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Compute Targets\n",
+    "A compute target specifies where to execute your program such as a remote Docker on a VM, or a cluster. A compute target needs to be addressable and accessible by you.\n",
+    "\n",
+    "**You need at least one compute target to send your payload to. We are planning to use Azure Machine Learning Compute exclusively for this tutorial for all steps. However in some cases you may require multiple compute targets as some steps may run in one compute target like Azure Machine Learning Compute, and some other steps in the same pipeline could run in a different compute target.**\n",
+    "\n",
+    "*The example belows show creating/retrieving/attaching to an Azure Machine Learning Compute instance.*"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### List of Compute Targets on the workspace"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cts = ws.compute_targets\n",
+    "for ct in cts:\n",
+    "    print(ct)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Retrieve or create a Azure Machine Learning compute\n",
+    "Azure Machine Learning Compute is a service for provisioning and managing clusters of Azure virtual machines for running machine learning workloads. Let's create a new Azure Machine Learning Compute in the current workspace, if it doesn't already exist. We will then run the training script on this compute target.\n",
+    "\n",
+    "If we could not find the compute with the given name in the previous cell, then we will create a new compute here. We will create an Azure Machine Learning Compute containing **STANDARD_D2_V2 CPU VMs**. This process is broken down into the following steps:\n",
+    "\n",
+    "1. Create the configuration\n",
+    "2. Create the Azure Machine Learning compute\n",
+    "\n",
+    "**This process will take about 3 minutes and is providing only sparse output in the process. Please make sure to wait until the call returns before moving to the next cell.**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "aml_compute_target = \"aml-compute\"\n",
+    "try:\n",
+    "    aml_compute = AmlCompute(ws, aml_compute_target)\n",
+    "    print(\"found existing compute target.\")\n",
+    "except:\n",
+    "    print(\"creating new compute target\")\n",
+    "    \n",
+    "    provisioning_config = AmlCompute.provisioning_configuration(vm_size = \"STANDARD_D2_V2\",\n",
+    "                                                                min_nodes = 1, \n",
+    "                                                                max_nodes = 4)    \n",
+    "    aml_compute = ComputeTarget.create(ws, aml_compute_target, provisioning_config)\n",
+    "    aml_compute.wait_for_completion(show_output=True, min_node_count=None, timeout_in_minutes=20)\n",
+    "    \n",
+    "print(\"Azure Machine Learning Compute attached\")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# For a more detailed view of current Azure Machine Learning Compute status, use the 'status' property\n",
+    "# example: un-comment the following line.\n",
+    "# print(aml_compute.status.serialize())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Wait for this call to finish before proceeding (you will see the asterisk turning to a number).**\n",
+    "\n",
+    "Now that you have created the compute target, let's see what the workspace's compute_targets() function returns. You should now see one entry named 'amlcompute' of type AmlCompute."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Now that we have completed learning the basics of Azure Machine Learning (AML), let's go ahead and start understanding the Pipeline concepts.**"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Creating a Step in a Pipeline\n",
+    "A Step is a unit of execution. Step typically needs a target of execution (compute target), a script to execute, and may require script arguments and inputs, and can produce outputs. The step also could take a number of other parameters. Azure Machine Learning Pipelines provides the following built-in Steps:\n",
+    "\n",
+    "- [**PythonScriptStep**](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-steps/azureml.pipeline.steps.python_script_step.pythonscriptstep?view=azure-ml-py): Add a step to run a Python script in a Pipeline.\n",
+    "- [**AdlaStep**](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-steps/azureml.pipeline.steps.adla_step.adlastep?view=azure-ml-py): Adds a step to run U-SQL script using Azure Data Lake Analytics.\n",
+    "- [**DataTransferStep**](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-steps/azureml.pipeline.steps.data_transfer_step.datatransferstep?view=azure-ml-py): Transfers data between Azure Blob and Data Lake accounts.\n",
+    "- [**DatabricksStep**](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-steps/azureml.pipeline.steps.databricks_step.databricksstep?view=azure-ml-py): Adds a DataBricks notebook as a step in a Pipeline.\n",
+    "- [**HyperDriveStep**](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-steps/azureml.pipeline.steps.hyper_drive_step.hyperdrivestep?view=azure-ml-py): Creates a Hyper Drive step for Hyper Parameter Tuning in a Pipeline.\n",
+    "\n",
+    "The following code will create a PythonScriptStep to be executed in the Azure Machine Learning Compute we created above using train.py, one of the files already made available in the project folder.\n",
+    "\n",
+    "A **PythonScriptStep** is a basic, built-in step to run a Python Script on a compute target. It takes a script name and optionally other parameters like arguments for the script, compute target, inputs and outputs. If no compute target is specified, default compute target for the workspace is used."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Uses default values for PythonScriptStep construct.\n",
+    "\n",
+    "# Syntax\n",
+    "# PythonScriptStep(\n",
+    "#     script_name, \n",
+    "#     name=None, \n",
+    "#     arguments=None, \n",
+    "#     compute_target=None, \n",
+    "#     runconfig=None, \n",
+    "#     inputs=None, \n",
+    "#     outputs=None, \n",
+    "#     params=None, \n",
+    "#     source_directory=None, \n",
+    "#     allow_reuse=True, \n",
+    "#     version=None, \n",
+    "#     hash_paths=None)\n",
+    "# This returns a Step\n",
+    "step1 = PythonScriptStep(name=\"train_step\",\n",
+    "                         script_name=\"train.py\", \n",
+    "                         compute_target=aml_compute, \n",
+    "                         source_directory=project_folder,\n",
+    "                         allow_reuse=False)\n",
+    "print(\"Step1 created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Note:** In the above call to PythonScriptStep(), the flag *allow_reuse* determines whether the step should reuse previous results when run with the same settings/inputs. This flag's default value is *True*; the default is set to *True* because, when inputs and parameters have not changed, we typically do not want to re-run a given pipeline step. \n",
+    "\n",
+    "If *allow_reuse* is set to *False*, a new run will always be generated for this step during pipeline execution. The *allow_reuse* flag can come in handy in situations where you do *not* want to re-run a pipeline step."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Running a few steps in parallel\n",
+    "Here we are looking at a simple scenario where we are running a few steps (all involving PythonScriptStep)  in parallel. Running nodes in **parallel** is the default behavior for steps in a pipeline.\n",
+    "\n",
+    "We already have one step defined earlier. Let's define few more steps."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# All steps use files already available in the project_folder\n",
+    "# All steps use the same Azure Machine Learning compute target as well\n",
+    "step2 = PythonScriptStep(name=\"compare_step\",\n",
+    "                         script_name=\"compare.py\", \n",
+    "                         compute_target=aml_compute, \n",
+    "                         source_directory=project_folder)\n",
+    "\n",
+    "step3 = PythonScriptStep(name=\"extract_step\",\n",
+    "                         script_name=\"extract.py\", \n",
+    "                         compute_target=aml_compute, \n",
+    "                         source_directory=project_folder)\n",
+    "\n",
+    "# list of steps to run\n",
+    "steps = [step1, step2, step3]\n",
+    "print(\"Step lists created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Build the pipeline\n",
+    "Once we have the steps (or steps collection), we can build the [pipeline](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipeline.pipeline?view=azure-ml-py). By deafult, all these steps will run in **parallel** once we submit the pipeline for run.\n",
+    "\n",
+    "A pipeline is created with a list of steps and a workspace. Submit a pipeline using [submit](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.experiment%28class%29?view=azure-ml-py#submit). When submit is called, a [PipelineRun](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipelinerun?view=azure-ml-py) is created which in turn creates [StepRun](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.steprun?view=azure-ml-py) objects for each step in the workflow."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Syntax\n",
+    "# Pipeline(workspace, \n",
+    "#          steps, \n",
+    "#          description=None, \n",
+    "#          default_datastore_name=None, \n",
+    "#          default_source_directory=None, \n",
+    "#          resolve_closure=True, \n",
+    "#          _workflow_provider=None, \n",
+    "#          _service_endpoint=None)\n",
+    "\n",
+    "pipeline1 = Pipeline(workspace=ws, steps=steps)\n",
+    "print (\"Pipeline is built\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Validate the pipeline\n",
+    "You have the option to [validate](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipeline.pipeline?view=azure-ml-py#validate) the pipeline prior to submitting for run. The platform runs validation steps such as checking for circular dependencies and parameter checks etc. even if you do not explicitly call validate method."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline1.validate()\n",
+    "print(\"Pipeline validation complete\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Submit the pipeline\n",
+    "[Submitting](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipeline.pipeline?view=azure-ml-py#submit) the pipeline involves creating an [Experiment](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.experiment?view=azure-ml-py) object and providing the built pipeline for submission. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Submit syntax\n",
+    "# submit(experiment_name, \n",
+    "#        pipeline_parameters=None, \n",
+    "#        continue_on_node_failure=False, \n",
+    "#        regenerate_outputs=False)\n",
+    "\n",
+    "pipeline_run1 = Experiment(ws, 'Hello_World1').submit(pipeline1, regenerate_outputs=True)\n",
+    "print(\"Pipeline is submitted for execution\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Note:** If regenerate_outputs is set to True, a new submit will always force generation of all step outputs, and disallow data reuse for any step of this run. Once this run is complete, however, subsequent runs may reuse the results of this run.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Examine the pipeline run\n",
+    "\n",
+    "#### Use RunDetails Widget\n",
+    "We are going to use the RunDetails widget to examine the run of the pipeline. You can click each row below to get more details on the step runs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "RunDetails(pipeline_run1).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Use Pipeline SDK objects\n",
+    "You can cycle through the node_run objects and examine job logs, stdout, and stderr of each of the steps."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "step_runs = pipeline_run1.get_children()\n",
+    "for step_run in step_runs:\n",
+    "    status = step_run.get_status()\n",
+    "    print('Script:', step_run.name, 'status:', status)\n",
+    "    \n",
+    "    # Change this if you want to see details even if the Step has succeeded.\n",
+    "    if status == \"Failed\":\n",
+    "        joblog = step_run.get_job_log()\n",
+    "        print('job log:', joblog)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Get additonal run details\n",
+    "If you wait until the pipeline_run is finished, you may be able to get additional details on the run. **Since this is a blocking call, the following code is commented out.**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#pipeline_run1.wait_for_completion()\n",
+    "#for step_run in pipeline_run1.get_children():\n",
+    "#    print(\"{}: {}\".format(step_run.name, step_run.get_metrics()))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Running a few steps in sequence\n",
+    "Now let's see how we run a few steps in sequence. We already have three steps defined earlier. Let's *reuse* those steps for this part.\n",
+    "\n",
+    "We will reuse step1, step2, step3, but build the pipeline in such a way that we chain step3 after step2 and step2 after step1. Note that there is no explicit data dependency between these steps, but still steps can be made dependent by using the [run_after](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.builder.pipelinestep?view=azure-ml-py#run-after) construct."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "step2.run_after(step1)\n",
+    "step3.run_after(step2)\n",
+    "\n",
+    "# Try a loop\n",
+    "#step2.run_after(step3)\n",
+    "\n",
+    "# Now, construct the pipeline using the steps.\n",
+    "\n",
+    "# We can specify the \"final step\" in the chain, \n",
+    "# Pipeline will take care of \"transitive closure\" and \n",
+    "# figure out the implicit or explicit dependencies\n",
+    "# https://www.geeksforgeeks.org/transitive-closure-of-a-graph/\n",
+    "pipeline2 = Pipeline(workspace=ws, steps=[step3])\n",
+    "print (\"Pipeline is built\")\n",
+    "\n",
+    "pipeline2.validate()\n",
+    "print(\"Simple validation complete\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline_run2 = Experiment(ws, 'Hello_World2').submit(pipeline2)\n",
+    "print(\"Pipeline is submitted for execution\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "RunDetails(pipeline_run2).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Next: Pipelines with data dependency\n",
+    "The next [notebook](./aml-pipelines-with-data-dependency-steps.ipynb) demostrates how to construct a pipeline with data dependency."
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "diray"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-publish-and-run-using-rest-endpoint.ipynb

@@ -0,0 +1,368 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# How to Publish a Pipeline and Invoke the REST endpoint\n",
+    "In this notebook, we will see how we can publish a pipeline and then invoke the REST endpoint."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prerequisites and Azure Machine Learning Basics\n",
+    "Make sure you go through the configuration Notebook located at https://github.com/Azure/MachineLearningNotebooks first if you haven't. This sets you up with a working config file that has information on your workspace, subscription id, etc. \n",
+    "\n",
+    "### Initialization Steps"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "from azureml.core import Workspace, Run, Experiment, Datastore\n",
+    "from azureml.core.compute import AmlCompute\n",
+    "from azureml.core.compute import ComputeTarget\n",
+    "from azureml.core.compute import DataFactoryCompute\n",
+    "from azureml.widgets import RunDetails\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)\n",
+    "\n",
+    "from azureml.data.data_reference import DataReference\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData, StepSequence\n",
+    "from azureml.pipeline.steps import PythonScriptStep\n",
+    "from azureml.pipeline.steps import DataTransferStep\n",
+    "from azureml.pipeline.core import PublishedPipeline\n",
+    "from azureml.pipeline.core.graph import PipelineParameter\n",
+    "\n",
+    "print(\"Pipeline SDK-specific imports completed\")\n",
+    "\n",
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')\n",
+    "\n",
+    "# Default datastore (Azure file storage)\n",
+    "def_file_store = ws.get_default_datastore() \n",
+    "print(\"Default datastore's name: {}\".format(def_file_store.name))\n",
+    "\n",
+    "def_blob_store = Datastore(ws, \"workspaceblobstore\")\n",
+    "print(\"Blobstore's name: {}\".format(def_blob_store.name))\n",
+    "\n",
+    "# project folder\n",
+    "project_folder = '.'"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Compute Targets\n",
+    "#### Retrieve an already attached  Azure Machine Learning Compute"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "aml_compute_target = \"aml-compute\"\n",
+    "try:\n",
+    "    aml_compute = AmlCompute(ws, aml_compute_target)\n",
+    "    print(\"found existing compute target.\")\n",
+    "except:\n",
+    "    print(\"creating new compute target\")\n",
+    "    \n",
+    "    provisioning_config = AmlCompute.provisioning_configuration(vm_size = \"STANDARD_D2_V2\",\n",
+    "                                                                min_nodes = 1, \n",
+    "                                                                max_nodes = 4)    \n",
+    "    aml_compute = ComputeTarget.create(ws, aml_compute_target, provisioning_config)\n",
+    "    aml_compute.wait_for_completion(show_output=True, min_node_count=None, timeout_in_minutes=20)\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# For a more detailed view of current Azure Machine Learning Compute status, use the 'status' property\n",
+    "# example: un-comment the following line.\n",
+    "# print(aml_compute.status.serialize())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Building Pipeline Steps with Inputs and Outputs\n",
+    "As mentioned earlier, a step in the pipeline can take data as input. This data can be a data source that lives in one of the accessible data locations, or intermediate data produced by a previous step in the pipeline."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Reference the data uploaded to blob storage using DataReference\n",
+    "# Assign the datasource to blob_input_data variable\n",
+    "blob_input_data = DataReference(\n",
+    "    datastore=def_blob_store,\n",
+    "    data_reference_name=\"test_data\",\n",
+    "    path_on_datastore=\"20newsgroups/20news.pkl\")\n",
+    "print(\"DataReference object created\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Define intermediate data using PipelineData\n",
+    "processed_data1 = PipelineData(\"processed_data1\",datastore=def_blob_store)\n",
+    "print(\"PipelineData object created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Define a Step that consumes a datasource and produces intermediate data.\n",
+    "In this step, we define a step that consumes a datasource and produces intermediate data.\n",
+    "\n",
+    "**Open `train.py` in the local machine and examine the arguments, inputs, and outputs for the script. That will give you a good sense of why the script argument names used below are important.** "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# trainStep consumes the datasource (Datareference) in the previous step\n",
+    "# and produces processed_data1\n",
+    "trainStep = PythonScriptStep(\n",
+    "    script_name=\"train.py\", \n",
+    "        arguments=[\"--input_data\", blob_input_data, \"--output_train\", processed_data1],\n",
+    "    inputs=[blob_input_data],\n",
+    "    outputs=[processed_data1],\n",
+    "    compute_target=aml_compute, \n",
+    "    source_directory=project_folder\n",
+    ")\n",
+    "print(\"trainStep created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Define a Step that consumes intermediate data and produces intermediate data\n",
+    "In this step, we define a step that consumes an intermediate data and produces intermediate data.\n",
+    "\n",
+    "**Open `extract.py` in the local machine and examine the arguments, inputs, and outputs for the script. That will give you a good sense of why the script argument names used below are important.** "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# extractStep to use the intermediate data produced by step4\n",
+    "# This step also produces an output processed_data2\n",
+    "processed_data2 = PipelineData(\"processed_data2\", datastore=def_blob_store)\n",
+    "\n",
+    "extractStep = PythonScriptStep(\n",
+    "    script_name=\"extract.py\",\n",
+    "    arguments=[\"--input_extract\", processed_data1, \"--output_extract\", processed_data2],\n",
+    "    inputs=[processed_data1],\n",
+    "    outputs=[processed_data2],\n",
+    "    compute_target=aml_compute, \n",
+    "    source_directory=project_folder)\n",
+    "print(\"extractStep created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Define a Step that consumes multiple intermediate data and produces intermediate data\n",
+    "In this step, we define a step that consumes multiple intermediate data and produces intermediate data."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### PipelineParameter"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This step also has a [PipelineParameter](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.graph.pipelineparameter?view=azure-ml-py) argument that help with calling the REST endpoint of the published pipeline."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# We will use this later in publishing pipeline\n",
+    "pipeline_param = PipelineParameter(name=\"pipeline_arg\", default_value=10)\n",
+    "print(\"pipeline parameter created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Open `compare.py` in the local machine and examine the arguments, inputs, and outputs for the script. That will give you a good sense of why the script argument names used below are important.**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Now define step6 that takes two inputs (both intermediate data), and produce an output\n",
+    "processed_data3 = PipelineData(\"processed_data3\", datastore=def_blob_store)\n",
+    "\n",
+    "\n",
+    "\n",
+    "compareStep = PythonScriptStep(\n",
+    "    script_name=\"compare.py\",\n",
+    "    arguments=[\"--compare_data1\", processed_data1, \"--compare_data2\", processed_data2, \"--output_compare\", processed_data3, \"--pipeline_param\", pipeline_param],\n",
+    "    inputs=[processed_data1, processed_data2],\n",
+    "    outputs=[processed_data3],    \n",
+    "    compute_target=aml_compute, \n",
+    "    source_directory=project_folder)\n",
+    "print(\"compareStep created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Build the pipeline"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline1 = Pipeline(workspace=ws, steps=[compareStep])\n",
+    "print (\"Pipeline is built\")\n",
+    "\n",
+    "pipeline1.validate()\n",
+    "print(\"Simple validation complete\") "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Publish the pipeline"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "published_pipeline1 = pipeline1.publish(name=\"My_New_Pipeline\", description=\"My Published Pipeline Description\")\n",
+    "print(published_pipeline1.id)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run published pipeline using its REST endpoint"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.authentication import AzureCliAuthentication\n",
+    "import requests\n",
+    "\n",
+    "cli_auth = AzureCliAuthentication()\n",
+    "aad_token = cli_auth.get_authentication_header()\n",
+    "\n",
+    "rest_endpoint1 = published_pipeline1.endpoint\n",
+    "\n",
+    "print(rest_endpoint1)\n",
+    "\n",
+    "# specify the param when running the pipeline\n",
+    "response = requests.post(rest_endpoint1, \n",
+    "                         headers=aad_token, \n",
+    "                         json={\"ExperimentName\": \"My_Pipeline1\",\n",
+    "                               \"RunSource\": \"SDK\",\n",
+    "                               \"ParameterAssignments\": {\"pipeline_arg\": 45}})\n",
+    "run_id = response.json()[\"Id\"]\n",
+    "\n",
+    "print(run_id)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Next: Data Transfer\n",
+    "The next [notebook](./aml-pipelines-data-transfer.ipynb) will showcase data transfer steps between different types of data stores."
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "diray"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-use-adla-as-compute-target.ipynb

@@ -0,0 +1,370 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# AML Pipeline with AdlaStep\n",
+    "This notebook is used to demonstrate the use of AdlaStep in AML Pipeline."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## AML and Pipeline SDK-specific imports"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "import azureml.core\n",
+    "from azureml.core.compute import ComputeTarget, DatabricksCompute\n",
+    "from azureml.exceptions import ComputeTargetException\n",
+    "from azureml.core import Workspace, Run, Experiment\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData\n",
+    "from azureml.pipeline.steps import AdlaStep\n",
+    "from azureml.core.datastore import Datastore\n",
+    "from azureml.data.data_reference import DataReference\n",
+    "from azureml.core import attach_legacy_compute_target\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize Workspace\n",
+    "\n",
+    "Initialize a workspace object from persisted configuration. Make sure the config file is present at .\\config.json"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "create workspace"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "script_folder = '.'\n",
+    "experiment_name = \"adla_101_experiment\"\n",
+    "ws._initialize_folder(experiment_name=experiment_name, directory=script_folder)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Register Datastore"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "workspace = ws.name\n",
+    "datastore_name='MyAdlsDatastore'\n",
+    "subscription_id=os.getenv(\"ADL_SUBSCRIPTION_62\" \"<my-subscription-id>\"), # subscription id of ADLS account\n",
+    "resource_group=os.getenv(\"ADL_RESOURCE_GROUP_62\" \"<my-resource-group>\"), # resource group of ADLS account\n",
+    "store_name=os.getenv(\"ADL_STORENAME_62\", \"<my-datastore-name>\"), # ADLS account name\n",
+    "tenant_id=os.getenv(\"ADL_TENANT_62\", \"<my-tenant-id>\") # tenant id of service principal\n",
+    "client_id=os.getenv(\"ADL_CLIENTID_62\", \"<my-client-id>\") # client id of service principal\n",
+    "client_secret=os.getenv(\"ADL_CLIENT_62_SECRET\", \"<my-client-secret>\") # the secret of service principal\n",
+    "\n",
+    "try:\n",
+    "    adls_datastore = Datastore.get(ws, datastore_name)\n",
+    "    print(\"found datastore with name: %s\" % datastore_name)\n",
+    "except:\n",
+    "    adls_datastore = Datastore.register_azure_data_lake(\n",
+    "        workspace=ws,\n",
+    "        datastore_name=datastore_name,\n",
+    "        subscription_id=subscription_id, # subscription id of ADLS account\n",
+    "        resource_group=resource_group, # resource group of ADLS account\n",
+    "        store_name=store_name, # ADLS account name\n",
+    "        tenant_id=tenant_id, # tenant id of service principal\n",
+    "        client_id=client_id, # client id of service principal\n",
+    "        client_secret=client_secret) # the secret of service principal\n",
+    "    print(\"registered datastore with name: %s\" % datastore_name)\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create DataReferences and PipelineData\n",
+    "\n",
+    "In the code cell below, replace datastorename with your default datastore name. Copy the file `testdata.txt` (located in the pipeline folder that this notebook is in) to the path on the datastore."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "datastorename = \"MyAdlsDatastore\"\n",
+    "\n",
+    "adls_datastore = Datastore(workspace=ws, name=datastorename)\n",
+    "script_input = DataReference(\n",
+    "    datastore=adls_datastore,\n",
+    "    data_reference_name=\"script_input\",\n",
+    "    path_on_datastore=\"testdata/testdata.txt\")\n",
+    "\n",
+    "script_output = PipelineData(\"script_output\", datastore=adls_datastore)\n",
+    "\n",
+    "print(\"Created Pipeline Data\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Setup Data Lake Account\n",
+    "\n",
+    "ADLA can only use data that is located in the default data store associated with that ADLA account. Through Azure portal, check the name of the default data store corresponding to the ADLA account you are using below. Replace the value associated with `adla_compute_name` in the code cell below accordingly."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "adla_compute_name = 'testadl' # Replace this with your default compute\n",
+    "\n",
+    "from azureml.core.compute import ComputeTarget, AdlaCompute\n",
+    "\n",
+    "def get_or_create_adla_compute(workspace, compute_name):\n",
+    "    try:\n",
+    "        return AdlaCompute(workspace, compute_name)\n",
+    "    except ComputeTargetException as e:\n",
+    "        if 'ComputeTargetNotFound' in e.message:\n",
+    "            print('adla compute not found, creating...')\n",
+    "            provisioning_config = AdlaCompute.provisioning_configuration()\n",
+    "            adla_compute = ComputeTarget.create(workspace, compute_name, provisioning_config)\n",
+    "            adla_compute.wait_for_completion()\n",
+    "            return adla_compute\n",
+    "        else:\n",
+    "            raise e\n",
+    "            \n",
+    "adla_compute = get_or_create_adla_compute(ws, adla_compute_name)\n",
+    "\n",
+    "# CLI:\n",
+    "# Create: az ml computetarget setup adla -n <name>\n",
+    "# BYOC: az ml computetarget attach adla -n <name> -i <resource-id>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Once the above code cell completes, run the below to check your ADLA compute status:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(\"ADLA compute state:{}\".format(adla_compute.provisioning_state))\n",
+    "print(\"ADLA compute state:{}\".format(adla_compute.provisioning_errors))\n",
+    "print(\"Using ADLA compute:{}\".format(adla_compute.cluster_resource_id))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Create an AdlaStep"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**AdlaStep** is used to run U-SQL script using Azure Data Lake Analytics.\n",
+    "\n",
+    "- **name:** Name of module\n",
+    "- **script_name:** name of U-SQL script\n",
+    "- **inputs:** List of input port bindings\n",
+    "- **outputs:** List of output port bindings\n",
+    "- **adla_compute:** the ADLA compute to use for this job\n",
+    "- **params:** Dictionary of name-value pairs to pass to U-SQL job *(optional)*\n",
+    "- **degree_of_parallelism:** the degree of parallelism to use for this job *(optional)*\n",
+    "- **priority:** the priority value to use for the current job *(optional)*\n",
+    "- **runtime_version:** the runtime version of the Data Lake Analytics engine *(optional)*\n",
+    "- **root_folder:** folder that contains the script, assemblies etc. *(optional)*\n",
+    "- **hash_paths:** list of paths to hash to detect a change (script file is always hashed) *(optional)*\n",
+    "\n",
+    "### Remarks\n",
+    "\n",
+    "You can use `@@name@@` syntax in your script to refer to inputs, outputs, resources, and params.\n",
+    "\n",
+    "* if `name` is the name of an input or output port binding, any occurences of `@@name@@` in the script\n",
+    "are replaced with actual data path of corresponding port binding.\n",
+    "* if `name` is the name of a resource input port binding, any occurences of `@@name@@` in the script\n",
+    "are replaced with local path of resource after it's downloaded to script directory on a worker node.\n",
+    "* if `name` matches any key in `params` dict, any occurences of `@@name@@` will be replaced with\n",
+    "corresponding value in dict.\n",
+    "\n",
+    "#### Sample script\n",
+    "\n",
+    "```\n",
+    "@resourcereader =\n",
+    "    EXTRACT query string\n",
+    "    FROM \"@@script_input@@\"\n",
+    "    USING Extractors.Csv();\n",
+    "\n",
+    "\n",
+    "OUTPUT @resourcereader\n",
+    "TO \"@@script_output@@\"\n",
+    "USING Outputters.Csv();\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "adla_step = AdlaStep(\n",
+    "    name='adla_script_step',\n",
+    "    script_name='test_adla_script.usql',\n",
+    "    inputs=[script_input],\n",
+    "    outputs=[script_output],\n",
+    "    compute_target=adla_compute)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Build and Submit the Experiment"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline = Pipeline(\n",
+    "    description=\"adla_102\",\n",
+    "    workspace=ws, \n",
+    "    steps=[adla_step],\n",
+    "    default_source_directory=script_folder)\n",
+    "\n",
+    "pipeline_run = Experiment(workspace, experiment_name).submit(pipeline)\n",
+    "pipeline_run.wait_for_completion()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### View Run Details"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Examine the run\n",
+    "You can cycle through the node_run objects and examine job logs, stdout, and stderr of each of the steps."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "step_runs = pipeline_run.get_children()\n",
+    "for step_run in step_runs:\n",
+    "    status = step_run.get_status()\n",
+    "    print('node', step_run.name, 'status:', status)\n",
+    "    if status == \"Failed\":\n",
+    "        joblog = step_run.get_job_log()\n",
+    "        print('job log:', joblog)\n",
+    "        stdout_log = step_run.get_stdout_log()\n",
+    "        print('stdout log:', stdout_log)\n",
+    "        stderr_log = step_run.get_stderr_log()\n",
+    "        print('stderr log:', stderr_log)\n",
+    "        with open(\"logs-\" + step_run.name + \".txt\", \"w\") as f:\n",
+    "            f.write(joblog)\n",
+    "            print(\"Job log written to logs-\"+ step_run.name + \".txt\")\n",
+    "    if status == \"Finished\":\n",
+    "        stdout_log = step_run.get_stdout_log()\n",
+    "        print('stdout log:', stdout_log)"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "diray"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-use-databricks-as-compute-target.ipynb

@@ -0,0 +1,655 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Using Databricks as a Compute Target from Azure Machine Learning Pipeline\n",
+    "To use Databricks as a compute target from [Azure Machine Learning Pipeline](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-ml-pipelines), a [DatabricksStep](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-steps/azureml.pipeline.steps.databricks_step.databricksstep?view=azure-ml-py) is used. This notebook demonstrates the use of DatabricksStep in Azure Machine Learning Pipeline.\n",
+    "\n",
+    "The notebook will show:\n",
+    "1. Running an arbitrary Databricks notebook that the customer has in Databricks workspace\n",
+    "2. Running an arbitrary Python script that the customer has in DBFS\n",
+    "3. Running an arbitrary Python script that is available on local computer (will upload to DBFS, and then run in Databricks) \n",
+    "4. Running a JAR job that the customer has in DBFS.\n",
+    "\n",
+    "## Before you begin:\n",
+    "\n",
+    "1. **Create an Azure Databricks workspace** in the same subscription where you have your Azure Machine Learning workspace. You will need details of this workspace later on to define DatabricksStep. [Click here](https://ms.portal.azure.com/#blade/HubsExtension/Resources/resourceType/Microsoft.Databricks%2Fworkspaces) for more information.\n",
+    "2. **Create PAT (access token)**: Manually create a Databricks access token at the Azure Databricks portal. See [this](https://docs.databricks.com/api/latest/authentication.html#generate-a-token) for more information.\n",
+    "3. **Add demo notebook to ADB**: This notebook has a sample you can use as is. Launch Azure Databricks attached to your Azure Machine Learning workspace and add a new notebook. \n",
+    "4. **Create/attach a Blob storage** for use from ADB"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Add demo notebook to ADB Workspace\n",
+    "Copy and paste the below code to create a new notebook in your ADB workspace."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "```python\n",
+    "# direct access\n",
+    "dbutils.widgets.get(\"myparam\")\n",
+    "p = getArgument(\"myparam\")\n",
+    "print (\"Param -\\'myparam':\")\n",
+    "print (p)\n",
+    "\n",
+    "dbutils.widgets.get(\"input\")\n",
+    "i = getArgument(\"input\")\n",
+    "print (\"Param -\\'input':\")\n",
+    "print (i)\n",
+    "\n",
+    "dbutils.widgets.get(\"output\")\n",
+    "o = getArgument(\"output\")\n",
+    "print (\"Param -\\'output':\")\n",
+    "print (o)\n",
+    "\n",
+    "n = i + \"/testdata.txt\"\n",
+    "df = spark.read.csv(n)\n",
+    "\n",
+    "display (df)\n",
+    "\n",
+    "data = [('value1', 'value2')]\n",
+    "df2 = spark.createDataFrame(data)\n",
+    "\n",
+    "z = o + \"/output.txt\"\n",
+    "df2.write.csv(z)\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Azure Machine Learning and Pipeline SDK-specific imports"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "import azureml.core\n",
+    "from azureml.core.runconfig import JarLibrary\n",
+    "from azureml.core.compute import ComputeTarget, DatabricksCompute\n",
+    "from azureml.exceptions import ComputeTargetException\n",
+    "from azureml.core import Workspace, Run, Experiment\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData\n",
+    "from azureml.pipeline.steps import DatabricksStep\n",
+    "from azureml.core.datastore import Datastore\n",
+    "from azureml.data.data_reference import DataReference\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize Workspace\n",
+    "\n",
+    "Initialize a workspace object from persisted configuration. Make sure the config file is present at .\\config.json"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Attach Databricks compute target\n",
+    "Next, you need to add your Databricks workspace to Azure Machine Learning as a compute target and give it a name. You will use this name to refer to your Databricks workspace compute target inside Azure Machine Learning.\n",
+    "\n",
+    "- **Resource Group** - The resource group name of your Azure Machine Learning workspace\n",
+    "- **Databricks Workspace Name** - The workspace name of your Azure Databricks workspace\n",
+    "- **Databricks Access Token** - The access token you created in ADB"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Replace with your account info before running.\n",
+    " \n",
+    "db_compute_name=os.getenv(\"DATABRICKS_COMPUTE_NAME\", \"<my-databricks-compute-name>\") # Databricks compute name\n",
+    "db_resource_group=os.getenv(\"DATABRICKS_RESOURCE_GROUP\", \"<my-db-resource-group>\") # Databricks resource group\n",
+    "db_workspace_name=os.getenv(\"DATABRICKS_WORKSPACE_NAME\", \"<my-db-workspace-name>\") # Databricks workspace name\n",
+    "db_access_token=os.getenv(\"DATABRICKS_ACCESS_TOKEN\", \"<my-access-token>\") # Databricks access token\n",
+    " \n",
+    "try:\n",
+    "    databricks_compute = ComputeTarget(workspace=ws, name=db_compute_name)\n",
+    "    print('Compute target {} already exists'.format(db_compute_name))\n",
+    "except ComputeTargetException:\n",
+    "    print('Compute not found, will use below parameters to attach new one')\n",
+    "    print('db_compute_name {}'.format(db_compute_name))\n",
+    "    print('db_resource_group {}'.format(db_resource_group))\n",
+    "    print('db_workspace_name {}'.format(db_workspace_name))\n",
+    "    print('db_access_token {}'.format(db_access_token))\n",
+    " \n",
+    "    config = DatabricksCompute.attach_configuration(\n",
+    "        resource_group = db_resource_group,\n",
+    "        workspace_name = db_workspace_name,\n",
+    "        access_token= db_access_token)\n",
+    "    databricks_compute=ComputeTarget.attach(ws, db_compute_name, config)\n",
+    "    databricks_compute.wait_for_completion(True)\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Data Connections with Inputs and Outputs\n",
+    "The DatabricksStep supports Azure Bloband ADLS for inputs and outputs. You also will need to define a [Secrets](https://docs.azuredatabricks.net/user-guide/secrets/index.html) scope to enable authentication to external data sources such as Blob and ADLS from Databricks.\n",
+    "\n",
+    "- Databricks documentation on [Azure Blob](https://docs.azuredatabricks.net/spark/latest/data-sources/azure/azure-storage.html)\n",
+    "- Databricks documentation on [ADLS](https://docs.databricks.com/spark/latest/data-sources/azure/azure-datalake.html)\n",
+    "\n",
+    "### Type of Data Access\n",
+    "Databricks allows to interact with Azure Blob and ADLS in two ways.\n",
+    "- **Direct Access**: Databricks allows you to interact with Azure Blob or ADLS URIs directly. The input or output URIs will be mapped to a Databricks widget param in the Databricks notebook.\n",
+    "- **Mouting**: You will be supplied with additional parameters and secrets that will enable you to mount your ADLS or Azure Blob input or output location in your Databricks notebook."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Direct Access: Python sample code\n",
+    "If you have a data reference named \"input\" it will represent the URI of the input and you can access it directly in the Databricks python notebook like so:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "```python\n",
+    "dbutils.widgets.get(\"input\")\n",
+    "y = getArgument(\"input\")\n",
+    "df = spark.read.csv(y)\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Mounting: Python sample code for Azure Blob\n",
+    "Given an Azure Blob data reference named \"input\" the following widget params will be made available in the Databricks notebook:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "```python\n",
+    "# This contains the input URI\n",
+    "dbutils.widgets.get(\"input\")\n",
+    "myinput_uri = getArgument(\"input\")\n",
+    "\n",
+    "# How to get the input datastore name inside ADB notebook\n",
+    "# This contains the name of a Databricks secret (in the predefined \"amlscope\" secret scope) \n",
+    "# that contians an access key or sas for the Azure Blob input (this name is obtained by appending \n",
+    "# the name of the input with \"_blob_secretname\". \n",
+    "dbutils.widgets.get(\"input_blob_secretname\") \n",
+    "myinput_blob_secretname = getArgument(\"input_blob_secretname\")\n",
+    "\n",
+    "# This contains the required configuration for mounting\n",
+    "dbutils.widgets.get(\"input_blob_config\")\n",
+    "myinput_blob_config = getArgument(\"input_blob_config\")\n",
+    "\n",
+    "# Usage\n",
+    "dbutils.fs.mount(\n",
+    "  source = myinput_uri,\n",
+    "  mount_point = \"/mnt/input\",\n",
+    "  extra_configs = {myinput_blob_config:dbutils.secrets.get(scope = \"amlscope\", key = myinput_blob_secretname)})\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Mounting: Python sample code for ADLS\n",
+    "Given an ADLS data reference named \"input\" the following widget params will be made available in the Databricks notebook:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "```python\n",
+    "# This contains the input URI\n",
+    "dbutils.widgets.get(\"input\") \n",
+    "myinput_uri = getArgument(\"input\")\n",
+    "\n",
+    "# This contains the client id for the service principal \n",
+    "# that has access to the adls input\n",
+    "dbutils.widgets.get(\"input_adls_clientid\") \n",
+    "myinput_adls_clientid = getArgument(\"input_adls_clientid\")\n",
+    "\n",
+    "# This contains the name of a Databricks secret (in the predefined \"amlscope\" secret scope) \n",
+    "# that contains the secret for the above mentioned service principal\n",
+    "dbutils.widgets.get(\"input_adls_secretname\") \n",
+    "myinput_adls_secretname = getArgument(\"input_adls_secretname\")\n",
+    "\n",
+    "# This contains the refresh url for the mounting configs\n",
+    "dbutils.widgets.get(\"input_adls_refresh_url\") \n",
+    "myinput_adls_refresh_url = getArgument(\"input_adls_refresh_url\")\n",
+    "\n",
+    "# Usage \n",
+    "configs = {\"dfs.adls.oauth2.access.token.provider.type\": \"ClientCredential\",\n",
+    "           \"dfs.adls.oauth2.client.id\": myinput_adls_clientid,\n",
+    "           \"dfs.adls.oauth2.credential\": dbutils.secrets.get(scope = \"amlscope\", key =myinput_adls_secretname),\n",
+    "           \"dfs.adls.oauth2.refresh.url\": myinput_adls_refresh_url}\n",
+    "\n",
+    "dbutils.fs.mount(\n",
+    "  source = myinput_uri,\n",
+    "  mount_point = \"/mnt/output\",\n",
+    "  extra_configs = configs)\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Use Databricks from Azure Machine Learning Pipeline\n",
+    "To use Databricks as a compute target from Azure Machine Learning Pipeline, a DatabricksStep is used. Let's define a datasource (via DataReference) and intermediate data (via PipelineData) to be used in DatabricksStep."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Use the default blob storage\n",
+    "def_blob_store = Datastore(ws, \"workspaceblobstore\")\n",
+    "print('Datastore {} will be used'.format(def_blob_store.name))\n",
+    "\n",
+    "# We are uploading a sample file in the local directory to be used as a datasource\n",
+    "def_blob_store.upload_files([\"./testdata.txt\"], target_path=\"dbtest\", overwrite=False)\n",
+    "\n",
+    "step_1_input = DataReference(datastore=def_blob_store, path_on_datastore=\"dbtest\",\n",
+    "                                     data_reference_name=\"input\")\n",
+    "\n",
+    "step_1_output = PipelineData(\"output\", datastore=def_blob_store)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Add a DatabricksStep\n",
+    "Adds a Databricks notebook as a step in a Pipeline.\n",
+    "- ***name:** Name of the Module\n",
+    "- **inputs:** List of input connections for data consumed by this step. Fetch this inside the notebook using dbutils.widgets.get(\"input\")\n",
+    "- **outputs:** List of output port definitions for outputs produced by this step. Fetch this inside the notebook using dbutils.widgets.get(\"output\")\n",
+    "- **spark_version:** Version of spark for the databricks run cluster. default value: 4.0.x-scala2.11\n",
+    "- **node_type:** Azure vm node types for the databricks run cluster. default value: Standard_D3_v2\n",
+    "- **num_workers:** Number of workers for the databricks run cluster\n",
+    "- **autoscale:** The autoscale configuration for the databricks run cluster\n",
+    "- **spark_env_variables:** Spark environment variables for the databricks run cluster (dictionary of {str:str}). default value: {'PYSPARK_PYTHON': '/databricks/python3/bin/python3'}\n",
+    "- ***notebook_path:** Path to the notebook in the databricks instance.\n",
+    "- **notebook_params:** Parameters  for the databricks notebook (dictionary of {str:str}). Fetch this inside the notebook using dbutils.widgets.get(\"myparam\")\n",
+    "- **run_name:** Name in databricks for this run\n",
+    "- **timeout_seconds:** Timeout for the databricks run\n",
+    "- **maven_libraries:** maven libraries for the databricks run\n",
+    "- **pypi_libraries:** pypi libraries for the databricks run\n",
+    "- **egg_libraries:** egg libraries for the databricks run\n",
+    "- **jar_libraries:** jar libraries for the databricks run\n",
+    "- **rcran_libraries:** rcran libraries for the databricks run\n",
+    "- **databricks_compute:** Azure Databricks compute\n",
+    "- **databricks_compute_name:** Name of Azure Databricks compute\n",
+    "\n",
+    "\\* *denotes required fields*  \n",
+    "*You must provide exactly one of num_workers or autoscale paramaters*  \n",
+    "*You must provide exactly one of databricks_compute or databricks_compute_name parameters*"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<a id='notebook_howto'></a>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### 1. Running the demo notebook already added to the Databricks workspace\n",
+    "Create a notebook in the Azure Databricks workspace, and provide the path to that notebook as the value associated with the environment variable \"DATABRICKS_NOTEBOOK_PATH\". This will then set the variable notebook_path when you run the code cell below:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "notebook_path=os.getenv(\"DATABRICKS_NOTEBOOK_PATH\", \"<my-databricks-notebook-path>\") # Databricks notebook path\n",
+    "\n",
+    "dbNbStep = DatabricksStep(\n",
+    "    name=\"DBNotebookInWS\",\n",
+    "    inputs=[step_1_input],\n",
+    "    outputs=[step_1_output],\n",
+    "    num_workers=1,\n",
+    "    notebook_path=notebook_path,\n",
+    "    notebook_params={'myparam': 'testparam'},\n",
+    "    run_name='DB_Notebook_demo',\n",
+    "    compute_target=databricks_compute,\n",
+    "    allow_reuse=False\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Build and submit the Experiment"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "steps = [dbNbStep]\n",
+    "pipeline = Pipeline(workspace=ws, steps=steps)\n",
+    "pipeline_run = Experiment(ws, 'DB_Notebook_demo').submit(pipeline)\n",
+    "pipeline_run.wait_for_completion()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### View Run Details"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### 2. Running a Python script that is already added in DBFS\n",
+    "To run a Python script that is already uploaded to DBFS, follow the instructions below. You will first upload the Python script to DBFS using the [CLI](https://docs.azuredatabricks.net/user-guide/dbfs-databricks-file-system.html).\n",
+    "\n",
+    "The commented out code in the below cell assumes that you have uploaded `train-db-dbfs.py` to the root folder in DBFS. You can upload `train-db-dbfs.py` to the root folder in DBFS using this commandline so you can use `python_script_path = \"dbfs:/train-db-dbfs.py\"`:\n",
+    "\n",
+    "```\n",
+    "dbfs cp ./train-db-dbfs.py dbfs:/train-db-dbfs.py\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "python_script_path = \"dbfs:/train-db-dbfs.py\"\n",
+    "\n",
+    "dbPythonInDbfsStep = DatabricksStep(\n",
+    "    name=\"DBPythonInDBFS\",\n",
+    "    inputs=[step_1_input],\n",
+    "    num_workers=1,\n",
+    "    python_script_path=python_script_path,\n",
+    "    python_script_params={'--input_data'},\n",
+    "    run_name='DB_Python_demo',\n",
+    "    compute_target=databricks_compute,\n",
+    "    allow_reuse=False\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Build and submit the Experiment"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "steps = [dbPythonInDbfsStep]\n",
+    "pipeline = Pipeline(workspace=ws, steps=steps)\n",
+    "pipeline_run = Experiment(ws, 'DB_Python_demo').submit(pipeline)\n",
+    "pipeline_run.wait_for_completion()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### View Run Details"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### 3. Running a Python script in Databricks that currenlty is in local computer\n",
+    "To run a Python script that is currently in your local computer, follow the instructions below. \n",
+    "\n",
+    "The commented out code below code assumes that you have `train-db-local.py` in the `scripts` subdirectory under the current working directory.\n",
+    "\n",
+    "In this case, the Python script will be uploaded first to DBFS, and then the script will be run in Databricks."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "python_script_name = \"train-db-local.py\"\n",
+    "source_directory = \".\"\n",
+    "\n",
+    "dbPythonInLocalMachineStep = DatabricksStep(\n",
+    "    name=\"DBPythonInLocalMachine\",\n",
+    "    inputs=[step_1_input],\n",
+    "    num_workers=1,\n",
+    "    python_script_name=python_script_name,\n",
+    "    source_directory=source_directory,\n",
+    "    run_name='DB_Python_Local_demo',\n",
+    "    compute_target=databricks_compute,\n",
+    "    allow_reuse=False\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Build and submit the Experiment"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "steps = [dbPythonInLocalMachineStep]\n",
+    "pipeline = Pipeline(workspace=ws, steps=steps)\n",
+    "pipeline_run = Experiment(ws, 'DB_Python_Local_demo').submit(pipeline)\n",
+    "pipeline_run.wait_for_completion()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### View Run Details"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### 4. Running a JAR job that is alreay added in DBFS\n",
+    "To run a JAR job that is already uploaded to DBFS, follow the instructions below. You will first upload the JAR file to DBFS using the [CLI](https://docs.azuredatabricks.net/user-guide/dbfs-databricks-file-system.html).\n",
+    "\n",
+    "The commented out code in the below cell assumes that you have uploaded `train-db-dbfs.jar` to the root folder in DBFS. You can upload `train-db-dbfs.jar` to the root folder in DBFS using this commandline so you can use `jar_library_dbfs_path = \"dbfs:/train-db-dbfs.jar\"`:\n",
+    "\n",
+    "```\n",
+    "dbfs cp ./train-db-dbfs.jar dbfs:/train-db-dbfs.jar\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "main_jar_class_name = \"com.microsoft.aeva.Main\"\n",
+    "jar_library_dbfs_path = \"dbfs:/train-db-dbfs.jar\"\n",
+    "\n",
+    "dbJarInDbfsStep = DatabricksStep(\n",
+    "    name=\"DBJarInDBFS\",\n",
+    "    inputs=[step_1_input],\n",
+    "    num_workers=1,\n",
+    "    main_class_name=main_jar_class_name,\n",
+    "    jar_params={'arg1', 'arg2'},\n",
+    "    run_name='DB_JAR_demo',\n",
+    "    jar_libraries=[JarLibrary(jar_library_dbfs_path)],\n",
+    "    compute_target=databricks_compute,\n",
+    "    allow_reuse=False\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Build and submit the Experiment"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "steps = [dbJarInDbfsStep]\n",
+    "pipeline = Pipeline(workspace=ws, steps=steps)\n",
+    "pipeline_run = Experiment(ws, 'DB_JAR_demo').submit(pipeline)\n",
+    "pipeline_run.wait_for_completion()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### View Run Details"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Next: ADLA as a Compute Target\n",
+    "To use ADLA as a compute target from Azure Machine Learning Pipeline, a AdlaStep is used. This [notebook](./aml-pipelines-use-adla-as-compute-target.ipynb) demonstrates the use of AdlaStep in Azure Machine Learning Pipeline."
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "diray"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-with-data-dependency-steps.ipynb

@@ -0,0 +1,418 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Azure Machine Learning Pipelines with Data Dependency\n",
+    "In this notebook, we will see how we can build a pipeline with implicit data dependancy."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prerequisites and Azure Machine Learning Basics\n",
+    "Make sure you go through the configuration Notebook located at https://github.com/Azure/MachineLearningNotebooks first if you haven't. This sets you up with a working config file that has information on your workspace, subscription id, etc. \n",
+    "\n",
+    "### Azure Machine Learning and Pipeline SDK-specific Imports"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import azureml.core\n",
+    "from azureml.core import Workspace, Run, Experiment, Datastore\n",
+    "from azureml.core.compute import AmlCompute\n",
+    "from azureml.core.compute import ComputeTarget\n",
+    "from azureml.core.compute import DataFactoryCompute\n",
+    "from azureml.widgets import RunDetails\n",
+    "\n",
+    "# Check core SDK version number\n",
+    "print(\"SDK version:\", azureml.core.VERSION)\n",
+    "\n",
+    "from azureml.data.data_reference import DataReference\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData, StepSequence\n",
+    "from azureml.pipeline.steps import PythonScriptStep\n",
+    "from azureml.pipeline.steps import DataTransferStep\n",
+    "from azureml.pipeline.core import PublishedPipeline\n",
+    "from azureml.pipeline.core.graph import PipelineParameter\n",
+    "\n",
+    "print(\"Pipeline SDK-specific imports completed\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Initialize Workspace\n",
+    "\n",
+    "Initialize a [workspace](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.workspace(class%29) object from persisted configuration."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "create workspace"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "ws = Workspace.from_config()\n",
+    "print(ws.name, ws.resource_group, ws.location, ws.subscription_id, sep = '\\n')\n",
+    "\n",
+    "# Default datastore (Azure file storage)\n",
+    "def_file_store = ws.get_default_datastore() \n",
+    "print(\"Default datastore's name: {}\".format(def_file_store.name))\n",
+    "\n",
+    "def_blob_store = Datastore(ws, \"workspaceblobstore\")\n",
+    "print(\"Blobstore's name: {}\".format(def_blob_store.name))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# project folder\n",
+    "project_folder = '.'\n",
+    "    \n",
+    "print('Sample projects will be created in {}.'.format(project_folder))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Required data and script files for the the tutorial\n",
+    "Sample files required to finish this tutorial are already copied to the project folder specified above. Even though the .py provided in the samples don't have much \"ML work,\" as a data scientist, you will work on this extensively as part of your work. To complete this tutorial, the contents of these files are not very important. The one-line files are for demostration purpose only."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Compute Targets\n",
+    "See the list of Compute Targets on the workspace."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cts = ws.compute_targets\n",
+    "for ct in cts:\n",
+    "    print(ct)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Retrieve or create a Aml compute\n",
+    "Azure Machine Learning Compute is a service for provisioning and managing clusters of Azure virtual machines for running machine learning workloads. Let's create a new Aml Compute in the current workspace, if it doesn't already exist. We will then run the training script on this compute target."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "aml_compute_target = \"aml-compute\"\n",
+    "try:\n",
+    "    aml_compute = AmlCompute(ws, aml_compute_target)\n",
+    "    print(\"found existing compute target.\")\n",
+    "except:\n",
+    "    print(\"creating new compute target\")\n",
+    "    \n",
+    "    provisioning_config = AmlCompute.provisioning_configuration(vm_size = \"STANDARD_D2_V2\",\n",
+    "                                                                min_nodes = 1, \n",
+    "                                                                max_nodes = 4)    \n",
+    "    aml_compute = ComputeTarget.create(ws, aml_compute_target, provisioning_config)\n",
+    "    aml_compute.wait_for_completion(show_output=True, min_node_count=None, timeout_in_minutes=20)\n",
+    "    \n",
+    "print(\"Aml Compute attached\")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# For a more detailed view of current Azure Machine Learning Compute status, use the 'status' property\n",
+    "# example: un-comment the following line.\n",
+    "# print(aml_compute.status.serialize())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Wait for this call to finish before proceeding (you will see the asterisk turning to a number).**\n",
+    "\n",
+    "Now that you have created the compute target, let's see what the workspace's compute_targets() function returns. You should now see one entry named 'amlcompute' of type AmlCompute."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Building Pipeline Steps with Inputs and Outputs\n",
+    "As mentioned earlier, a step in the pipeline can take data as input. This data can be a data source that lives in one of the accessible data locations, or intermediate data produced by a previous step in the pipeline.\n",
+    "\n",
+    "### Datasources\n",
+    "Datasource is represented by **[DataReference](https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.data.data_reference.datareference?view=azure-ml-py)** object and points to data that lives in or is accessible from Datastore. DataReference could be a pointer to a file or a directory."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Reference the data uploaded to blob storage using DataReference\n",
+    "# Assign the datasource to blob_input_data variable\n",
+    "\n",
+    "# DataReference(datastore, \n",
+    "#               data_reference_name=None, \n",
+    "#               path_on_datastore=None, \n",
+    "#               mode='mount', \n",
+    "#               path_on_compute=None, \n",
+    "#               overwrite=False)\n",
+    "\n",
+    "blob_input_data = DataReference(\n",
+    "    datastore=def_blob_store,\n",
+    "    data_reference_name=\"test_data\",\n",
+    "    path_on_datastore=\"20newsgroups/20news.pkl\")\n",
+    "print(\"DataReference object created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Intermediate/Output Data\n",
+    "Intermediate data (or output of a Step) is represented by **[PipelineData](https://docs.microsoft.com/en-us/python/api/azureml-pipeline-core/azureml.pipeline.core.pipelinedata?view=azure-ml-py)** object. PipelineData can be produced by one step and consumed in another step by providing the PipelineData object as an output of one step and the input of one or more steps.\n",
+    "\n",
+    "#### Constructing PipelineData\n",
+    "- **name:** [*Required*] Name of the data item within the pipeline graph\n",
+    "- **datastore_name:** Name of the Datastore to write this output to\n",
+    "- **output_name:** Name of the output\n",
+    "- **output_mode:** Specifies \"upload\" or \"mount\" modes for producing output (default: mount)\n",
+    "- **output_path_on_compute:** For \"upload\" mode, the path to which the module writes this output during execution\n",
+    "- **output_overwrite:** Flag to overwrite pre-existing data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Define intermediate data using PipelineData\n",
+    "# Syntax\n",
+    "\n",
+    "# PipelineData(name, \n",
+    "#              datastore=None, \n",
+    "#              output_name=None, \n",
+    "#              output_mode='mount', \n",
+    "#              output_path_on_compute=None, \n",
+    "#              output_overwrite=None, \n",
+    "#              data_type=None, \n",
+    "#              is_directory=None)\n",
+    "\n",
+    "# Naming the intermediate data as processed_data1 and assigning it to the variable processed_data1.\n",
+    "processed_data1 = PipelineData(\"processed_data1\",datastore=def_blob_store)\n",
+    "print(\"PipelineData object created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Pipelines steps using datasources and intermediate data\n",
+    "Machine learning pipelines can have many steps and these steps could use or reuse datasources and intermediate data. Here's how we construct such a pipeline:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Define a Step that consumes a datasource and produces intermediate data.\n",
+    "In this step, we define a step that consumes a datasource and produces intermediate data.\n",
+    "\n",
+    "**Open `train.py` in the local machine and examine the arguments, inputs, and outputs for the script. That will give you a good sense of why the script argument names used below are important.** "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# step4 consumes the datasource (Datareference) in the previous step\n",
+    "# and produces processed_data1\n",
+    "trainStep = PythonScriptStep(\n",
+    "    script_name=\"train.py\", \n",
+    "    arguments=[\"--input_data\", blob_input_data, \"--output_train\", processed_data1],\n",
+    "    inputs=[blob_input_data],\n",
+    "    outputs=[processed_data1],\n",
+    "    compute_target=aml_compute, \n",
+    "    source_directory=project_folder\n",
+    ")\n",
+    "print(\"trainStep created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Define a Step that consumes intermediate data and produces intermediate data\n",
+    "In this step, we define a step that consumes an intermediate data and produces intermediate data.\n",
+    "\n",
+    "**Open `extract.py` in the local machine and examine the arguments, inputs, and outputs for the script. That will give you a good sense of why the script argument names used below are important.** "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# step5 to use the intermediate data produced by step4\n",
+    "# This step also produces an output processed_data2\n",
+    "processed_data2 = PipelineData(\"processed_data2\", datastore=def_blob_store)\n",
+    "\n",
+    "extractStep = PythonScriptStep(\n",
+    "    script_name=\"extract.py\",\n",
+    "    arguments=[\"--input_extract\", processed_data1, \"--output_extract\", processed_data2],\n",
+    "    inputs=[processed_data1],\n",
+    "    outputs=[processed_data2],\n",
+    "    compute_target=aml_compute, \n",
+    "    source_directory=project_folder)\n",
+    "print(\"extractStep created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Define a Step that consumes multiple intermediate data and produces intermediate data\n",
+    "In this step, we define a step that consumes multiple intermediate data and produces intermediate data.\n",
+    "\n",
+    "**Open `compare.py` in the local machine and examine the arguments, inputs, and outputs for the script. That will give you a good sense of why the script argument names used below are important.**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Now define step6 that takes two inputs (both intermediate data), and produce an output\n",
+    "processed_data3 = PipelineData(\"processed_data3\", datastore=def_blob_store)\n",
+    "\n",
+    "compareStep = PythonScriptStep(\n",
+    "    script_name=\"compare.py\",\n",
+    "    arguments=[\"--compare_data1\", processed_data1, \"--compare_data2\", processed_data2, \"--output_compare\", processed_data3],\n",
+    "    inputs=[processed_data1, processed_data2],\n",
+    "    outputs=[processed_data3],    \n",
+    "    compute_target=aml_compute, \n",
+    "    source_directory=project_folder)\n",
+    "print(\"compareStep created\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Build the pipeline"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline1 = Pipeline(workspace=ws, steps=[compareStep])\n",
+    "print (\"Pipeline is built\")\n",
+    "\n",
+    "pipeline1.validate()\n",
+    "print(\"Simple validation complete\") "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline_run1 = Experiment(ws, 'Data_dependency').submit(pipeline1)\n",
+    "print(\"Pipeline is submitted for execution\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "RunDetails(pipeline_run1).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Next: Publishing the Pipeline and calling it from the REST endpoint\n",
+    "See this [notebook](./aml-pipelines-publish-and-run-using-rest-endpoint.ipynb) to understand how the pipeline is published and you can call the REST endpoint to run the pipeline."
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "diray"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/compare.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+
+import argparse
+import os
+
+print("In compare.py")
+print("As a data scientist, this is where I use my compare code.")
+parser = argparse.ArgumentParser("compare")
+parser.add_argument("--compare_data1", type=str, help="compare_data1 data")
+parser.add_argument("--compare_data2", type=str, help="compare_data2 data")
+parser.add_argument("--output_compare", type=str, help="output_compare directory")
+parser.add_argument("--pipeline_param", type=int, help="pipeline parameter")
+
+args = parser.parse_args()
+
+print("Argument 1: %s" % args.compare_data1)
+print("Argument 2: %s" % args.compare_data2)
+print("Argument 3: %s" % args.output_compare)
+print("Argument 4: %s" % args.pipeline_param)
+
+if not (args.output_compare is None):
+    os.makedirs(args.output_compare, exist_ok=True)
+    print("%s created" % args.output_compare)

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/extract.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+
+import argparse
+import os
+
+print("In extract.py")
+print("As a data scientist, this is where I use my extract code.")
+
+parser = argparse.ArgumentParser("extract")
+parser.add_argument("--input_extract", type=str, help="input_extract data")
+parser.add_argument("--output_extract", type=str, help="output_extract directory")
+
+args = parser.parse_args()
+
+print("Argument 1: %s" % args.input_extract)
+print("Argument 2: %s" % args.output_extract)
+
+if not (args.output_extract is None):
+    os.makedirs(args.output_extract, exist_ok=True)
+    print("%s created" % args.output_extract)

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/train-db-dbfs.py

@@ -0,0 +1,5 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+
+print("In train.py")
+print("As a data scientist, this is where I use my training code.")

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/train-db-local.py

@@ -0,0 +1,5 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+
+print("In train.py")
+print("As a data scientist, this is where I use my training code.")

how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/train.py

@@ -0,0 +1,22 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+
+import argparse
+import os
+
+print("In train.py")
+print("As a data scientist, this is where I use my training code.")
+
+parser = argparse.ArgumentParser("train")
+
+parser.add_argument("--input_data", type=str, help="input data")
+parser.add_argument("--output_train", type=str, help="output_train directory")
+
+args = parser.parse_args()
+
+print("Argument 1: %s" % args.input_data)
+print("Argument 2: %s" % args.output_train)
+
+if not (args.output_train is None):
+    os.makedirs(args.output_train, exist_ok=True)
+    print("%s created" % args.output_train)

how-to-use-azureml/machine-learning-pipelines/pipeline-batch-scoring/batch_scoring.py

@@ -0,0 +1,119 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+
+import os
+import argparse
+import datetime
+import time
+import tensorflow as tf
+from math import ceil
+import numpy as np
+import shutil
+from tensorflow.contrib.slim.python.slim.nets import inception_v3
+from azureml.core.model import Model
+
+slim = tf.contrib.slim
+
+parser = argparse.ArgumentParser(description="Start a tensorflow model serving")
+parser.add_argument('--model_name', dest="model_name", required=True)
+parser.add_argument('--label_dir', dest="label_dir", required=True)
+parser.add_argument('--dataset_path', dest="dataset_path", required=True)
+parser.add_argument('--output_dir', dest="output_dir", required=True)
+parser.add_argument('--batch_size', dest="batch_size", type=int, required=True)
+
+args = parser.parse_args()
+
+image_size = 299
+num_channel = 3
+
+# create output directory if it does not exist
+os.makedirs(args.output_dir, exist_ok=True)
+
+
+def get_class_label_dict(label_file):
+    label = []
+    proto_as_ascii_lines = tf.gfile.GFile(label_file).readlines()
+    for l in proto_as_ascii_lines:
+        label.append(l.rstrip())
+    return label
+
+
+class DataIterator:
+    def __init__(self, data_dir):
+        self.file_paths = []
+        image_list = os.listdir(data_dir)
+        # total_size = len(image_list)
+        self.file_paths = [data_dir + '/' + file_name.rstrip() for file_name in image_list]
+
+        self.labels = [1 for file_name in self.file_paths]
+
+    @property
+    def size(self):
+        return len(self.labels)
+
+    def input_pipeline(self, batch_size):
+        images_tensor = tf.convert_to_tensor(self.file_paths, dtype=tf.string)
+        labels_tensor = tf.convert_to_tensor(self.labels, dtype=tf.int64)
+        input_queue = tf.train.slice_input_producer([images_tensor, labels_tensor], shuffle=False)
+        labels = input_queue[1]
+        images_content = tf.read_file(input_queue[0])
+
+        image_reader = tf.image.decode_jpeg(images_content, channels=num_channel, name="jpeg_reader")
+        float_caster = tf.cast(image_reader, tf.float32)
+        new_size = tf.constant([image_size, image_size], dtype=tf.int32)
+        images = tf.image.resize_images(float_caster, new_size)
+        images = tf.divide(tf.subtract(images, [0]), [255])
+
+        image_batch, label_batch = tf.train.batch([images, labels], batch_size=batch_size, capacity=5 * batch_size)
+        return image_batch
+
+
+def main(_):
+    # start_time = datetime.datetime.now()
+    label_file_name = os.path.join(args.label_dir, "labels.txt")
+    label_dict = get_class_label_dict(label_file_name)
+    classes_num = len(label_dict)
+    test_feeder = DataIterator(data_dir=args.dataset_path)
+    total_size = len(test_feeder.labels)
+    count = 0
+    # get model from model registry
+    model_path = Model.get_model_path(args.model_name)
+    with tf.Session() as sess:
+        test_images = test_feeder.input_pipeline(batch_size=args.batch_size)
+        with slim.arg_scope(inception_v3.inception_v3_arg_scope()):
+            input_images = tf.placeholder(tf.float32, [args.batch_size, image_size, image_size, num_channel])
+            logits, _ = inception_v3.inception_v3(input_images,
+                                                  num_classes=classes_num,
+                                                  is_training=False)
+            probabilities = tf.argmax(logits, 1)
+
+        sess.run(tf.global_variables_initializer())
+        sess.run(tf.local_variables_initializer())
+        coord = tf.train.Coordinator()
+        threads = tf.train.start_queue_runners(sess=sess, coord=coord)
+        saver = tf.train.Saver()
+        saver.restore(sess, model_path)
+        out_filename = os.path.join(args.output_dir, "result-labels.txt")
+        with open(out_filename, "w") as result_file:
+            i = 0
+            while count < total_size and not coord.should_stop():
+                test_images_batch = sess.run(test_images)
+                file_names_batch = test_feeder.file_paths[i * args.batch_size:
+                                                          min(test_feeder.size, (i + 1) * args.batch_size)]
+                results = sess.run(probabilities, feed_dict={input_images: test_images_batch})
+                new_add = min(args.batch_size, total_size - count)
+                count += new_add
+                i += 1
+                for j in range(new_add):
+                    result_file.write(os.path.basename(file_names_batch[j]) + ": " + label_dict[results[j]] + "\n")
+                result_file.flush()
+            coord.request_stop()
+            coord.join(threads)
+
+        # copy the file to artifacts
+        shutil.copy(out_filename, "./outputs/")
+        # Move the processed data out of the blob so that the next run can process the data.
+
+
+if __name__ == "__main__":
+    tf.app.run()

how-to-use-azureml/machine-learning-pipelines/pipeline-batch-scoring/pipeline-batch-scoring.ipynb

@@ -0,0 +1,573 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.  \n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Using Azure Machine Learning Pipelines for batch prediction\n",
+    "\n",
+    "In this notebook we will demonstrate how to run a batch scoring job using Azure Machine Learning pipelines. Our example job will be to take an already-trained image classification model, and run that model on some unlabeled images. The image classification model that we'll use is the __[Inception-V3 model](https://arxiv.org/abs/1512.00567)__  and we'll run this model on unlabeled images from the __[ImageNet](http://image-net.org/)__ dataset. \n",
+    "\n",
+    "The outline of this notebook is as follows:\n",
+    "\n",
+    "- Register the pretrained inception model into the model registry. \n",
+    "- Store the dataset images in a blob container.\n",
+    "- Use the registered model to do batch scoring on the images in the data blob container."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prerequisites\n",
+    "Make sure you go through the configuration Notebook located at https://github.com/Azure/MachineLearningNotebooks first if you haven't. This sets you up with a working config file that has information on your workspace, subscription id, etc. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core import Datastore\n",
+    "from azureml.core import Experiment\n",
+    "from azureml.core.compute import AmlCompute, ComputeTarget\n",
+    "from azureml.core.conda_dependencies import CondaDependencies\n",
+    "from azureml.core.datastore import Datastore\n",
+    "from azureml.core.runconfig import CondaDependencies, RunConfiguration\n",
+    "from azureml.data.data_reference import DataReference\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData\n",
+    "from azureml.pipeline.steps import PythonScriptStep"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "from azureml.core import Workspace, Run, Experiment\n",
+    "\n",
+    "ws = Workspace.from_config()\n",
+    "print('Workspace name: ' + ws.name, \n",
+    "      'Azure region: ' + ws.location, \n",
+    "      'Subscription id: ' + ws.subscription_id, \n",
+    "      'Resource group: ' + ws.resource_group, sep = '\\n')\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Set up machine learning resources"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Set up datastores\n",
+    "First, let’s access the datastore that has the model, labels, and images. \n",
+    "\n",
+    "### Create a datastore that points to a blob container containing sample images\n",
+    "\n",
+    "We have created a public blob container `sampledata` on an account named `pipelinedata`, containing images from the ImageNet evaluation set. In the next step, we create a datastore with the name `images_datastore`, which points to this container. In the call to `register_azure_blob_container` below, setting the `overwrite` flag to `True` overwrites any datastore that was created previously with that name. \n",
+    "\n",
+    "This step can be changed to point to your blob container by providing your own `datastore_name`, `container_name`, and `account_name`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "account_name = \"pipelinedata\"\n",
+    "datastore_name=\"images_datastore\"\n",
+    "container_name=\"sampledata\"\n",
+    "\n",
+    "batchscore_blob = Datastore.register_azure_blob_container(ws, \n",
+    "                      datastore_name=datastore_name, \n",
+    "                      container_name= container_name, \n",
+    "                      account_name=account_name, \n",
+    "                      overwrite=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Next, let’s specify the default datastore for the outputs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def_data_store = ws.get_default_datastore()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Configure data references\n",
+    "Now you need to add references to the data, as inputs to the appropriate pipeline steps in your pipeline. A data source in a pipeline is represented by a DataReference object. The DataReference object points to data that lives in, or is accessible from, a datastore. We need DataReference objects corresponding to the following: the directory containing the input images, the directory in which the pretrained model is stored, the directory containing the labels, and the output directory."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "input_images = DataReference(datastore=batchscore_blob, \n",
+    "                             data_reference_name=\"input_images\",\n",
+    "                             path_on_datastore=\"batchscoring/images\",\n",
+    "                             mode=\"download\"\n",
+    "                            )\n",
+    "model_dir = DataReference(datastore=batchscore_blob, \n",
+    "                          data_reference_name=\"input_model\",\n",
+    "                          path_on_datastore=\"batchscoring/models\",\n",
+    "                          mode=\"download\"                          \n",
+    "                         )\n",
+    "label_dir = DataReference(datastore=batchscore_blob, \n",
+    "                          data_reference_name=\"input_labels\",\n",
+    "                          path_on_datastore=\"batchscoring/labels\",\n",
+    "                          mode=\"download\"                          \n",
+    "                         )\n",
+    "output_dir = PipelineData(name=\"scores\", \n",
+    "                          datastore=def_data_store, \n",
+    "                          output_path_on_compute=\"batchscoring/results\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Create and attach Compute targets\n",
+    "Use the below code to create and attach Compute targets. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "\n",
+    "# choose a name for your cluster\n",
+    "aml_compute_name = os.environ.get(\"AML_COMPUTE_NAME\", \"gpu-cluster\")\n",
+    "cluster_min_nodes = os.environ.get(\"AML_COMPUTE_MIN_NODES\", 0)\n",
+    "cluster_max_nodes = os.environ.get(\"AML_COMPUTE_MAX_NODES\", 1)\n",
+    "vm_size = os.environ.get(\"AML_COMPUTE_SKU\", \"STANDARD_NC6\")\n",
+    "\n",
+    "\n",
+    "if aml_compute_name in ws.compute_targets:\n",
+    "    compute_target = ws.compute_targets[aml_compute_name]\n",
+    "    if compute_target and type(compute_target) is AmlCompute:\n",
+    "        print('found compute target. just use it. ' + aml_compute_name)\n",
+    "else:\n",
+    "    print('creating a new compute target...')\n",
+    "    provisioning_config = AmlCompute.provisioning_configuration(vm_size = vm_size, # NC6 is GPU-enabled\n",
+    "                                                                vm_priority = 'lowpriority', # optional\n",
+    "                                                                min_nodes = cluster_min_nodes, \n",
+    "                                                                max_nodes = cluster_max_nodes)\n",
+    "\n",
+    "    # create the cluster\n",
+    "    compute_target = ComputeTarget.create(ws, aml_compute_name, provisioning_config)\n",
+    "    \n",
+    "    # can poll for a minimum number of nodes and for a specific timeout. \n",
+    "    # if no min node count is provided it will use the scale settings for the cluster\n",
+    "    compute_target.wait_for_completion(show_output=True, min_node_count=None, timeout_in_minutes=20)\n",
+    "    \n",
+    "     # For a more detailed view of current Azure Machine Learning Compute  status, use the 'status' property    \n",
+    "    print(compute_target.status.serialize())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prepare the Model"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Download the Model\n",
+    "\n",
+    "Download and extract the model from http://download.tensorflow.org/models/inception_v3_2016_08_28.tar.gz to `\"models\"`"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# create directory for model\n",
+    "model_dir = 'models'\n",
+    "if not os.path.isdir(model_dir):\n",
+    "    os.mkdir(model_dir)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import tarfile\n",
+    "import urllib.request\n",
+    "\n",
+    "url=\"http://download.tensorflow.org/models/inception_v3_2016_08_28.tar.gz\"\n",
+    "response = urllib.request.urlretrieve(url, \"model.tar.gz\")\n",
+    "tar = tarfile.open(\"model.tar.gz\", \"r:gz\")\n",
+    "tar.extractall(model_dir)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Register the model with Workspace"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import shutil\n",
+    "from azureml.core.model import Model\n",
+    "\n",
+    "# register downloaded model \n",
+    "model = Model.register(model_path = \"models/inception_v3.ckpt\",\n",
+    "                       model_name = \"inception\", # this is the name the model is registered as\n",
+    "                       tags = {'pretrained': \"inception\"},\n",
+    "                       description = \"Imagenet trained tensorflow inception\",\n",
+    "                       workspace = ws)\n",
+    "# remove the downloaded dir after registration if you wish\n",
+    "shutil.rmtree(\"models\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Write your scoring script"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "To do the scoring, we use a batch scoring script `batch_scoring.py`, which is located in the same directory that this notebook is in. You can take a look at this script to see how you might modify it for your custom batch scoring task.\n",
+    "\n",
+    "The python script `batch_scoring.py` takes input images, applies the image classification model to these images, and outputs a classification result to a results file.\n",
+    "\n",
+    "The script `batch_scoring.py` takes the following parameters:\n",
+    "\n",
+    "- `--model_name`: the name of the model being used, which is expected to be in the `model_dir` directory\n",
+    "- `--label_dir` : the directory holding the `labels.txt` file \n",
+    "- `--dataset_path`: the directory containing the input images\n",
+    "- `--output_dir` : the script will run the model on the data and output a `results-label.txt` to this directory\n",
+    "- `--batch_size` : the batch size used in running the model.\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Build and run the batch scoring pipeline\n",
+    "You have everything you need to build the pipeline. Let’s put all these together."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "###  Specify the environment to run the script\n",
+    "Specify the conda dependencies for your script. You will need this object when you create the pipeline step later on."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.runconfig import DEFAULT_GPU_IMAGE\n",
+    "\n",
+    "cd = CondaDependencies.create(pip_packages=[\"tensorflow-gpu==1.10.0\", \"azureml-defaults\"])\n",
+    "\n",
+    "# Runconfig\n",
+    "amlcompute_run_config = RunConfiguration(conda_dependencies=cd)\n",
+    "amlcompute_run_config.environment.docker.enabled = True\n",
+    "amlcompute_run_config.environment.docker.gpu_support = True\n",
+    "amlcompute_run_config.environment.docker.base_image = DEFAULT_GPU_IMAGE\n",
+    "amlcompute_run_config.environment.spark.precache_packages = False"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Specify the parameters for your pipeline\n",
+    "A subset of the parameters to the python script can be given as input when we re-run a `PublishedPipeline`. In the current example, we define `batch_size` taken by the script as such parameter."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.pipeline.core.graph import PipelineParameter\n",
+    "batch_size_param = PipelineParameter(name=\"param_batch_size\", default_value=20)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Create the pipeline step\n",
+    "Create the pipeline step using the script, environment configuration, and parameters. Specify the compute target you already attached to your workspace as the target of execution of the script. We will use PythonScriptStep to create the pipeline step."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "inception_model_name = \"inception_v3.ckpt\"\n",
+    "\n",
+    "batch_score_step = PythonScriptStep(\n",
+    "    name=\"batch_scoring\",\n",
+    "    script_name=\"batch_scoring.py\",\n",
+    "    arguments=[\"--dataset_path\", input_images, \n",
+    "               \"--model_name\", \"inception\",\n",
+    "               \"--label_dir\", label_dir, \n",
+    "               \"--output_dir\", output_dir, \n",
+    "               \"--batch_size\", batch_size_param],\n",
+    "    compute_target=compute_target,\n",
+    "    inputs=[input_images, label_dir],\n",
+    "    outputs=[output_dir],\n",
+    "    runconfig=amlcompute_run_config\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run the pipeline\n",
+    "At this point you can run the pipeline and examine the output it produced. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline = Pipeline(workspace=ws, steps=[batch_score_step])\n",
+    "pipeline_run = Experiment(ws, 'batch_scoring').submit(pipeline, pipeline_params={\"param_batch_size\": 20})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Monitor the run"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline_run.wait_for_completion(show_output=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Download and review output"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "step_run = list(pipeline_run.get_children())[0]\n",
+    "step_run.download_file(\"./outputs/result-labels.txt\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pandas as pd\n",
+    "df = pd.read_csv(\"result-labels.txt\", delimiter=\":\", header=None)\n",
+    "df.columns = [\"Filename\", \"Prediction\"]\n",
+    "df.head()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Publish a pipeline and rerun using a REST call"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Create a published pipeline\n",
+    "Once you are satisfied with the outcome of the run, you can publish the pipeline to run it with different input values later. When you publish a pipeline, you will get a REST endpoint that accepts invoking of the pipeline with the set of parameters you have already incorporated above using PipelineParameter."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "published_pipeline = pipeline_run.publish_pipeline(\n",
+    "    name=\"Inception_v3_scoring\", description=\"Batch scoring using Inception v3 model\", version=\"1.0\")\n",
+    "\n",
+    "published_id = published_pipeline.id"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Rerun the pipeline using the REST endpoint"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Get AAD token"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.authentication import AzureCliAuthentication\n",
+    "import requests\n",
+    "\n",
+    "cli_auth = AzureCliAuthentication()\n",
+    "aad_token = cli_auth.get_authentication_header()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run published pipeline"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.pipeline.core import PublishedPipeline\n",
+    "\n",
+    "rest_endpoint = published_pipeline.endpoint\n",
+    "# specify batch size when running the pipeline\n",
+    "response = requests.post(rest_endpoint, \n",
+    "                         headers=aad_token, \n",
+    "                         json={\"ExperimentName\": \"batch_scoring\",\n",
+    "                               \"ParameterAssignments\": {\"param_batch_size\": 50}})\n",
+    "run_id = response.json()[\"Id\"]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Monitor the new run"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.pipeline.core.run import PipelineRun\n",
+    "published_pipeline_run = PipelineRun(ws.experiments[\"batch_scoring\"], run_id)\n",
+    "\n",
+    "RunDetails(published_pipeline_run).show()"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "hichando"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/machine-learning-pipelines/pipeline-style-transfer/neural_style.py

@@ -0,0 +1,187 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+
+# Original source: https://github.com/pytorch/examples/blob/master/fast_neural_style/neural_style/neural_style.py
+import argparse
+import os
+import sys
+import re
+
+from PIL import Image
+import torch
+from torchvision import transforms
+
+
+def load_image(filename, size=None, scale=None):
+    img = Image.open(filename)
+    if size is not None:
+        img = img.resize((size, size), Image.ANTIALIAS)
+    elif scale is not None:
+        img = img.resize((int(img.size[0] / scale), int(img.size[1] / scale)), Image.ANTIALIAS)
+    return img
+
+
+def save_image(filename, data):
+    img = data.clone().clamp(0, 255).numpy()
+    img = img.transpose(1, 2, 0).astype("uint8")
+    img = Image.fromarray(img)
+    img.save(filename)
+
+
+class TransformerNet(torch.nn.Module):
+    def __init__(self):
+        super(TransformerNet, self).__init__()
+        # Initial convolution layers
+        self.conv1 = ConvLayer(3, 32, kernel_size=9, stride=1)
+        self.in1 = torch.nn.InstanceNorm2d(32, affine=True)
+        self.conv2 = ConvLayer(32, 64, kernel_size=3, stride=2)
+        self.in2 = torch.nn.InstanceNorm2d(64, affine=True)
+        self.conv3 = ConvLayer(64, 128, kernel_size=3, stride=2)
+        self.in3 = torch.nn.InstanceNorm2d(128, affine=True)
+        # Residual layers
+        self.res1 = ResidualBlock(128)
+        self.res2 = ResidualBlock(128)
+        self.res3 = ResidualBlock(128)
+        self.res4 = ResidualBlock(128)
+        self.res5 = ResidualBlock(128)
+        # Upsampling Layers
+        self.deconv1 = UpsampleConvLayer(128, 64, kernel_size=3, stride=1, upsample=2)
+        self.in4 = torch.nn.InstanceNorm2d(64, affine=True)
+        self.deconv2 = UpsampleConvLayer(64, 32, kernel_size=3, stride=1, upsample=2)
+        self.in5 = torch.nn.InstanceNorm2d(32, affine=True)
+        self.deconv3 = ConvLayer(32, 3, kernel_size=9, stride=1)
+        # Non-linearities
+        self.relu = torch.nn.ReLU()
+
+    def forward(self, X):
+        y = self.relu(self.in1(self.conv1(X)))
+        y = self.relu(self.in2(self.conv2(y)))
+        y = self.relu(self.in3(self.conv3(y)))
+        y = self.res1(y)
+        y = self.res2(y)
+        y = self.res3(y)
+        y = self.res4(y)
+        y = self.res5(y)
+        y = self.relu(self.in4(self.deconv1(y)))
+        y = self.relu(self.in5(self.deconv2(y)))
+        y = self.deconv3(y)
+        return y
+
+
+class ConvLayer(torch.nn.Module):
+    def __init__(self, in_channels, out_channels, kernel_size, stride):
+        super(ConvLayer, self).__init__()
+        reflection_padding = kernel_size // 2
+        self.reflection_pad = torch.nn.ReflectionPad2d(reflection_padding)
+        self.conv2d = torch.nn.Conv2d(in_channels, out_channels, kernel_size, stride)
+
+    def forward(self, x):
+        out = self.reflection_pad(x)
+        out = self.conv2d(out)
+        return out
+
+
+class ResidualBlock(torch.nn.Module):
+    """ResidualBlock
+    introduced in: https://arxiv.org/abs/1512.03385
+    recommended architecture: http://torch.ch/blog/2016/02/04/resnets.html
+    """
+
+    def __init__(self, channels):
+        super(ResidualBlock, self).__init__()
+        self.conv1 = ConvLayer(channels, channels, kernel_size=3, stride=1)
+        self.in1 = torch.nn.InstanceNorm2d(channels, affine=True)
+        self.conv2 = ConvLayer(channels, channels, kernel_size=3, stride=1)
+        self.in2 = torch.nn.InstanceNorm2d(channels, affine=True)
+        self.relu = torch.nn.ReLU()
+
+    def forward(self, x):
+        residual = x
+        out = self.relu(self.in1(self.conv1(x)))
+        out = self.in2(self.conv2(out))
+        out = out + residual
+        return out
+
+
+class UpsampleConvLayer(torch.nn.Module):
+    """UpsampleConvLayer
+    Upsamples the input and then does a convolution. This method gives better results
+    compared to ConvTranspose2d.
+    ref: http://distill.pub/2016/deconv-checkerboard/
+    """
+
+    def __init__(self, in_channels, out_channels, kernel_size, stride, upsample=None):
+        super(UpsampleConvLayer, self).__init__()
+        self.upsample = upsample
+        if upsample:
+            self.upsample_layer = torch.nn.Upsample(mode='nearest', scale_factor=upsample)
+        reflection_padding = kernel_size // 2
+        self.reflection_pad = torch.nn.ReflectionPad2d(reflection_padding)
+        self.conv2d = torch.nn.Conv2d(in_channels, out_channels, kernel_size, stride)
+
+    def forward(self, x):
+        x_in = x
+        if self.upsample:
+            x_in = self.upsample_layer(x_in)
+        out = self.reflection_pad(x_in)
+        out = self.conv2d(out)
+        return out
+    
+
+def stylize(args):
+    device = torch.device("cuda" if args.cuda else "cpu")
+    with torch.no_grad():
+        style_model = TransformerNet()
+        state_dict = torch.load(os.path.join(args.model_dir, args.style+".pth"))
+        # remove saved deprecated running_* keys in InstanceNorm from the checkpoint
+        for k in list(state_dict.keys()):
+            if re.search(r'in\d+\.running_(mean|var)$', k):
+                del state_dict[k]
+        style_model.load_state_dict(state_dict)
+        style_model.to(device)
+
+        filenames = os.listdir(args.content_dir)
+
+        for filename in filenames:
+            print("Processing {}".format(filename))
+            full_path = os.path.join(args.content_dir, filename)
+            content_image = load_image(full_path, scale=args.content_scale)
+            content_transform = transforms.Compose([
+                transforms.ToTensor(),
+                transforms.Lambda(lambda x: x.mul(255))
+            ])
+            content_image = content_transform(content_image)
+            content_image = content_image.unsqueeze(0).to(device)
+
+            output = style_model(content_image).cpu()
+
+            output_path = os.path.join(args.output_dir, filename)
+            save_image(output_path, output[0])
+
+def main():
+    arg_parser = argparse.ArgumentParser(description="parser for fast-neural-style")
+
+    arg_parser.add_argument("--content-scale", type=float, default=None,
+                                 help="factor for scaling down the content image")
+    arg_parser.add_argument("--model-dir", type=str, required=True,
+                                 help="saved model to be used for stylizing the image.")
+    arg_parser.add_argument("--cuda", type=int, required=True,
+                                 help="set it to 1 for running on GPU, 0 for CPU")
+    arg_parser.add_argument("--style", type=str,
+                                 help="style name")
+
+    arg_parser.add_argument("--content-dir", type=str, required=True,
+            help="directory holding the images")
+    arg_parser.add_argument("--output-dir", type=str, required=True,
+            help="directory holding the output images")
+    args = arg_parser.parse_args()
+
+    if args.cuda and not torch.cuda.is_available():
+        print("ERROR: cuda is not available, try running on CPU")
+        sys.exit(1)
+    os.makedirs(args.output_dir, exist_ok=True)
+    stylize(args)
+
+
+if __name__ == "__main__":
+    main()

how-to-use-azureml/machine-learning-pipelines/pipeline-style-transfer/neural_style_mpi.py

@@ -0,0 +1,207 @@
+# Original source: https://github.com/pytorch/examples/blob/master/fast_neural_style/neural_style/neural_style.py
+import argparse
+import os
+import sys
+import re
+
+from PIL import Image
+import torch
+from torchvision import transforms
+
+from mpi4py import MPI
+
+
+def load_image(filename, size=None, scale=None):
+    img = Image.open(filename)
+    if size is not None:
+        img = img.resize((size, size), Image.ANTIALIAS)
+    elif scale is not None:
+        img = img.resize((int(img.size[0] / scale), int(img.size[1] / scale)), Image.ANTIALIAS)
+    return img
+
+
+def save_image(filename, data):
+    img = data.clone().clamp(0, 255).numpy()
+    img = img.transpose(1, 2, 0).astype("uint8")
+    img = Image.fromarray(img)
+    img.save(filename)
+
+
+class TransformerNet(torch.nn.Module):
+    def __init__(self):
+        super(TransformerNet, self).__init__()
+        # Initial convolution layers
+        self.conv1 = ConvLayer(3, 32, kernel_size=9, stride=1)
+        self.in1 = torch.nn.InstanceNorm2d(32, affine=True)
+        self.conv2 = ConvLayer(32, 64, kernel_size=3, stride=2)
+        self.in2 = torch.nn.InstanceNorm2d(64, affine=True)
+        self.conv3 = ConvLayer(64, 128, kernel_size=3, stride=2)
+        self.in3 = torch.nn.InstanceNorm2d(128, affine=True)
+        # Residual layers
+        self.res1 = ResidualBlock(128)
+        self.res2 = ResidualBlock(128)
+        self.res3 = ResidualBlock(128)
+        self.res4 = ResidualBlock(128)
+        self.res5 = ResidualBlock(128)
+        # Upsampling Layers
+        self.deconv1 = UpsampleConvLayer(128, 64, kernel_size=3, stride=1, upsample=2)
+        self.in4 = torch.nn.InstanceNorm2d(64, affine=True)
+        self.deconv2 = UpsampleConvLayer(64, 32, kernel_size=3, stride=1, upsample=2)
+        self.in5 = torch.nn.InstanceNorm2d(32, affine=True)
+        self.deconv3 = ConvLayer(32, 3, kernel_size=9, stride=1)
+        # Non-linearities
+        self.relu = torch.nn.ReLU()
+
+    def forward(self, X):
+        y = self.relu(self.in1(self.conv1(X)))
+        y = self.relu(self.in2(self.conv2(y)))
+        y = self.relu(self.in3(self.conv3(y)))
+        y = self.res1(y)
+        y = self.res2(y)
+        y = self.res3(y)
+        y = self.res4(y)
+        y = self.res5(y)
+        y = self.relu(self.in4(self.deconv1(y)))
+        y = self.relu(self.in5(self.deconv2(y)))
+        y = self.deconv3(y)
+        return y
+
+
+class ConvLayer(torch.nn.Module):
+    def __init__(self, in_channels, out_channels, kernel_size, stride):
+        super(ConvLayer, self).__init__()
+        reflection_padding = kernel_size // 2
+        self.reflection_pad = torch.nn.ReflectionPad2d(reflection_padding)
+        self.conv2d = torch.nn.Conv2d(in_channels, out_channels, kernel_size, stride)
+
+    def forward(self, x):
+        out = self.reflection_pad(x)
+        out = self.conv2d(out)
+        return out
+
+
+class ResidualBlock(torch.nn.Module):
+    """ResidualBlock
+    introduced in: https://arxiv.org/abs/1512.03385
+    recommended architecture: http://torch.ch/blog/2016/02/04/resnets.html
+    """
+
+    def __init__(self, channels):
+        super(ResidualBlock, self).__init__()
+        self.conv1 = ConvLayer(channels, channels, kernel_size=3, stride=1)
+        self.in1 = torch.nn.InstanceNorm2d(channels, affine=True)
+        self.conv2 = ConvLayer(channels, channels, kernel_size=3, stride=1)
+        self.in2 = torch.nn.InstanceNorm2d(channels, affine=True)
+        self.relu = torch.nn.ReLU()
+
+    def forward(self, x):
+        residual = x
+        out = self.relu(self.in1(self.conv1(x)))
+        out = self.in2(self.conv2(out))
+        out = out + residual
+        return out
+
+
+class UpsampleConvLayer(torch.nn.Module):
+    """UpsampleConvLayer
+    Upsamples the input and then does a convolution. This method gives better results
+    compared to ConvTranspose2d.
+    ref: http://distill.pub/2016/deconv-checkerboard/
+    """
+
+    def __init__(self, in_channels, out_channels, kernel_size, stride, upsample=None):
+        super(UpsampleConvLayer, self).__init__()
+        self.upsample = upsample
+        if upsample:
+            self.upsample_layer = torch.nn.Upsample(mode='nearest', scale_factor=upsample)
+        reflection_padding = kernel_size // 2
+        self.reflection_pad = torch.nn.ReflectionPad2d(reflection_padding)
+        self.conv2d = torch.nn.Conv2d(in_channels, out_channels, kernel_size, stride)
+
+    def forward(self, x):
+        x_in = x
+        if self.upsample:
+            x_in = self.upsample_layer(x_in)
+        out = self.reflection_pad(x_in)
+        out = self.conv2d(out)
+        return out
+
+
+def stylize(args, comm):
+
+    rank = comm.Get_rank()
+    size = comm.Get_size()
+
+    device = torch.device("cuda" if args.cuda else "cpu")
+    with torch.no_grad():
+        style_model = TransformerNet()
+        state_dict = torch.load(os.path.join(args.model_dir, args.style + ".pth"))
+        # remove saved deprecated running_* keys in InstanceNorm from the checkpoint
+        for k in list(state_dict.keys()):
+            if re.search(r'in\d+\.running_(mean|var)$', k):
+                del state_dict[k]
+        style_model.load_state_dict(state_dict)
+        style_model.to(device)
+
+        filenames = os.listdir(args.content_dir)
+        filenames = sorted(filenames)
+        partition_size = len(filenames) // size
+        partitioned_filenames = filenames[rank * partition_size: (rank + 1) * partition_size]
+        print("RANK {} - is processing {} images out of the total {}".format(rank, len(partitioned_filenames),
+                                                                             len(filenames)))
+
+        output_paths = []
+        for filename in partitioned_filenames:
+            # print("Processing {}".format(filename))
+            full_path = os.path.join(args.content_dir, filename)
+            content_image = load_image(full_path, scale=args.content_scale)
+            content_transform = transforms.Compose([
+                transforms.ToTensor(),
+                transforms.Lambda(lambda x: x.mul(255))
+            ])
+            content_image = content_transform(content_image)
+            content_image = content_image.unsqueeze(0).to(device)
+
+            output = style_model(content_image).cpu()
+
+            output_path = os.path.join(args.output_dir, filename)
+            save_image(output_path, output[0])
+
+            output_paths.append(output_path)
+
+        print("RANK {} - number of pre-aggregated output files {}".format(rank, len(output_paths)))
+
+        output_paths_list = comm.gather(output_paths, root=0)
+
+        if rank == 0:
+            print("RANK {} - number of aggregated output files {}".format(rank, len(output_paths_list)))
+            print("RANK {} - end".format(rank))
+
+
+def main():
+    arg_parser = argparse.ArgumentParser(description="parser for fast-neural-style")
+
+    arg_parser.add_argument("--content-scale", type=float, default=None,
+                            help="factor for scaling down the content image")
+    arg_parser.add_argument("--model-dir", type=str, required=True,
+                            help="saved model to be used for stylizing the image.")
+    arg_parser.add_argument("--cuda", type=int, required=True,
+                            help="set it to 1 for running on GPU, 0 for CPU")
+    arg_parser.add_argument("--style", type=str, help="style name")
+    arg_parser.add_argument("--content-dir", type=str, required=True,
+                            help="directory holding the images")
+    arg_parser.add_argument("--output-dir", type=str, required=True,
+                            help="directory holding the output images")
+    args = arg_parser.parse_args()
+
+    comm = MPI.COMM_WORLD
+
+    if args.cuda and not torch.cuda.is_available():
+        print("ERROR: cuda is not available, try running on CPU")
+        sys.exit(1)
+    os.makedirs(args.output_dir, exist_ok=True)
+    stylize(args, comm)
+
+
+if __name__ == "__main__":
+    main()

how-to-use-azureml/machine-learning-pipelines/pipeline-style-transfer/pipeline-style-transfer.ipynb

@@ -0,0 +1,610 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Copyright (c) Microsoft Corporation. All rights reserved.\n",
+    "\n",
+    "Licensed under the MIT License."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Neural style transfer on video\n",
+    "Using modified code from `pytorch`'s neural style [example](https://pytorch.org/tutorials/advanced/neural_style_tutorial.html), we show how to setup a pipeline for doing style transfer on video. The pipeline has following steps:\n",
+    "1. Split a video into images\n",
+    "2. Run neural style on each image using one of the provided models (from `pytorch` pretrained models for this example).\n",
+    "3. Stitch the image back into a video."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Prerequisites\n",
+    "Make sure you go through the configuration Notebook located at https://github.com/Azure/MachineLearningNotebooks first if you haven't. This sets you up with a working config file that has information on your workspace, subscription id, etc. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize Workspace\n",
+    "\n",
+    "Initialize a workspace object from persisted configuration."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "from azureml.core import Workspace, Run, Experiment\n",
+    "\n",
+    "ws = Workspace.from_config()\n",
+    "print('Workspace name: ' + ws.name, \n",
+    "      'Azure region: ' + ws.location, \n",
+    "      'Subscription id: ' + ws.subscription_id, \n",
+    "      'Resource group: ' + ws.resource_group, sep = '\\n')\n",
+    "\n",
+    "scripts_folder = \"scripts_folder\"\n",
+    "\n",
+    "if not os.path.isdir(scripts_folder):\n",
+    "    os.mkdir(scripts_folder)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.compute import AmlCompute, ComputeTarget\n",
+    "from azureml.core.datastore import Datastore\n",
+    "from azureml.data.data_reference import DataReference\n",
+    "from azureml.pipeline.core import Pipeline, PipelineData\n",
+    "from azureml.pipeline.steps import PythonScriptStep, MpiStep\n",
+    "from azureml.core.runconfig import CondaDependencies, RunConfiguration"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Create or use existing compute"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# AmlCompute\n",
+    "cpu_cluster_name = \"cpucluster\"\n",
+    "try:\n",
+    "    cpu_cluster = AmlCompute(ws, cpu_cluster_name)\n",
+    "    print(\"found existing cluster.\")\n",
+    "except:\n",
+    "    print(\"creating new cluster\")\n",
+    "    provisioning_config = AmlCompute.provisioning_configuration(vm_size = \"STANDARD_D2_v2\",\n",
+    "                                                                    max_nodes = 1)\n",
+    "\n",
+    "    # create the cluster\n",
+    "    cpu_cluster = ComputeTarget.create(ws, cpu_cluster_name, provisioning_config)\n",
+    "    cpu_cluster.wait_for_completion(show_output=True)\n",
+    "    \n",
+    "# AmlCompute\n",
+    "gpu_cluster_name = \"gpucluster\"\n",
+    "try:\n",
+    "    gpu_cluster = AmlCompute(ws, gpu_cluster_name)\n",
+    "    print(\"found existing cluster.\")\n",
+    "except:\n",
+    "    print(\"creating new cluster\")\n",
+    "    provisioning_config = AmlCompute.provisioning_configuration(vm_size = \"STANDARD_NC6\",\n",
+    "                                                                    max_nodes = 3)\n",
+    "\n",
+    "    # create the cluster\n",
+    "    gpu_cluster = ComputeTarget.create(ws, gpu_cluster_name, provisioning_config)\n",
+    "    gpu_cluster.wait_for_completion(show_output=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Python Scripts\n",
+    "We use an edited version of `neural_style_mpi.py` (original is [here](https://github.com/pytorch/examples/blob/master/fast_neural_style/neural_style/neural_style_mpi.py)). Scripts to split and stitch the video are thin wrappers to calls to `ffmpeg`. \n",
+    "\n",
+    "We install `ffmpeg` through conda dependencies."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import shutil\n",
+    "shutil.copy(\"neural_style_mpi.py\", scripts_folder)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%writefile $scripts_folder/process_video.py\n",
+    "import argparse\n",
+    "import glob\n",
+    "import os\n",
+    "import subprocess\n",
+    "\n",
+    "parser = argparse.ArgumentParser(description=\"Process input video\")\n",
+    "parser.add_argument('--input_video', required=True)\n",
+    "parser.add_argument('--output_audio', required=True)\n",
+    "parser.add_argument('--output_images', required=True)\n",
+    "\n",
+    "args = parser.parse_args()\n",
+    "\n",
+    "os.makedirs(args.output_audio, exist_ok=True)\n",
+    "os.makedirs(args.output_images, exist_ok=True)\n",
+    "\n",
+    "subprocess.run(\"ffmpeg -i {} {}/video.aac\"\n",
+    "              .format(args.input_video, args.output_audio),\n",
+    "               shell=True, check=True\n",
+    "              )\n",
+    "\n",
+    "subprocess.run(\"ffmpeg -i {} {}/%05d_video.jpg -hide_banner\"\n",
+    "              .format(args.input_video, args.output_images),\n",
+    "               shell=True, check=True\n",
+    "              )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%writefile $scripts_folder/stitch_video.py\n",
+    "import argparse\n",
+    "import os\n",
+    "import subprocess\n",
+    "\n",
+    "parser = argparse.ArgumentParser(description=\"Process input video\")\n",
+    "parser.add_argument('--images_dir', required=True)\n",
+    "parser.add_argument('--input_audio', required=True)\n",
+    "parser.add_argument('--output_dir', required=True)\n",
+    "\n",
+    "args = parser.parse_args()\n",
+    "\n",
+    "os.makedirs(args.output_dir, exist_ok=True)\n",
+    "\n",
+    "subprocess.run(\"ffmpeg -framerate 30 -i {}/%05d_video.jpg -c:v libx264 -profile:v high -crf 20 -pix_fmt yuv420p \"\n",
+    "               \"-y {}/video_without_audio.mp4\"\n",
+    "               .format(args.images_dir, args.output_dir),\n",
+    "               shell=True, check=True\n",
+    "              )\n",
+    "\n",
+    "subprocess.run(\"ffmpeg -i {}/video_without_audio.mp4 -i {}/video.aac -map 0:0 -map 1:0 -vcodec \"\n",
+    "               \"copy -acodec copy -y {}/video_with_audio.mp4\"\n",
+    "               .format(args.output_dir, args.input_audio, args.output_dir),\n",
+    "               shell=True, check=True\n",
+    "              )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# datastore for input video\n",
+    "account_name = \"happypathspublic\"\n",
+    "video_ds = Datastore.register_azure_blob_container(ws, \"videos\", \"videos\",\n",
+    "                                            account_name=account_name, overwrite=True)\n",
+    "\n",
+    "# datastore for models\n",
+    "models_ds = Datastore.register_azure_blob_container(ws, \"models\", \"styletransfer\", \n",
+    "                                                        account_name=\"pipelinedata\", \n",
+    "                                                        overwrite=True)\n",
+    "                                                        \n",
+    "# downloaded models from https://pytorch.org/tutorials/advanced/neural_style_tutorial.html are kept here\n",
+    "models_dir = DataReference(data_reference_name=\"models\", datastore=models_ds, \n",
+    "                           path_on_datastore=\"saved_models\", mode=\"download\")\n",
+    "\n",
+    "# the default blob store attached to a workspace\n",
+    "default_datastore = ws.get_default_datastore()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Sample video"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "orangutan_video = DataReference(datastore=video_ds,\n",
+    "                            data_reference_name=\"video\",\n",
+    "                            path_on_datastore=\"orangutan.mp4\", mode=\"download\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cd = CondaDependencies()\n",
+    "\n",
+    "cd.add_channel(\"conda-forge\")\n",
+    "cd.add_conda_package(\"ffmpeg\")\n",
+    "\n",
+    "cd.add_channel(\"pytorch\")\n",
+    "cd.add_conda_package(\"pytorch\")\n",
+    "cd.add_conda_package(\"torchvision\")\n",
+    "\n",
+    "# Runconfig\n",
+    "amlcompute_run_config = RunConfiguration(conda_dependencies=cd)\n",
+    "amlcompute_run_config.environment.docker.enabled = True\n",
+    "amlcompute_run_config.environment.docker.gpu_support = True\n",
+    "amlcompute_run_config.environment.docker.base_image = \"pytorch/pytorch\"\n",
+    "amlcompute_run_config.environment.spark.precache_packages = False"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ffmpeg_audio = PipelineData(name=\"ffmpeg_audio\", datastore=default_datastore)\n",
+    "ffmpeg_images = PipelineData(name=\"ffmpeg_images\", datastore=default_datastore)\n",
+    "processed_images = PipelineData(name=\"processed_images\", datastore=default_datastore)\n",
+    "output_video = PipelineData(name=\"output_video\", datastore=default_datastore)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Define tweakable parameters to pipeline\n",
+    "These parameters can be changed when the pipeline is published and rerun from a REST call"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.pipeline.core.graph import PipelineParameter\n",
+    "# create a parameter for style (one of \"candy\", \"mosaic\", \"rain_princess\", \"udnie\") to transfer the images to\n",
+    "style_param = PipelineParameter(name=\"style\", default_value=\"mosaic\")\n",
+    "# create a parameter for the number of nodes to use in step no. 2 (style transfer)\n",
+    "nodecount_param = PipelineParameter(name=\"nodecount\", default_value=1)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "split_video_step = PythonScriptStep(\n",
+    "    name=\"split video\",\n",
+    "    script_name=\"process_video.py\",\n",
+    "    arguments=[\"--input_video\", orangutan_video,\n",
+    "               \"--output_audio\", ffmpeg_audio,\n",
+    "               \"--output_images\", ffmpeg_images,\n",
+    "              ],\n",
+    "    compute_target=cpu_cluster,\n",
+    "    inputs=[orangutan_video],\n",
+    "    outputs=[ffmpeg_images, ffmpeg_audio],\n",
+    "    runconfig=amlcompute_run_config,\n",
+    "    source_directory=scripts_folder\n",
+    ")\n",
+    "\n",
+    "# create a MPI step for distributing style transfer step across multiple nodes in AmlCompute \n",
+    "# using 'nodecount_param' PipelineParameter\n",
+    "distributed_style_transfer_step = MpiStep(\n",
+    "    name=\"mpi style transfer\",\n",
+    "    script_name=\"neural_style_mpi.py\",\n",
+    "    arguments=[\"--content-dir\", ffmpeg_images,\n",
+    "               \"--output-dir\", processed_images,\n",
+    "               \"--model-dir\", models_dir,\n",
+    "               \"--style\", style_param,\n",
+    "               \"--cuda\", 1\n",
+    "              ],\n",
+    "    compute_target=gpu_cluster,\n",
+    "    node_count=nodecount_param, \n",
+    "    process_count_per_node=1,\n",
+    "    inputs=[models_dir, ffmpeg_images],\n",
+    "    outputs=[processed_images],\n",
+    "    pip_packages=[\"mpi4py\", \"torch\", \"torchvision\"],\n",
+    "    runconfig=amlcompute_run_config,\n",
+    "    use_gpu=True,\n",
+    "    source_directory=scripts_folder\n",
+    ")\n",
+    "\n",
+    "stitch_video_step = PythonScriptStep(\n",
+    "    name=\"stitch\",\n",
+    "    script_name=\"stitch_video.py\",\n",
+    "    arguments=[\"--images_dir\", processed_images, \n",
+    "               \"--input_audio\", ffmpeg_audio, \n",
+    "               \"--output_dir\", output_video],\n",
+    "    compute_target=cpu_cluster,\n",
+    "    inputs=[processed_images, ffmpeg_audio],\n",
+    "    outputs=[output_video],\n",
+    "    runconfig=amlcompute_run_config,\n",
+    "    source_directory=scripts_folder\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Run the pipeline"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline = Pipeline(workspace=ws, steps=[stitch_video_step])\n",
+    "# submit the pipeline and provide values for the PipelineParameters used in the pipeline\n",
+    "pipeline_run = Experiment(ws, 'style_transfer').submit(pipeline, pipeline_params={\"style\": \"mosaic\", \"nodecount\": 3})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Monitor using widget"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.widgets import RunDetails\n",
+    "RunDetails(pipeline_run).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Downloads the video in `output_video` folder"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Download output video"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def download_video(run, target_dir=None):\n",
+    "    stitch_run = run.find_step_run(\"stitch\")[0]\n",
+    "    port_data = stitch_run.get_output_data(\"output_video\")\n",
+    "    port_data.download(target_dir, show_progress=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pipeline_run.wait_for_completion()\n",
+    "download_video(pipeline_run, \"output_video_mosaic\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Publish pipeline"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "published_pipeline = pipeline_run.publish_pipeline(\n",
+    "    name=\"batch score style transfer\", description=\"style transfer\", version=\"1.0\")\n",
+    "\n",
+    "published_id = published_pipeline.id"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#  Re-run pipeline through REST calls for other styles"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Get AAD token"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from azureml.core.authentication import AzureCliAuthentication\n",
+    "import requests\n",
+    "\n",
+    "cli_auth = AzureCliAuthentication()\n",
+    "aad_token = cli_auth.get_authentication_header()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Get endpoint URL"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "rest_endpoint = published_pipeline.endpoint"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Send request and monitor"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# run the pipeline using PipelineParameter values style='candy' and nodecount=2\n",
+    "response = requests.post(rest_endpoint, \n",
+    "                         headers=aad_token,\n",
+    "                         json={\"ExperimentName\": \"style_transfer\",\n",
+    "                               \"ParameterAssignments\": {\"style\": \"candy\", \"nodecount\": 2}})                         \n",
+    "run_id = response.json()[\"Id\"]\n",
+    "\n",
+    "from azureml.pipeline.core.run import PipelineRun\n",
+    "published_pipeline_run_candy = PipelineRun(ws.experiments[\"style_transfer\"], run_id)\n",
+    "\n",
+    "RunDetails(published_pipeline_run_candy).show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# run the pipeline using PipelineParameter values style='rain_princess' and nodecount=3\n",
+    "response = requests.post(rest_endpoint, \n",
+    "                         headers=aad_token,\n",
+    "                         json={\"ExperimentName\": \"style_transfer\",\n",
+    "                               \"ParameterAssignments\": {\"style\": \"rain_princess\", \"nodecount\": 3}})    \n",
+    "run_id = response.json()[\"Id\"]\n",
+    "\n",
+    "from azureml.pipeline.core.run import PipelineRun\n",
+    "published_pipeline_run_rain = PipelineRun(ws.experiments[\"style_transfer\"], run_id)\n",
+    "\n",
+    "RunDetails(published_pipeline_run_rain).show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# run the pipeline using PipelineParameter values style='udnie' and nodecount=4\n",
+    "response = requests.post(rest_endpoint, \n",
+    "                         headers=aad_token,\n",
+    "                         json={\"ExperimentName\": \"style_transfer\",\n",
+    "                               \"ParameterAssignments\": {\"style\": \"udnie\", \"nodecount\": 4}})   \n",
+    "run_id = response.json()[\"Id\"]\n",
+    "\n",
+    "from azureml.pipeline.core.run import PipelineRun\n",
+    "published_pipeline_run_udnie = PipelineRun(ws.experiments[\"style_transfer\"], run_id)\n",
+    "\n",
+    "RunDetails(published_pipeline_run_udnie).show()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Download output from re-run"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "published_pipeline_run_candy.wait_for_completion()\n",
+    "published_pipeline_run_rain.wait_for_completion()\n",
+    "published_pipeline_run_udnie.wait_for_completion()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "download_video(published_pipeline_run_candy, target_dir=\"output_video_candy\")\n",
+    "download_video(published_pipeline_run_rain, target_dir=\"output_video_rain_princess\")\n",
+    "download_video(published_pipeline_run_udnie, target_dir=\"output_video_udnie\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "authors": [
+   {
+    "name": "hichando"
+   }
+  ],
+  "kernelspec": {
+   "display_name": "Python 3.6",
+   "language": "python",
+   "name": "python36"
+  },
+  "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.6.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

how-to-use-azureml/training-with-deep-learning/README.md

@@ -0,0 +1,6 @@
+## Azure Machine Learning service training examples
+
+These examples show you:
+ * Distributed training of models on Machine Learning Compute cluster
+ * Hyperparameter tuning at scale
+ * Using Tensorboard with Azure ML Python SDK.

how-to-use-azureml/training-with-deep-learning/distributed-cntk-with-custom-docker/distributed-cntk-with-custom-docker.ipynb

@@ -13,7 +13,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 06. Distributed CNTK using custom docker images\n",
+    "# Distributed CNTK using custom docker images\n",
     "In this tutorial, you will train a CNTK model on the [MNIST](http://yann.lecun.com/exdb/mnist/) dataset using a custom docker image and distributed training."
    ]
   },
@@ -40,6 +40,29 @@
     "print(\"SDK version:\", azureml.core.VERSION)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "Diagnostics"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "\n",
+    "set_diagnostics_collection(send_diagnostics=True)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -68,10 +91,12 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create a remote compute target\n",
-    "You will need to create a [compute target](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture#compute-target) to execute your training script on. In this tutorial, you create an [Azure Batch AI](https://docs.microsoft.com/azure/batch-ai/overview) cluster as your training compute resource. This code creates a cluster for you if it does not already exist in your workspace.\n",
+    "## Create or Attach existing AmlCompute\n",
+    "You will need to create a [compute target](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture#compute-target) for training your model. In this tutorial, you create `AmlCompute` as your training compute resource.\n",
     "\n",
-    "**Creation of the cluster takes approximately 5 minutes.** If the cluster is already in your workspace this code will skip the cluster creation process."
+    "**Creation of AmlCompute takes approximately 5 minutes.** If the AmlCompute with that name is already in your workspace this code will skip the creation process.\n",
+    "\n",
+    "As with other Azure services, there are limits on certain resources (e.g. AmlCompute) associated with the Azure Machine Learning service. Please read [this article](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-manage-quotas) on the default limits and how to request more quota."
    ]
   },
   {
@@ -80,7 +105,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.core.compute import ComputeTarget, BatchAiCompute\n",
+    "from azureml.core.compute import ComputeTarget, AmlCompute\n",
     "from azureml.core.compute_target import ComputeTargetException\n",
     "\n",
     "# choose a name for your cluster\n",
@@ -91,18 +116,16 @@
     "    print('Found existing compute target.')\n",
     "except ComputeTargetException:\n",
     "    print('Creating a new compute target...')\n",
-    "    compute_config = BatchAiCompute.provisioning_configuration(vm_size='STANDARD_NC6', \n",
-    "                                                                autoscale_enabled=True,\n",
-    "                                                                cluster_min_nodes=0, \n",
-    "                                                                cluster_max_nodes=4)\n",
+    "    compute_config = AmlCompute.provisioning_configuration(vm_size='STANDARD_NC6',\n",
+    "                                                           max_nodes=4)\n",
     "\n",
     "    # create the cluster\n",
     "    compute_target = ComputeTarget.create(ws, cluster_name, compute_config)\n",
     "\n",
     "    compute_target.wait_for_completion(show_output=True)\n",
     "\n",
-    "    # Use the 'status' property to get a detailed status for the current cluster. \n",
-    "    print(compute_target.status.serialize())"
+    "# Use the 'status' property to get a detailed status for the current AmlCompute. \n",
+    "print(compute_target.status.serialize())"
    ]
   },
   {
@@ -221,6 +244,7 @@
    "outputs": [],
    "source": [
     "import shutil\n",
+    "\n",
     "shutil.copy('cntk_distr_mnist.py', project_folder)"
    ]
   },
@@ -261,7 +285,7 @@
     "from azureml.train.estimator import *\n",
     "\n",
     "script_params = {\n",
-    "    '--num_epochs': 50,\n",
+    "    '--num_epochs': 20,\n",
     "    '--data_dir': ds_data.as_mount(),\n",
     "    '--output_dir': './outputs'\n",
     "}\n",
@@ -302,7 +326,7 @@
    "outputs": [],
    "source": [
     "run = experiment.submit(estimator)\n",
-    "print(run.get_details())"
+    "print(run)"
    ]
   },
   {
@@ -319,7 +343,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
+    "\n",
     "RunDetails(run).show()"
    ]
   },
@@ -341,6 +366,11 @@
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "minxia"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/training-with-deep-learning/distributed-pytorch-with-horovod/distributed-pytorch-with-horovod.ipynb

@@ -13,21 +13,17 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 02. Distributed PyTorch with Horovod\n",
-    "In this tutorial, you will train a PyTorch model on the [MNIST](http://yann.lecun.com/exdb/mnist/) dataset using distributed training via [Horovod](https://github.com/uber/horovod)."
+    "# Distributed PyTorch with Horovod\n",
+    "In this tutorial, you will train a PyTorch model on the [MNIST](http://yann.lecun.com/exdb/mnist/) dataset using distributed training via [Horovod](https://github.com/uber/horovod) across a GPU cluster."
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "## Prerequisites\n",
-    "* Understand the [architecture and terms](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture) introduced by Azure Machine Learning (AML)\n",
-    "* Go through the [00.configuration.ipynb](https://github.com/Azure/MachineLearningNotebooks/blob/master/00.configuration.ipynb) notebook to:\n",
-    "    * install the AML SDK\n",
-    "    * create a workspace and its configuration file (`config.json`)\n",
-    "* Review the [tutorial](https://aka.ms/aml-notebook-pytorch) on single-node PyTorch training using the SDK"
+    "* Go through the [Configuration](https://github.com/Azure/MachineLearningNotebooks/blob/master/configuration.ipynb) notebook to install the Azure Machine Learning Python SDK and create an Azure ML `Workspace`\n",
+    "* Review the [tutorial](https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/training-with-deep-learning/train-hyperparameter-tune-deploy-with-pytorch/train-hyperparameter-tune-deploy-with-pytorch.ipynb) on single-node PyTorch training using Azure Machine Learning"
    ]
   },
   {
@@ -42,6 +38,29 @@
     "print(\"SDK version:\", azureml.core.VERSION)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Diagnostics\n",
+    "Opt-in diagnostics for better experience, quality, and security of future releases."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "Diagnostics"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "from azureml.telemetry import set_diagnostics_collection\n",
+    "\n",
+    "set_diagnostics_collection(send_diagnostics=True)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -70,10 +89,12 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Create a remote compute target\n",
-    "You will need to create a [compute target](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture#compute-target) to execute your training script on. In this tutorial, you create an [Azure Batch AI](https://docs.microsoft.com/azure/batch-ai/overview) cluster as your training compute resource. This code creates a cluster for you if it does not already exist in your workspace.\n",
+    "## Create or attach existing AmlCompute\n",
+    "You will need to create a [compute target](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture#compute-target) for training your model. In this tutorial, we use Azure ML managed compute ([AmlCompute](https://docs.microsoft.com/azure/machine-learning/service/how-to-set-up-training-targets#amlcompute)) for our remote training compute resource. Specifically, the below code creates an `STANDARD_NC6` GPU cluster that autoscales from `0` to `4` nodes.\n",
     "\n",
-    "**Creation of the cluster takes approximately 5 minutes.** If the cluster is already in your workspace this code will skip the cluster creation process."
+    "**Creation of AmlCompute takes approximately 5 minutes.** If the AmlCompute with that name is already in your workspace, this code will skip the creation process.\n",
+    "\n",
+    "As with other Azure services, there are limits on certain resources (e.g. AmlCompute) associated with the Azure Machine Learning service. Please read [this article](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-manage-quotas) on the default limits and how to request more quota."
    ]
   },
   {
@@ -82,7 +103,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.core.compute import ComputeTarget, BatchAiCompute\n",
+    "from azureml.core.compute import ComputeTarget, AmlCompute\n",
     "from azureml.core.compute_target import ComputeTargetException\n",
     "\n",
     "# choose a name for your cluster\n",
@@ -93,25 +114,23 @@
     "    print('Found existing compute target.')\n",
     "except ComputeTargetException:\n",
     "    print('Creating a new compute target...')\n",
-    "    compute_config = BatchAiCompute.provisioning_configuration(vm_size='STANDARD_NC6', \n",
-    "                                                                autoscale_enabled=True,\n",
-    "                                                                cluster_min_nodes=0, \n",
-    "                                                                cluster_max_nodes=4)\n",
+    "    compute_config = AmlCompute.provisioning_configuration(vm_size='STANDARD_NC6',\n",
+    "                                                           max_nodes=4)\n",
     "\n",
     "    # create the cluster\n",
     "    compute_target = ComputeTarget.create(ws, cluster_name, compute_config)\n",
     "\n",
     "    compute_target.wait_for_completion(show_output=True)\n",
     "\n",
-    "    # Use the 'status' property to get a detailed status for the current cluster. \n",
-    "    print(compute_target.status.serialize())"
+    "# Use the 'status' property to get a detailed status for the current AmlCompute. \n",
+    "print(compute_target.status.serialize())"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The above code creates a GPU cluster. If you instead want to create a CPU cluster, provide a different VM size to the `vm_size` parameter, such as `STANDARD_D2_V2`."
+    "The above code creates GPU compute. If you instead want to create CPU compute, provide a different VM size to the `vm_size` parameter, such as `STANDARD_D2_V2`."
    ]
   },
   {
@@ -119,7 +138,7 @@
    "metadata": {},
    "source": [
     "## Train model on the remote compute\n",
-    "Now that we have the cluster ready to go, let's run our distributed training job."
+    "Now that we have the AmlCompute ready to go, let's run our distributed training job."
    ]
   },
   {
@@ -146,7 +165,27 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Copy the training script `pytorch_horovod_mnist.py` into this project directory."
+    "### Prepare training script\n",
+    "Now you will need to create your training script. In this tutorial, the script for distributed training of MNIST is already provided for you at `pytorch_horovod_mnist.py`. In practice, you should be able to take any custom PyTorch training script as is and run it with Azure ML without having to modify your code.\n",
+    "\n",
+    "However, if you would like to use Azure ML's [metric logging](https://docs.microsoft.com/azure/machine-learning/service/concept-azure-machine-learning-architecture#logging) capabilities, you will have to add a small amount of Azure ML logic inside your training script. In this example, at each logging interval, we will log the loss for that minibatch to our Azure ML run.\n",
+    "\n",
+    "To do so, in `pytorch_horovod_mnist.py`, we will first access the Azure ML `Run` object within the script:\n",
+    "```Python\n",
+    "from azureml.core.run import Run\n",
+    "run = Run.get_context()\n",
+    "```\n",
+    "Later within the script, we log the loss metric to our run:\n",
+    "```Python\n",
+    "run.log('loss', loss.item())\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Once your script is ready, copy the training script `pytorch_horovod_mnist.py` into the project directory."
    ]
   },
   {
@@ -156,6 +195,7 @@
    "outputs": [],
    "source": [
     "import shutil\n",
+    "\n",
     "shutil.copy('pytorch_horovod_mnist.py', project_folder)"
    ]
   },
@@ -184,7 +224,7 @@
    "metadata": {},
    "source": [
     "### Create a PyTorch estimator\n",
-    "The AML SDK's PyTorch estimator enables you to easily submit PyTorch training jobs for both single-node and distributed runs. For more information on the PyTorch estimator, refer [here](https://docs.microsoft.com/azure/machine-learning/service/how-to-train-pytorch)."
+    "The Azure ML SDK's PyTorch estimator enables you to easily submit PyTorch training jobs for both single-node and distributed runs. For more information on the PyTorch estimator, refer [here](https://docs.microsoft.com/azure/machine-learning/service/how-to-train-pytorch)."
    ]
   },
   {
@@ -211,6 +251,26 @@
     "The above code specifies that we will run our training script on `2` nodes, with one worker per node. In order to execute a distributed run using MPI/Horovod, you must provide the argument `distributed_backend='mpi'`. Using this estimator with these settings, PyTorch, Horovod and their dependencies will be installed for you. However, if your script also uses other packages, make sure to install them via the `PyTorch` constructor's `pip_packages` or `conda_packages` parameters."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "To use the latest version of PyTorch 1.0, run the following cell:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "estimator.conda_dependencies.remove_conda_package('pytorch=0.4.0')\n",
+    "estimator.conda_dependencies.remove_pip_package('horovod==0.13.11')\n",
+    "estimator.conda_dependencies.add_conda_package('pytorch-nightly')\n",
+    "estimator.conda_dependencies.add_channel('pytorch')\n",
+    "estimator.conda_dependencies.add_pip_package('horovod==0.15.2')"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -226,7 +286,7 @@
    "outputs": [],
    "source": [
     "run = experiment.submit(estimator)\n",
-    "print(run.get_details())"
+    "print(run)"
    ]
   },
   {
@@ -234,7 +294,7 @@
    "metadata": {},
    "source": [
     "### Monitor your run\n",
-    "You can monitor the progress of the run with a Jupyter widget. Like the run submission, the widget is asynchronous and provides live updates every 10-15 seconds until the job completes."
+    "You can monitor the progress of the run with a Jupyter widget. Like the run submission, the widget is asynchronous and provides live updates every 10-15 seconds until the job completes. You can see that the widget automatically plots and visualizes the loss metric that we logged to the Azure ML run."
    ]
   },
   {
@@ -243,7 +303,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from azureml.train.widgets import RunDetails\n",
+    "from azureml.widgets import RunDetails\n",
+    "\n",
     "RunDetails(run).show()"
    ]
   },
@@ -265,6 +326,11 @@
   }
  ],
  "metadata": {
+  "authors": [
+   {
+    "name": "minxia"
+   }
+  ],
   "kernelspec": {
    "display_name": "Python 3.6",
    "language": "python",

how-to-use-azureml/training-with-deep-learning/distributed-pytorch-with-horovod/pytorch_horovod_mnist.py

@@ -1,17 +1,16 @@
-# Copyright 2017 Uber Technologies, Inc.
-# Licensed under the Apache License, Version 2.0
-# Script from horovod/examples: https://github.com/uber/horovod/blob/master/examples/pytorch_mnist.py
-
 from __future__ import print_function
 import argparse
 import torch.nn as nn
 import torch.nn.functional as F
 import torch.optim as optim
 from torchvision import datasets, transforms
-from torch.autograd import Variable
 import torch.utils.data.distributed
 import horovod.torch as hvd
 
+from azureml.core.run import Run
+# get the Azure ML run object
+run = Run.get_context()
+
 # Training settings
 parser = argparse.ArgumentParser(description='PyTorch MNIST Example')
 parser.add_argument('--batch-size', type=int, default=64, metavar='N',
@@ -30,6 +29,8 @@ parser.add_argument('--seed', type=int, default=42, metavar='S',
                     help='random seed (default: 42)')
 parser.add_argument('--log-interval', type=int, default=10, metavar='N',
                     help='how many batches to wait before logging training status')
+parser.add_argument('--fp16-allreduce', action='store_true', default=False,
+                    help='use fp16 compression during allreduce')
 args = parser.parse_args()
 args.cuda = not args.no_cuda and torch.cuda.is_available()
 
@@ -97,9 +98,13 @@ hvd.broadcast_parameters(model.state_dict(), root_rank=0)
 optimizer = optim.SGD(model.parameters(), lr=args.lr * hvd.size(),
                       momentum=args.momentum)
 
+# Horovod: (optional) compression algorithm.
+compression = hvd.Compression.fp16 if args.fp16_allreduce else hvd.Compression.none
+
 # Horovod: wrap optimizer with DistributedOptimizer.
-optimizer = hvd.DistributedOptimizer(
-    optimizer, named_parameters=model.named_parameters())
+optimizer = hvd.DistributedOptimizer(optimizer,
+                                     named_parameters=model.named_parameters(),
+                                     compression=compression)
 
 
 def train(epoch):
@@ -108,7 +113,6 @@ def train(epoch):
     for batch_idx, (data, target) in enumerate(train_loader):
         if args.cuda:
             data, target = data.cuda(), target.cuda()
-        data, target = Variable(data), Variable(target)
         optimizer.zero_grad()
         output = model(data)
         loss = F.nll_loss(output, target)
@@ -117,13 +121,16 @@ def train(epoch):
         if batch_idx % args.log_interval == 0:
             print('Train Epoch: {} [{}/{} ({:.0f}%)]\tLoss: {:.6f}'.format(
                 epoch, batch_idx * len(data), len(train_sampler),
-                100. * batch_idx / len(train_loader), loss.data[0]))
+                100. * batch_idx / len(train_loader), loss.item()))
+
+            # log the loss to the Azure ML run
+            run.log('loss', loss.item())
 
 
 def metric_average(val, name):
-    tensor = torch.FloatTensor([val])
+    tensor = torch.tensor(val)
     avg_tensor = hvd.allreduce(tensor, name=name)
-    return avg_tensor[0]
+    return avg_tensor.item()
 
 
 def test():
@@ -133,10 +140,9 @@ def test():
     for data, target in test_loader:
         if args.cuda:
             data, target = data.cuda(), target.cuda()
-        data, target = Variable(data, volatile=True), Variable(target)
         output = model(data)
         # sum up batch loss
-        test_loss += F.nll_loss(output, target, size_average=False).data[0]
+        test_loss += F.nll_loss(output, target, size_average=False).item()
         # get the index of the max log-probability
         pred = output.data.max(1, keepdim=True)[1]
         test_accuracy += pred.eq(target.data.view_as(pred)).cpu().float().sum()