Skip to content

Commit e856a4f

Browse files
authored
Getting started refactor (#216)
To address feedback about some confusion when following the guide (especially to do with service connections) I have refactored the document structure. - Optional tasks / extra info has been moved down to either 'Further Exploration' (directly for getting started) or 'Next Steps' (specifically for integrating ML code.) - Grammar fixes and simplified wording in parts - Removed manual word wrapping to let autoformat do its thing - Added a table of contents - Update ARM service connection screenshot. Fixes #215 - Replace some outdated guide images. Fixes #210
1 parent 466800e commit e856a4f

7 files changed

+176
-183
lines changed

bootstrap/README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bootstrap from MLOpsPython repository
22

3-
To use this existing project structure and scripts for your new ML project, you can quickly get started from the existing repository, bootstrap and create a template that works for your ML project. Bootstrapping will prepare a similar directory structure for your project which includes renaming files and folders, deleting and cleaning up some directories and fixing imports and absolute path based on your project name. This will enable reusing various resources like pre-built pipelines and scripts for your new project.
3+
To use this existing project structure and scripts for your new ML project, you can quickly get started from the existing repository, bootstrap and create a template that works for your ML project. Bootstrapping will prepare a similar directory structure for your project which includes renaming files and folders, deleting and cleaning up some directories and fixing imports and absolute path based on your project name. This will enable reusing various resources like pre-built pipelines and scripts for your new project.
44

55
## Generating the project structure
66

@@ -10,14 +10,19 @@ To bootstrap from the existing MLOpsPython repository clone this repository, ens
1010

1111
Where `[dirpath]` is the absolute path to the root of your directory where MLOps repo is cloned and `[projectname]` is the name of your ML project.
1212

13-
The script renames folders, files and files' content from the base project name `diabetes` to your project name. However, you might need to manually rename variables defined in a variable group and their values.
13+
The script renames folders, files and files' content from the base project name `diabetes` to your project name. However, you might need to manually rename variables defined in a variable group and their values.
1414

1515
[This article](https://docs.microsoft.com/azure/machine-learning/tutorial-convert-ml-experiment-to-production#use-your-own-model-with-mlopspython-code-template) will also assist to use this code template for your own ML project.
1616

17+
### Using an existing dataset
18+
19+
The training ML pipeline uses a [sample diabetes dataset](https://scikit-learn.org/stable/modules/generated/sklearn.datasets.load_diabetes.html) as training data. To use your own data, you need to [create a Dataset](https://docs.microsoft.com/azure/machine-learning/how-to-create-register-datasets) in your workspace and add a DATASET_NAME variable in the ***devopsforai-aml-vg*** variable group with the Dataset name. You'll also need to modify the test cases in the **ml_service/util/smoke_test_scoring_service.py** script to match the schema of the training features in your dataset.
20+
1721
## Customizing the CI and AML environments
1822

1923
In your project you will want to customize your own Docker image and Conda environment to use only the dependencies and tools required for your use case. This requires you to edit the following environment definition files:
24+
2025
- The Azure ML training and scoring Conda environment defined in [conda_dependencies.yml](diabetes_regression/conda_dependencies.yml).
2126
- The CI Docker image and Conda environment used by the Azure DevOps build agent. See [instructions for customizing the Azure DevOps job container](../docs/custom_container.md).
2227

23-
You will want to synchronize dependency versions as appropriate between both environment definitions (for example, ML libraries used both in training and in unit tests).
28+
You will want to synchronize dependency versions as appropriate between both environment definitions (for example, ML libraries used both in training and in unit tests).

0 commit comments

Comments
 (0)