recallMetric

Deep learning recall metric

Since R2023b

Description

Use a RecallMetric object to track the recall when you train a deep neural network.

To specify which metrics to use during training, specify the Metrics option of the trainingOptions function. You can use this option only when you train a network using the trainnet function.

To plot the metrics during training, in the training options, specify Plots as "training-progress". If you specify the ValidationData training option, then the software also plots and records the metric values for the validation data. To output the metric values to the Command Window during training, in the training options, set Verbose to true.

You can also access the metrics after training using the TrainingHistory and ValidationHistory fields from the second output of the trainnet function.

Creation

Syntax

metric = recallMetric

metric = recallMetric(Name=Value)

Description

metric = recallMetric creates a RecallMetric object. You can then specify metric as the Metrics name-value argument in the trainingOptions function. This metric is valid only for classification tasks.

With no additional options specified, this syntax is equivalent to setting Metrics="recall" in the training options.

metric = recallMetric(Name=Value) sets the Name, NetworkOutput, AverageType, and ClassificationMode properties using name-value arguments.

Properties

Name — Metric name

"Recall" (default) | string scalar | character vector

Metric name, specified as a string scalar or character vector. The metric name appears in the training plot, the verbose output, and the training information that you can access as the second output of the trainnet function.

Data Types: char | string

NetworkOutput — Name of layer to apply metric to

[] (default) | string scalar | character vector

This property is read-only.

Name of the layer to apply the metric to, specified as [], a string scalar, or a character vector. When the value is [], the software passes all of the network outputs to the metric.

Note

You can apply the built-in metric to only a single output. If you have a network with multiple outputs, then you must specify the NetworkOutput name-value argument. To apply built-in metrics to multiple outputs, you must create a metric object for each output.

Data Types: char | string

AverageType — Type of averaging to use

"macro" (default) | "micro" | "weighted"

This property is read-only.

Type of averaging to use to compute the metric, specified as one of these values:

• "micro" — Calculate the metric across all classes.

• "macro" — Calculate the metric for each class and return the average.

• "weighted" — Calculate the metric for each class and return the weighted average. The weight for a class is the proportion of observations from that class.

For more information, see Averaging Type.

Data Types: char | string

ClassificationMode — Type of classification task

"single-label" (default) | "multilabel"

This property is read-only.

Type of classification task, specified as one of these values:

• "single-label" — Each observation is exclusively assigned one class label (single-label classification).

• "multilabel" — Each observation can be assigned more than one independent class label (multilabel classification). The software uses a softmax threshold of 0.5 to assign class labels.

To select the classification mode for binary classification, consider the final layer of the network:

• If the final layer has an output size of one, such as with a sigmoid layer, use "multilabel".

• If the final layer has an output size of two, such as with a softmax layer, use "single-label".

Note

This metric is not supported when the ClassificationMode is set to "single-label" and the network output has a channel dimension of size 1. For example, if you have a single class and the output is a sigmoidLayer object (binary-sigmoid task).

Data Types: char | string

Maximize — Flag to maximize metric

1 (true)

This property is read-only.

Flag to maximize metric, specified as 1 (true) if the optimal value for the metric occurs when the metric is maximized.

For this metric, the Maximize value is always set to 1 (true).

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Object Functions

trainingOptions	Options for training deep learning neural network
trainnet	Train deep learning neural network

Examples

Plot and Record Recall During Training

Plot and record the training and validation recall when you train a deep neural network.

Unzip the digit sample data and create an image datastore. The imageDatastore function automatically labels the images based on folder names.

unzip("DigitsData.zip")
imds = imageDatastore("DigitsData", ...
    IncludeSubfolders=true, ...
    LabelSource="foldernames");

The datastore contains 10,000 synthetic images of digits from 0 to 9. Each image in the data set has a size of 28-by-28-by-1 pixels. You can train a deep learning network to classify the digit in the image.

Use a subset of the data as the validation set.

numTrainingFiles = 750;
[imdsTrain,imdsVal] = splitEachLabel(imds,numTrainingFiles,"randomize");

Create an image classification network.

layers = [ ...
    imageInputLayer([28 28 1])
    convolution2dLayer(5,20)
    reluLayer
    maxPooling2dLayer(2,Stride=2)
    fullyConnectedLayer(10)
    softmaxLayer];

Create a RecallMetric object and set AverageType to "macro". You can use this object to record and plot the training and validation recall.

metric = recallMetric(AverageType="macro")

metric = 
  RecallMetric with properties:

                  Name: "Recall"
           AverageType: "macro"
    ClassificationMode: "single-label"
         NetworkOutput: []
              Maximize: 1

Specify the recall metric in the training options. To plot the recall during training, set Plots to "training-progress". To output the values during training, set Verbose to true.

options = trainingOptions("adam", ...
    MaxEpochs=5, ...
    Metrics=metric, ...
    ValidationData=imdsVal, ...
    ValidationFrequency=50, ...
    Plots="training-progress", ...
    Verbose=true);

Train the network using the trainnet function.

[net,info] = trainnet(imdsTrain,layers,"crossentropy",options);

    Iteration    Epoch    TimeElapsed    LearnRate    TrainingLoss    ValidationLoss    TrainingRecall    ValidationRecall
    _________    _____    ___________    _________    ____________    ______________    ______________    ________________
            0        0       00:00:02        0.001                            13.488                                0.0984
            1        1       00:00:02        0.001          13.974                            0.072727                    
           50        1       00:00:18        0.001          2.7423            2.7443           0.67098                0.65
          100        2       00:00:30        0.001          1.2964              1.22           0.73746              0.7896
          150        3       00:00:43        0.001         0.65054           0.80056           0.86382              0.8392
          200        4       00:00:56        0.001         0.19025           0.53178           0.94948              0.8904
          250        5       00:01:10        0.001         0.15676           0.49591            0.9506              0.8908
          290        5       00:01:20        0.001         0.27693           0.40591           0.94689              0.9104
Training stopped: Max epochs completed

Access the loss and recall values for the validation data.

info.ValidationHistory

ans=7×3 table
    Iteration     Loss      Recall
    _________    _______    ______

         0        13.488    0.0984
        50        2.7443      0.65
       100          1.22    0.7896
       150       0.80056    0.8392
       200       0.53178    0.8904
       250       0.49591    0.8908
       290       0.40591    0.9104

More About

Averaging Type

When you compute a metric, you can aggregate the results into a single value in several ways.

• Micro average — Combine contributions of all observations from each class. For example, calculate the true positive (TP), false positive (FP), true negative (TN), and false negative (FN) across all K classes and then compute the metric.

• Macro average — Calculate the metric for each class and then take the average across all the classes. For example, use the true positive rate for just those observations in class i (TP_i).

• Weighted average — Calculate the metric for each class and then take the weighted average.

Micro Average	Macro Average	Weighted Average
$$\text{Recall = }\frac{TP}{TP+FN}$$	$$\text{Recall}={\displaystyle \sum _{i=1}^K{w}_i\frac{T{P}_i}{T{P}_i+F{N}_i}}$$	$$\text{Recall}={\displaystyle \sum _{i=1}^K{w}_i\frac{T{P}_i}{T{P}_i+F{N}_i}}$$

The weight w_i controls the weighting for each class in macro and weighted averaging according to these formulas.

• Macro — $$w_i=\frac{1}{K}$$

• Weighted — $$w_i=\frac{n_i}{n}$$, where n_i is the number of observations in class i and n is the total number of observations.

Version History

Introduced in R2023b