Skip to content

Commit 1249e6b

Browse files
committed
doc: correct readme initial commit
1 parent cbc8a27 commit 1249e6b

File tree

1 file changed

+45
-67
lines changed

1 file changed

+45
-67
lines changed

README.md

Lines changed: 45 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,74 @@
1-
### Author: Praneet Singh Solanki
1+
### Author: | Praneet Singh Solanki | Richin Jain |
22

33
# DevOps For AI
44

55
[![Build Status](https://dev.azure.com/customai/DevopsForAI-AML/_apis/build/status/Microsoft.DevOpsForAI?branchName=master)](https://dev.azure.com/customai/DevopsForAI-AML/_build/latest?definitionId=1&branchName=master)
66

7-
[DevOps for AI template](https://azuredevopsdemogenerator.azurewebsites.net/?name=azure%20machine%20learning) will help you to understand how to build the Continuous Integration and Continuous Delivery pipeline for a ML/AI project. We will be using the Azure DevOps Project for build and release pipelines along with Azure ML services for ML/AI model management and operationalization.
7+
8+
9+
DevOps for AI will help you to understand how to build the Continuous Integration and Continuous Delivery pipeline for a ML/AI project. We will be using the Azure DevOps Project for build and release/deployment pipelines along with Azure ML services for model retraining pipeline, model management and operationalization.
810

911
This template contains code and pipeline definition for a machine learning project demonstrating how to automate the end to end ML/AI project. The build pipelines include DevOps tasks for data sanity test, unit test, model training on different compute targets, model version management, model evaluation/model selection, model deployment as realtime web service, staged deployment to QA/prod, integration testing and functional testing.
1012

13+
1114
## Prerequisite
1215
- Active Azure subscription
13-
- Minimum contributor access to Azure subscription
16+
- At least contributor access to Azure subscription
1417

1518
## Getting Started:
16-
17-
### Import the DevOps for AI solution template from Azure DevOps Demo Generator: [Click here](https://azuredevopsdemogenerator.azurewebsites.net/?name=azure%20machine%20learning)
18-
1919
Skip above step if already done.
2020

2121
Once the template is imported for personal Azure DevOps account using DevOps demo generator, you need to follow below steps to get the pipeline running:
2222

23-
### Update Pipeline Config:
24-
25-
#### Build Pipeline
26-
1. Go to the **Pipelines -> Builds** on the newly created project and click **Edit** on top right
27-
![EditPipeline1](/docs/images/EditPipeline1.png)
28-
2. Click on **Create or Get Workspace** task, select the Azure subscription where you want to deploy and run the solution, and click **Authorize**
29-
![EditPipeline2](/docs/images/EditPipeline2.png)
30-
3. Click all other tasks below it and select the same subscription (no need to authorize again)
31-
4. Once the tasks are updated with subscription, click on **Save & queue** and select **Save**
32-
![EditPipeline3](/docs/images/EditPipeline3.png)
33-
34-
#### Release Pipeline
35-
1. Go to the **Pipelines -> Releases** and click **Edit** on top
36-
![EditPipeline4](/docs/images/EditPipeline4.png)
37-
2. Click on **1 job, 4 tasks** to open the tasks in **QA stage**
38-
![EditPipeline5](/docs/images/EditPipeline5.png)
39-
3. Update the subscription details in two tasks
40-
![EditPipeline6](/docs/images/EditPipeline6.png)
41-
4. Click on **Tasks** on the top to switch to the Prod stage, update the subscription details for the two tasks in prod
42-
![EditPipeline7](/docs/images/EditPipeline7.png)
43-
5. Once you fix all the missing subscription, the **Save** is no longer grayed, click on save to save the changes in release pepeline
44-
![EditPipeline8](/docs/images/EditPipeline8.png)
45-
46-
### Update Repo config:
47-
1. Go to the **Repos** on the newly created Azure DevOps project
48-
2. Open the config file [/aml_config/config.json](/aml_config/config.json) and edit it
49-
3. Put your Azure subscription ID in place of <>
50-
4. Change resource group and AML workspace name if you want
51-
5. Put the location where you want to deploy your Azure ML service workspace
52-
6. Save the changes and commit these changes to master branch
53-
7. The commit will trigger the build pipeline to run deploying AML end to end solution
54-
8. Go to **Pipelines -> Builds** to see the pipeline run
55-
56-
## Steps Performed in the Build Pipeline:
57-
58-
1. Prepare the python environment
59-
2. Get or Create the workspace
60-
3. Submit Training job on the remote DSVM / Local Python Env
61-
4. Register model to workspace
62-
5. Create Docker Image for Scoring Webservice
63-
6. Copy and Publish the Artifacts to Release Pipeline
64-
65-
## Steps Performed in the Release Pipeline
66-
In Release pipeline we deploy the image created from the build pipeline to Azure Container Instance and Azure Kubernetes Services
67-
68-
### Deploy on ACI - QA Stage
69-
1. Prepare the python environment
70-
2. Create ACI and Deploy webservice image created in Build Pipeline
71-
3. Test the scoring image
72-
73-
### Deploy on AKS - PreProd/Prod Stage
74-
1. Prepare the python environment
75-
2. Deploy on AKS
76-
- Create AKS and create a new webservice on AKS with the scoring docker image
77-
78-
OR
79-
80-
- Get the existing AKS and update the webservice with new image created in Build Pipeline
81-
3. Test the scoring image
23+
24+
25+
## Architecture Diagram
26+
27+
This reference architecture shows how to implement continuous integration (CI), continuous delivery (CD), and retraining pipeline for an AI application using Azure DevOps and Azure Machine Learning. The solution is built on the scikit-learn diabetes dataset but can be easily adapted for any AI scenario and other popular build systems such as Jenkins and Travis.
28+
29+
![Architecture](as/docs/images/Architecture_DevOps_AI.png)
30+
31+
32+
## Architecture Flow
33+
34+
1. Data Scientist writes/updates the code and push it to git repo. This triggers the Azure DevOps build pipeline (contineous integration).
35+
2. Once the Azure DevOps build pipeline is triggered, it runs following type of tasks:
36+
- Run for new code: Everytime new code is commited to the repo, build pipeline performs data sanity test and unit tests the new code.
37+
38+
- One-time run: These tasks runs only for the first time build pipeline run, they create [Azure ML Service Workspace](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-azure-machine-learning-architecture#workspace), [Azure ML Compute](https://docs.microsoft.com/en-us/azure/machine-learning/service/how-to-set-up-training-targets#amlcompute) used as model training compute and publish a [Azure ML Pipeline](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-ml-pipelines) with code. This published Azure ML pipeline is the model training/retraining pipeline.
39+
40+
`Note: The task Publish Azure ML pipeline currently runs for every code change`
41+
42+
3. The Azure ML Retraining pipeline is triggered once the Azure DevOps build pipeline completes. All the tasks in this pipeline runs on Azure ML Compute created earlier. Following are the tasks in this pipeline:
43+
44+
- **Train Model** task executes model training script on Azure ML Compute. It outputs a [model](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-azure-machine-learning-architecture#model) file which is stored in the [run history](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-azure-machine-learning-architecture#run)
45+
46+
- **Evaluate Model** task evaluates the performance of newly trained model with the model in production. If new trained model performs better than the production model, next steps are executed. Else next steps are skipped.
47+
48+
- **Register Model** task takes the new trained better performing model and registers it with the [Azure ML Model registry](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-azure-machine-learning-architecture#model-registry) to version control it.
49+
50+
- **Package Model** task packages the new trained model along with scoring file and python dependencies into a docker [image](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-azure-machine-learning-architecture#image) and pushes it to [Azure Container Registry](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-intro). This image is used to deploy model as [web service](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-azure-machine-learning-architecture#web-service).
51+
52+
4. Once a new model scoring image is pushed to Azure Container Registry, Azure DevOps Release/Deployment pipeline is triggered. This pipeline deploys the model scoring image into Staging/QA and PROD environments.
53+
54+
- In the Staging/QA, one task creates [Azure Container Instance](https://docs.microsoft.com/en-us/azure/container-instances/container-instances-overview) and deploy scoring image as [web service](https://docs.microsoft.com/en-us/azure/machine-learning/service/concept-azure-machine-learning-architecture#web-service) on it.
55+
56+
- The second task test this web service by calling its REST endpoint with dummy data.
57+
58+
59+
5.
8260

8361
### Repo Details
8462

85-
You can find the details of the code ans scripts in the repository [here](/docs/code_description.md)
63+
You can find the details of the code and scripts in the repository [here](/docs/code_description.md)
8664

8765
### References
88-
8966
- [Azure Machine Learning(Azure ML) Service Workspace](https://docs.microsoft.com/en-us/azure/machine-learning/service/overview-what-is-azure-ml)
9067

9168
- [Azure ML Samples](https://docs.microsoft.com/en-us/azure/machine-learning/service/samples-notebooks)
9269
- [Azure ML Python SDK Quickstart](https://docs.microsoft.com/en-us/azure/machine-learning/service/quickstart-create-workspace-with-python)
9370
- [Azure DevOps](https://docs.microsoft.com/en-us/azure/devops/?view=vsts)
71+
- [DevOps for AI template (Old Version)](https://azuredevopsdemogenerator.azurewebsites.net/?name=azure%20machine%20learning)
9472

9573
# Contributing
9674

0 commit comments

Comments
 (0)