diff --git a/examples/MLOps_GitHubActions/README.md b/examples/MLOps_GitHubActions/README.md index 3305c26..3606a10 100644 --- a/examples/MLOps_GitHubActions/README.md +++ b/examples/MLOps_GitHubActions/README.md @@ -1,24 +1,23 @@ -# MLOps with GitHub Actions and Event Grid +# MLOps with GitHub Actions and Event Grid -This example shows you how to use Azure Machine Learning, GitHub Actions and Event Grid to create a CI/CD flow. The intent of this project is to provide references on how you can implement this withyour own projects. +This example shows you how to use Azure Machine Learning, GitHub Actions and Event Grid to create a CI/CD flow. The intent of this project is to provide references on how you can implement this with your own projects. -# Preqrequisites +# Prerequisites -It's reccomended that you have a basic understanding of Azure Machine Learning, Event Grid and GitHub Actions. Make sure you have at least contributor access to an Azure Machine Learning workspace. Here are some features and concepts the repo will be using: - -* [MLOps on Azure Machine Learning](https://docs.microsoft.com/en-us/azure/machine-learning/concept-model-management-and-deployment) -* [Azure Machine Learning Pipelines](https://docs.microsoft.com/en-us/azure/machine-learning/concept-ml-pipelines) -* [Azure Event Grid integration with Azure Machine Learning](https://docs.microsoft.com/en-us/azure/machine-learning/how-to-use-event-grid) +It's recommended that you have a basic understanding of Azure Machine Learning, Event Grid and GitHub Actions. Make sure you have at least contributor access to an Azure Machine Learning workspace. Here are some features and concepts the repo will be using: +- [MLOps on Azure Machine Learning](https://docs.microsoft.com/en-us/azure/machine-learning/concept-model-management-and-deployment) +- [Azure Machine Learning Pipelines](https://docs.microsoft.com/en-us/azure/machine-learning/concept-ml-pipelines) +- [Azure Event Grid integration with Azure Machine Learning](https://docs.microsoft.com/en-us/azure/machine-learning/how-to-use-event-grid) # Content -You can start with either folder. In order to run this project end to end complete the set up from both folders. +You can start with either folder. In order to run this project end to end, complete the set up from both folders. ## Code -This folder contains example code to build an image classifaction model to distinguish betweens tacos and burritos. You can replace any of the training code with your own. Additionally this folder also porvides a build and deploy yaml in the subfolder **workflows** that you will trigger as actions. +This folder contains example code to build an image classifaction model to distinguish betweens tacos and burritos. You can replace any of the training code with your own. Additionally this folder also provides a build and deploy yaml in the subfolder **workflows** that you will trigger as actions. -## Azure Function +## Azure Function -This folder contains code for a simple Azure function that gets trigger by a model registration event (via event grid). This is important when automating continuous model deployment. +This folder contains code for a simple Azure function that gets triggered by a model registration event (via event grid). This is important when automating continuous model deployment.