This scenario shows how to tune a Frequently Asked Questions (FAQ) matching model that can be deployed as a web service to provide predictions for user questions. For this scenario, "Input Data" in the architecture diagram refers to text strings containing the user questions to match with a list of FAQs. The scenario is designed for the Scikit-Learn machine learning library for Python but can be generalized to any scenario that uses Python models to make real-time predictions.
The scenario uses a subset of Stack Overflow question data which includes original questions tagged as JavaScript, their duplicate questions, and their answers. It tunes a Scikit-Learn pipeline to predict the match probability of a duplicate question with each of the original questions. The application flow for this architecture is as follows:
- Create an Azure ML Service workspace.
- Create an Azure ML Compute cluster.
- Upload training, tuning, and testing data to Azure Storage.
- Configure a HyperDrive random hyperparameter search.
- Submit the search.
- Monitor until complete.
- Retrieve the best set of hyperparameters.
- Register the best model.
- Linux (Ubuntu).
- Anaconda Python installed.
- Azure account.
The tutorial was developed on an Azure Ubuntu DSVM, which addresses the first two prerequisites. You can allocate such a VM on Azure Portal by creating a "Data Science Virtual Machine for Linux (Ubuntu)" resource.
To set up your environment to run these notebooks, please follow these steps. They setup the notebooks to use Azure seamlessly.
- Create a Linux Ubuntu VM.
- Log in to your VM. We recommend that you use a graphical client such as X2Go to access your VM. The remaining steps are to be done on the VM.
- Open a terminal emulator.
- Clone, fork, or download the zip file for this repository:
git clone https://github.com/Microsoft/MLHyperparameterTuning.git
- Enter the local repository:
cd MLHyperparameterTuning
- Create the Python MLHyperparameterTuning virtual environment using the environment.yml:
conda env create -f environment.yml
- Activate the virtual environment:
The remaining steps should be done in this virtual environment.
source activate MLHyperparameterTuning
- Login to Azure:
You can verify that you are logged in to your subscription by executing the command:
az login
az account show -o table
- If you have more than one Azure subscription, select it:
az account set --subscription <Your Azure Subscription>
- Start the Jupyter notebook server:
jupyter notebook
After following the setup instructions above, run the Jupyter notebooks in order starting with 00_Data_Prep_Notebook.ipynb.
The last Jupyter notebook describes how to delete the Azure resources created for running the tutorial. Consult the conda documentation for information on how to remove the conda environment created during the setup. And if you created a VM, you may also delete it.
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.
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. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.