Main Content

groupSubPlot

Group metrics in experiment training plot

Since R2021a

collapse all in page

    Syntax

    groupSubPlot(monitor,groupName,metricNames)

    Description

    groupSubPlot(monitor,groupName,metricNames) groups the specified metrics in a single training subplot with the y-axis label groupName. By default, Experiment Manager plots each ungrouped metric in its own training subplot.

    To group metrics, all metrics must have the same y-axis scale. For more information, see yscale.

    example

    Examples

    collapse all

    Use an experiments.Monitor object to track the progress of the training, display information and metric values in the experiment results table, and produce training plots for custom training experiments.

    Before starting the training, specify the names of the information and metric columns of the Experiment Manager results table.

    monitor.Info = ["GradientDecayFactor","SquaredGradientDecayFactor"];
monitor.Metrics = ["TrainingLoss","ValidationLoss"];

    Specify the horizontal axis label for the training plot. Group the training and validation loss in the same subplot.

    monitor.XLabel = "Iteration";
groupSubPlot(monitor,"Loss",["TrainingLoss","ValidationLoss"]);

    Specify a logarithmic scale for the loss. You can also switch the y-axis scale by clicking the log scale button in the axes toolbar.

    yscale(monitor,"Loss","log")

    Update the values of the gradient decay factor and the squared gradient decay factor for the trial in the results table.

    updateInfo(monitor, ...
    GradientDecayFactor=gradientDecayFactor, ...
    SquaredGradientDecayFactor=squaredGradientDecayFactor);

    After each iteration of the custom training loop, record the value of training and validation loss for the trial in the results table and the training plot.

    recordMetrics(monitor,iteration, ...
    TrainingLoss=trainingLoss, ...
    ValidationLoss=validationLoss);

    Update the training progress for the trial based on the fraction of iterations completed.

    monitor.Progress = 100 * (iteration/numIterations);

    Input Arguments

    collapse all

    Experiment monitor for the trial, specified as an experiments.Monitor object. When you run a custom training experiment, Experiment Manager passes this object as the second input argument of the training function.

    Name of subplot group, specified as a string or character vector. Experiment Manager groups the specified metrics in a single training subplot with the y-axis label groupName.

    Data Types: char | string

    Metric names, specified as a string, character vector, string array, or cell array of character vectors. Each metric name must be an element of the Metrics property of the experiments.Monitor object monitor.

    Data Types: char | string

    Tips

    • Use the groupSubplot function to define your training subplots before calling the function recordMetrics.

    Version History

    Introduced in R2021a

    See Also

    Apps

    Objects

    Functions

    Topics