Model registry in ML Python

Introduction

A model registry helps you keep track of different versions of your machine learning models in one place.

When you want to save and organize models during development.

When you need to share models with your team easily.

When you want to deploy the best model version to production.

When you want to compare model versions and their performance.

When you want to keep a history of model changes for future reference.

Syntax

ML Python

register_model(model, name, version=None, description=None)

# model: the trained ML model object
# name: a string to identify the model
# version: optional version number or string
# description: optional text about the model

The register_model function saves your model with a name and optional version.

Descriptions help explain what the model does or its changes.

Examples

Save the model with the name 'house_price_predictor' without specifying a version.

ML Python

register_model(my_model, 'house_price_predictor')

Save the model with a version label 'v1' to track this specific version.

ML Python

register_model(my_model, 'house_price_predictor', version='v1')

Add a description to explain what data or changes this model has.

ML Python

register_model(my_model, 'house_price_predictor', description='Model trained on 2024 data')

Sample Model

This code trains a simple linear regression model, saves it in a basic model registry, then loads it back to make predictions and calculate error.

ML Python

from sklearn.linear_model import LinearRegression
from sklearn.datasets import make_regression
from sklearn.model_selection import train_test_split
from sklearn.metrics import mean_squared_error

# Simple model registry as a dictionary
model_registry = {}

def register_model(model, name, version=None, description=None):
    key = f"{name}:{version}" if version else name
    model_registry[key] = {'model': model, 'description': description}
    print(f"Model '{key}' registered.")

def get_model(name, version=None):
    key = f"{name}:{version}" if version else name
    return model_registry.get(key, {}).get('model')

# Create sample data
X, y = make_regression(n_samples=100, n_features=1, noise=10, random_state=42)
X_train, X_test, y_train, y_test = train_test_split(X, y, random_state=42)

# Train a simple linear regression model
model = LinearRegression()
model.fit(X_train, y_train)

# Register the model
register_model(model, 'simple_linear', version='v1', description='Linear regression on synthetic data')

# Retrieve the model and predict
loaded_model = get_model('simple_linear', version='v1')
predictions = loaded_model.predict(X_test)

# Calculate and print mean squared error
mse = mean_squared_error(y_test, predictions)
print(f"Mean Squared Error: {mse:.2f}")

Important Notes

A model registry can be a simple dictionary or a full system like MLflow or SageMaker.

Always include versioning to avoid confusion between models.

Descriptions help your team understand model differences quickly.

Summary

A model registry stores and organizes your machine learning models.

It helps track versions, share models, and deploy the best one.

Even a simple dictionary can work as a basic model registry.

Practice

1.

What is the main purpose of a model registry in machine learning?

easy

A. To store and organize machine learning models

B. To train machine learning models faster

C. To clean and prepare data for training

D. To visualize model predictions

Solution

1. Step 1: Understand the role of a model registry

   A model registry is designed to keep track of machine learning models, their versions, and metadata.

2. Step 2: Compare options with the definition

   Only To store and organize machine learning models describes storing and organizing models, which matches the main purpose of a model registry.

3. Final Answer:

   To store and organize machine learning models -> Option A

4. Quick Check:

   Model registry = store and organize models [OK]

Hint: Model registry = place to keep models safe and sorted [OK]

Common Mistakes:

• Confusing model registry with data cleaning
• Thinking it speeds up training
• Mixing it with visualization tools

2.

Which of the following is the correct way to add a model to a simple Python dictionary used as a model registry?

model_registry = {}
# Add model here

easy

A. model_registry['model_v1'] = trained_model

B. model_registry.add('model_v1', trained_model)

C. model_registry.append('model_v1', trained_model)

D. model_registry.insert('model_v1', trained_model)

Solution

1. Step 1: Recall how to add key-value pairs to a dictionary

   In Python, adding an item to a dictionary uses the syntax dict[key] = value.

2. Step 2: Check each option for correct dictionary syntax

   The incorrect options use methods like .add(), .append(), and .insert() which are not available for dictionaries. Only model_registry['model_v1'] = trained_model uses the correct assignment syntax.

3. Final Answer:

   model_registry['model_v1'] = trained_model -> Option A

4. Quick Check:

   Dictionary add = dict[key] = value [OK]

Hint: Use dict[key] = value to add items in Python [OK]

Common Mistakes:

• Using list methods like append on dictionaries
• Trying to call add or insert on dict
• Confusing dictionary with list syntax

3.

Given the following code, what will be the output?

model_registry = {}
model_registry['v1'] = {'accuracy': 0.8}
model_registry['v2'] = {'accuracy': 0.85}
print(model_registry['v2']['accuracy'])

medium

A. 0.8

B. 0.85

C. {'accuracy': 0.85}

D. KeyError

Solution

1. Step 1: Understand the dictionary structure

   model_registry has keys 'v1' and 'v2', each storing a dictionary with an 'accuracy' key.

2. Step 2: Access the nested value

   model_registry['v2']['accuracy'] accesses the accuracy value for version 'v2', which is 0.85.

3. Final Answer:

   0.85 -> Option B

4. Quick Check:

   Access nested dict value = 0.85 [OK]

Hint: Access nested dict with dict[key1][key2] [OK]

Common Mistakes:

• Confusing keys and values
• Expecting full dict instead of value
• Mistyping keys causing KeyError

4.

Identify the error in this code snippet that tries to update a model's accuracy in a registry:

model_registry = {'v1': {'accuracy': 0.8}}
model_registry.update('v1', {'accuracy': 0.85})

medium

A. Syntax error due to missing colon

B. update cannot update nested dictionaries

C. The key 'v1' does not exist in the dictionary

D. update method expects a dictionary, not two arguments

Solution

1. Step 1: Check the usage of dictionary update method

   The update() method takes a single dictionary or iterable of key-value pairs, not separate arguments.

2. Step 2: Identify the correct way to update nested dictionary

   To update nested dict, access it first: model_registry['v1'].update({'accuracy': 0.85}).

3. Final Answer:

   update method expects a dictionary, not two arguments -> Option D

4. Quick Check:

   dict.update() needs one dict argument [OK]

Hint: dict.update() takes one dict, not multiple args [OK]

Common Mistakes:

• Passing multiple arguments to update()
• Trying to update nested dict without accessing it
• Assuming update() works like assignment

5.

You want to keep track of multiple versions of a model with their accuracy and deployment status. Which data structure best suits a simple model registry in Python?

hard

A. A set of model names without details

B. A list of tuples with version and accuracy only

C. A dictionary with version keys and nested dictionaries for metrics and status

D. A single string describing the latest model

Solution

1. Step 1: Identify the need for storing multiple details per version

   You need to store version keys, accuracy, and deployment status, which requires nested information.

2. Step 2: Evaluate data structures for this need

   A dictionary with version keys and nested dictionaries for details fits best. Lists or sets lack easy key-based access or nested info.

3. Final Answer:

   A dictionary with version keys and nested dictionaries for metrics and status -> Option C

4. Quick Check:

   Nested dicts store complex model info best [OK]

Hint: Use nested dicts for versions and details [OK]

Common Mistakes:

• Using lists or sets that lack keys
• Storing only one detail per model
• Using strings that can't hold structured data