From ee97b48070a95c523bcb3d69f484998e10037386 Mon Sep 17 00:00:00 2001 From: Taylor Rockey Date: Tue, 3 Sep 2019 09:08:51 -0700 Subject: [PATCH] Updated spelling in code_description.md --- docs/code_description.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/code_description.md b/docs/code_description.md index ef131408..8ae6774b 100644 --- a/docs/code_description.md +++ b/docs/code_description.md @@ -2,21 +2,21 @@ ### Environment Setup -- `environment_setup/requirements.txt` : It consist of list of python packages which are needed by the train.py to run successfully on host agent (locally). +- `environment_setup/requirements.txt` : It consists of a list of python packages which are needed by the train.py to run successfully on host agent (locally). -- `environment_setup/install_requirements.sh` : This script prepare the python environment i.e. install the Azure ML SDK and the packages specified in requirements.txt +- `environment_setup/install_requirements.sh` : This script prepares the python environment i.e. install the Azure ML SDK and the packages specified in requirements.txt - `environment_setup/iac-*.yml, arm-templates` : Infrastructure as Code piplines to create and delete required resources along with corresponding arm-templates. -- `environment_setup/Dockerfile` : Dockerfile of a building agent containing Python 3.6 and all required packages. +- `environment_setup/Dockerfile` : Dockerfile of a build agent containing Python 3.6 and all required packages. -- `environment_setup/docker-image-pipeline.yml` : An AzDo pipeline building and pushing [microsoft/mlopspython](https://hub.docker.com/_/microsoft-mlops-python) image. +- `environment_setup/docker-image-pipeline.yml` : An AzDo pipeline for building and pushing [microsoft/mlopspython](https://hub.docker.com/_/microsoft-mlops-python) image. ### Pipelines -- `.pipelines/azdo-base-pipeline.yml` : a pipeline template used by ci-build-train pipeline and pr-build-train pipelines. It contains steps performig linting, data and unit testing. -- `.pipelines/azdo-ci-build-train.yml` : a pipeline triggered when the code is merged into **master**. It profrorms linting, data integrity testing, unit testing, building and publishing an ML pipeline. -- `.pipelines/azdo-pr-build-train.yml` : a pipeline triggered when a **pull request** to the **master** branch is created. It profrorms linting, data integrity testing and unit testing only. +- `.pipelines/azdo-base-pipeline.yml` : a pipeline template used by ci-build-train pipeline and pr-build-train pipelines. It contains steps performing linting, data and unit testing. +- `.pipelines/azdo-ci-build-train.yml` : a pipeline triggered when the code is merged into **master**. It performs linting, data integrity testing, unit testing, building and publishing an ML pipeline. +- `.pipelines/azdo-pr-build-train.yml` : a pipeline triggered when a **pull request** to the **master** branch is created. It performs linting, data integrity testing and unit testing only. ### ML Services @@ -28,7 +28,7 @@ - `code/training/train.py` : a training step of an ML training pipeline. - `code/evaluate/evaluate_model.py` : an evaluating step of an ML training pipeline. -- `code/evaluate/register_model.py` : registers a new trained model if evaluation shows the new model is more performent than the previous one. +- `code/evaluate/register_model.py` : registers a new trained model if evaluation shows the new model is more performant than the previous one. ### Scoring - code/scoring/score.py : a scoring script which is about to be packed into a Docker Image along with a model while being deployed to QA/Prod environment.