santiagxf / mlproject-sample

Sample repository about how to structure an ML project using software engineering practices

Structuring an ML project with software engineering practices

The following repository gives a hint and an (opinionated) way to structure a machine learning project using software engineering practices. It tries to marry the benefits of using Jupyter Notebooks along with the good practices of developing code using a Python package. To read more details about the reasons for each choice please read the blog post: Structure your Machine Learning project source code like a pro.

About this sample

This sample repository contains a regression model for predicting the prices of cars from UCI. For details about this problem and the dataset you can check Automobile Data Set. A sample of this dataset is on the folder data/car-prices/sample. The regression model was constructed using an XGBoost with hyperparameters optimization using Scikit-Learn grid search.

Project structure

The project was structured as follows.

├── .aml                                # Azure Machine Learning resources (it's an opinionated choice).
├── .cloud                              # Infrastructure as code resources.
├── docs                                # Project documentation.
├── data                                # Data folder to hold metadata related with the datasets.
│   ├── car-prices                          # Specific to the dataset car-prices
│   │   └── sample                              # A sample of this dataset 
│   └── great_expectations                  # Expectations about how the data should look like.
├── notebooks                           # Notebooks for interactive data analysis or modeling
└── src                                 # Main source of the project
    ├── carpricer                           # Package carpricer with model's source code
    │   ├── dataprep                            # Data preparations code
    │   └── train                               # Training code
    └── tests                               # Unit tests for all the packages in the source code

One model, one repository: This sample repository uses the convention one model = one repo meaning that each repository contains all the resources require to build an specifc model. On those situation where multiple models are involved in a single business problem, then the repository will hold all of them, so don't take the title so literal. This is why the src folder contains one package for each model used; it contains the source code for each of the models used. In this example, only one model is built, which is carpricer.

Running the project

This repository was constructed with portability in mind, so you have a couple of options to run it:

Locally (bash)

Follow this steps:

1. Clone the repository in your local machine.

2. Run setup.sh in a bash console. This will setup your PYTHONPATH by creating a pth file in the user's directory. For more details about why we used this choice read the blog post mentioned in the top. The script will also create a conda environment called carpricer and install all the dependencies.

3. Activate the new conda environment:

   conda activate carpricer

4. MLflow is used for tracking. If you would like to track agaist an specific server, configure the environment variable MLFLOW_TRACKING_URI with you tracking server.

   The project uses MLflow for tracking metrics and logging artifacts. By default, it will use MLflow local storage when running locally and Azure ML when running in the cloud. If you want to configure tracking to happen always in Azure ML, configure the environment variable MLFLOW_TRACKING_URI to point to Azure ML.

5. Run the training by either:

   1. Open the notebook notebooks/carpricer_model.ipynb to train the model in an interactive way.

   2. Alternatively, you can run a training routine from a console (bash) using:

      jobtools carpricer.train.trainer train_regressor --data-path data/car-prices/sample \
                                                       --params src/carpricer.params.yml

Run it on Azure ML

1. Clone the repository in your local machine.

2. Install Azure ML CLI v2. If you don't have it, follow the installation instructions at Install and set up the CLI (v2).

3. Create a compute named trainer-cpu or rename the compute specified in .aml/jobs/carpricer.job.yml.

4. Register the dataset:

   az ml data create -f .aml/data/carprices.yml

5. Create the training job:

   az ml job create -f .aml/jobs/carpricer.job.yml

(Optional)

6. Register the trained model in the registry:

   JOB_NAME=$(az ml job list --query "[0].name" | tr -d '"')
   az ml model create --name "carpricer" \
                      --type "mlflow_model" \
                      --path "azureml://jobs/$JOB_NAME/outputs/artifacts/pipeline"

7. Deploy the model in an online endpoint:

   az ml online-endpoint create -f .aml/endpoints/carpricer-online/endpoint.yml
   az ml online-deployment create -f .aml/endpoints/carpricer-online/deployments/default.yml --all-traffic

Contributing

This project welcomes contributions and suggestions. Open an issue and start the discussion!