From 0e3198f31182f81f371ef5b17756f942f9d1a323 Mon Sep 17 00:00:00 2001 From: Roope Astala Date: Thu, 31 Jan 2019 09:32:30 -0500 Subject: [PATCH] fix NBSETUP --- NBSETUP.md | 59 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 43 insertions(+), 16 deletions(-) diff --git a/NBSETUP.md b/NBSETUP.md index 8cebb5f8..89d092af 100644 --- a/NBSETUP.md +++ b/NBSETUP.md @@ -1,10 +1,11 @@ -# Notebook setup +# Setting up environment --- -To run the notebooks in this repository use one of these methods: +To run the notebooks in this repository use one of the two options. -## Use Azure Notebooks - Jupyter based notebooks in the Azure cloud +## Option 1: Use Azure Notebooks +Azure Notebooks is a hosted Jupyter-based notebook service in the Azure cloud. Azure Machine Learning Python SDK is already pre-installed in the Azure Notebooks `Python 3.6` kernel. 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 @@ -15,20 +16,46 @@ To run the notebooks in this repository use one of these methods: ![set kernel to Python 3.6](images/python36.png) -## **Use your own notebook server** +## **Option 2: Use your own notebook server** -Video walkthrough: +### Quick installation +We recommend you create a Python virtual environment ([Miniconda](https://conda.io/miniconda.html) preferred but [virtualenv](https://virtualenv.pypa.io/en/latest/) works too) and install the SDK in it. +```sh +# install just the base SDK +pip install azureml-sdk -[![Get Started video](images/yt_cover.png)](https://youtu.be/VIsXeTuW3FU) +# clone the sample repoistory +git clone https://github.com/Azure/MachineLearningNotebooks.git -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 - ``` +# below steps are optional +# install the base SDK and a Jupyter notebook server +pip install azureml-sdk[notebooks] -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 +# install the data prep component +pip install azureml-dataprep + +# install model explainability component +pip install azureml-sdk[explain] + +# install automated ml components +pip install azureml-sdk[automl] + +# install experimental features (not ready for production use) +pip install azureml-sdk[contrib] +``` + +Note the _extras_ (the keywords inside the square brackets) can be combined. For example: +```sh +# install base SDK, Jupyter notebook and automated ml components +pip install azureml-sdk[notebooks,automl] +``` + +### Full instructions +[Install the Azure Machine Learning SDK](https://docs.microsoft.com/en-us/azure/machine-learning/service/quickstart-create-workspace-with-python) + +Please make sure you start with the [Configuration](configuration.ipynb) notebook to create and connect to a workspace. + + +### Video walkthrough: + +[![Get Started video](images/yt_cover.png)](https://youtu.be/VIsXeTuW3FU) \ No newline at end of file