Model documentation and model cards in MLOps - Mini Project: Build & Apply

Create a Model Card for a Machine Learning Model

📖 Scenario: You are part of a team deploying a machine learning model. To help users and developers understand the model, you need to create a clear and simple model card. This card will document key details about the model, such as its purpose, data used, and limitations.

🎯 Goal: Build a Python dictionary that represents a model card with essential information about a machine learning model. Then, display this model card in a readable format.

📋 What You'll Learn

Create a dictionary named model_card with specific keys and values

Add a configuration variable for the model version

Use a loop to format the model card information

Print the formatted model card details

💡 Why This Matters

🌍 Real World

Model cards help teams and users understand what a machine learning model does, its data, and its limits. This improves trust and responsible use.

💼 Career

Creating and maintaining model documentation is a key skill for MLOps engineers and data scientists to ensure models are transparent and well-managed.

1

Create the initial model card dictionary

Create a dictionary called model_card with these exact entries: 'Model Name': 'Customer Churn Predictor', 'Purpose': 'Predict if a customer will leave the service', 'Training Data': 'Customer usage data from 2020', and 'Limitations': 'May not perform well on new customer segments'.

MLOps

# Create the model_card dictionary with the specified keys and values
# Your code here

Need a hint?

Use curly braces {} to create a dictionary and separate keys and values with colons.

2

Add a model version variable

Create a variable called model_version and set it to the string 'v1.0'.

MLOps

model_card = {
    'Model Name': 'Customer Churn Predictor',
    'Purpose': 'Predict if a customer will leave the service',
    'Training Data': 'Customer usage data from 2020',
    'Limitations': 'May not perform well on new customer segments'
}
# Create the model_version variable and set it to 'v1.0'
# Your code here

Need a hint?

Assign the string 'v1.0' to the variable model_version using the equals sign.

3

Add the version to the model card

Add a new key-value pair to the model_card dictionary with key 'Version' and value from the variable model_version.

MLOps

model_card = {
    'Model Name': 'Customer Churn Predictor',
    'Purpose': 'Predict if a customer will leave the service',
    'Training Data': 'Customer usage data from 2020',
    'Limitations': 'May not perform well on new customer segments'
}
model_version = 'v1.0'
# Add the 'Version' key to model_card with the value model_version
# Your code here

Need a hint?

Use square brackets to add a new key to the dictionary and assign it the value of model_version.

4

Print the model card details

Use a for loop with variables key and value to iterate over model_card.items(). Inside the loop, print each key and value in the format: key: value.

MLOps

model_card = {
    'Model Name': 'Customer Churn Predictor',
    'Purpose': 'Predict if a customer will leave the service',
    'Training Data': 'Customer usage data from 2020',
    'Limitations': 'May not perform well on new customer segments'
}
model_version = 'v1.0'
model_card['Version'] = model_version
# Use a for loop to print each key and value in model_card
# Your code here

Need a hint?

Use a for loop with model_card.items() and print each pair with an f-string.