Skip to content

Commit 13735fe

Browse files
committed
Re-formatting
1 parent de9ad3b commit 13735fe

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/user_guides/mlops/registry/model_evaluation_images.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Documentation on how to attach model evaluation images to a model.
66

77
## Introduction
88

9-
In this guide, you will learn how to attach ==model evaluation images== to a model. Model evaluation images contain **confusion matrices**, **ROC curves** or other graphs that help visualizing model evaluation metrics. By attaching model evaluation images to your model version, other users can better understand the experiment results obtained during model training.
9+
In this guide, you will learn how to attach ==model evaluation images== to a model. Model evaluation images are images that visually describe model performance metrics. For example, **confusion matrices**, **ROC curves**, **model bias tests**, and **training loss curves** are examples of common model evaluation images. By attaching model evaluation images to your versioned model, other users can better understand the model performance and evaluation metrics.
1010

1111
## Code
1212

@@ -21,9 +21,9 @@ project = hopsworks.login()
2121
mr = project.get_model_registry()
2222
```
2323

24-
### Step 2: Generate model evaluation figures
24+
### Step 2: Generate model evaluation images
2525

26-
Generate a figure that visualizes a model metric.
26+
Generate an image that visualizes model performance and evaluation metrics
2727

2828
```python
2929
import seaborn
@@ -53,15 +53,15 @@ fig = heatmap.get_figure()
5353
fig.show()
5454
```
5555

56-
### Step 3: Save the figures as images inside the model directory
56+
### Step 3: Save the figure to a file inside the model directory
5757

58-
Save the figure to an image file, and place it in a directory with name ´images´ inside the model directory to be exported.
58+
Save the figure to a file with a common filename extension (for example, .png or .jpeg), and place it in a directory called `images` - a subdirectory of the model directory that is registered to Hopsworks.
5959

6060
```python
6161
# Specify the directory name for saving the model and related artifacts
6262
model_dir = "./model"
6363

64-
# Create a directory with name 'images' for saving the model evaluation images
64+
# Create a subdirectory of model_dir called 'images' for saving the model evaluation images
6565
model_images_dir = model_dir + "/images"
6666
if not os.path.exists(model_images_dir):
6767
os.mkdir(model_images_dir)
@@ -76,4 +76,4 @@ py_model.save("./model")
7676

7777
## Conclusion
7878

79-
In this guide you learned how to attach model evaluation images to a model, helping better understand the experiment results obtained during model training.
79+
In this guide you learned how to attach model evaluation images to a model, visually communicating the model performance and evaluation metrics in the model registry.

0 commit comments

Comments
 (0)