ProgressHeader Class

Definition

Namespace:

Microsoft.ML.Runtime

Assembly:

Microsoft.ML.Core.dll

Package:

Microsoft.ML v3.0.1

This is the 'header' of the progress report.

public sealed class ProgressHeader

type ProgressHeader = class

Public NotInheritable Class ProgressHeader

Inheritance

Object

ProgressHeader

Constructors

ProgressHeader(String[], String[])	Initialize the header. This will take ownership of the arrays. Both arrays can be null, even simultaneously. This 'empty' header indicated that the calculation doesn't report any units of progress, but the tracker can still track start, stop and elapsed time. Of course, if there's any progress or metrics to report, it is always better to report them.
ProgressHeader(String[])	A constructor for no metrics, just progress units. As naming convention, unitNames should be lower-cased and typically plural (for example, iterations, clusters, examples).

Fields

MetricNames	These are the names of the reported metrics. For example, this could be the 'loss', 'weight updates/sec' etc. Will never be null, but can be empty.
UnitNames	These are the names of the progress 'units', from the least granular to the most granular. For example, neural network might have {'epoch', 'example'} and FastTree might have {'tree', 'split', 'feature'}. Will never be null, but can be empty.