Skip to content

Commit 4b998f4

Browse files
committed
update readmes
1 parent 275cd4e commit 4b998f4

File tree

4 files changed

+45
-30
lines changed

4 files changed

+45
-30
lines changed

README.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,34 @@
11
# Azure Machine Learning service sample notebooks
22

3-
Use either of these methods to run the notebooks in this repository:
4-
5-
* **Azure Notebooks** - Jupyter based notebooks in the Azure cloud
6-
1. [![Azure Notebooks](https://notebooks.azure.com/launch.png)](https://aka.ms/aml-clone-azure-notebooks)
7-
[Import sample notebooks into Azure Notebooks](https://aka.ms/aml-clone-azure-notebooks).
8-
1. Create a workspace and its configuration file (**config.json**) using [these instructions](https://aka.ms/aml-how-to-configure-environment).
9-
1. Select `+New` in the toolbar to add your **config.json** file to the same folder as the notebook.
10-
1. Open the notebook.
11-
12-
* **Your own notebook server**
13-
14-
> Note: **Looking for automated machine learning samples?**
15-
> For your convenience, you can use a script to install instead. Go to the [automl folder README](automl/readme.md) and follow the instructions.
16-
17-
1. Use [these instructions](https://aka.ms/aml-how-to-configure-environment) to:
18-
* Create a workspace and its configuration file (**config.json**).
19-
* Configure your notebook server.
20-
1. Clone this repository.
21-
1. Add your **config.json** file to the cloned folder - you may need to install other packages for specific notebooks.
22-
1. Start your notebook server.
23-
1. Open the notebook you want to run.
3+
To run the notebooks in this repository use one of these methods:
4+
5+
## Use Azure Notebooks - Jupyter based notebooks in the Azure cloud
6+
7+
1. [![Azure Notebooks](https://notebooks.azure.com/launch.png)](https://aka.ms/aml-clone-azure-notebooks)
8+
[Import sample notebooks ](https://aka.ms/aml-clone-azure-notebooks) into Azure Notebooks if they are not already there.
9+
1. Create a workspace and its configuration file (**config.json**) using [these instructions](https://aka.ms/aml-how-to-configure-environment).
10+
1. Select `+New` in the Azure Notebook toolbar to add your **config.json** file to the imported folder.
11+
![upload config file to notebook folder](images/additems.png)
12+
1. Open the notebook.
13+
14+
**Make sure the Azure Notebook kernal is set to `Python 3.6`** when you open a notebook.
15+
16+
![set kernal to Python 3.6](images/python36.png)
17+
18+
19+
## **Use your own notebook server**
20+
21+
1. Use [these instructions](https://aka.ms/aml-how-to-configure-environment) to:
22+
* Create a workspace and its configuration file (**config.json**).
23+
* Configure your notebook server.
24+
1. Clone [this repository](https://aka.ms/aml-notebooks).
25+
1. Add your **config.json** file to the cloned folder
26+
1. You may need to install other packages for specific notebooks
27+
1. Start your notebook server.
28+
1. Open the notebook you want to run.
29+
30+
> Note: **Looking for automated machine learning samples?**
31+
> 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.
2432
2533
# Contributing
2634

automl/README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,34 @@
11
# Table of Contents
2-
1. [Auto ML Introduction](#introduction)
2+
1. [Automated ML Introduction](#introduction)
33
2. [Running samples in a Local Conda environment](#localconda)
44
3. [Auto ML SDK Sample Notebooks](#samples)
55
4. [Documentation](#documentation)
66
5. [Running using python command](#pythoncommand)
77
6. [Troubleshooting](#troubleshooting)
88

9-
# Automated machine learning introduction <a name="introduction"></a>
9+
# Automated ML introduction <a name="introduction"></a>
1010
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.
1111

1212
If you are new to Data Science, automated ML 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.
1313

1414
If you are an experienced data scientist, automated ML 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. automated ML 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.
1515

16+
## Running samples in Azure Notebooks - Jupyter based notebooks in the Azure cloud
1617

17-
# Running samples in a Local Conda environment <a name="localconda"></a>
18+
1. [![Azure Notebooks](https://notebooks.azure.com/launch.png)](https://aka.ms/aml-clone-azure-notebooks)
19+
[Import sample notebooks ](https://aka.ms/aml-clone-azure-notebooks) into Azure Notebooks if they are not already there.
20+
1. Create a workspace and its configuration file (**config.json**) using [these instructions](https://aka.ms/aml-how-to-configure-environment).
21+
1. Select `+New` in the Azure Notebook toolbar to add your **config.json** file to the imported folder.
22+
![upload config file to notebook folder](../images/additems.png)
23+
1. Open the notebook.
24+
25+
**Make sure the Azure Notebook kernal is set to `Python 3.6`** when you open a notebook.
26+
27+
![set kernal to Python 3.6](../images/python36.png)
1828

19-
You can run these notebooks in Azure Notebooks without any extra installation. To run these notebook on your own notebook server, use these installation instructions.
29+
## Running samples in a Local Conda environment <a name="localconda"></a>
30+
31+
To run these notebook on your own notebook server, use these installation instructions.
2032

2133
It is best if you create a new conda environment locally to try this SDK, so it doesn't mess up with your existing Python environment.
2234

@@ -143,11 +155,6 @@ automl_setup_linux.sh
143155
- [13.auto-ml-dataprep.ipynb](13.auto-ml-dataprep.ipynb)
144156
- Using DataPrep for reading data
145157

146-
- [14a.auto-ml-classification-ensemble.ipynb](14a.auto-ml-classification-ensemble.ipynb)
147-
- Classification with ensembling
148-
149-
- [14b.auto-ml-regression-ensemble.ipynb](14b.auto-ml-regression-ensemble.ipynb)
150-
- Regression with ensembling
151158

152159
# Documentation <a name="documentation"></a>
153160
## Table of Contents

images/additems.png

18.6 KB
Loading

images/python36.png

10.4 KB
Loading

0 commit comments

Comments
 (0)