Share via

ProgressHeader Constructors

  • Reference

Definition

Namespace:
Microsoft.ML.Runtime
Assembly:
Microsoft.ML.Core.dll
Package:
Microsoft.ML v3.0.1
Package:
Microsoft.ML v1.0.0
Package:
Microsoft.ML v1.1.0
Package:
Microsoft.ML v1.2.0
Package:
Microsoft.ML v1.3.1
Package:
Microsoft.ML v1.4.0
Package:
Microsoft.ML v1.5.5
Package:
Microsoft.ML v1.6.0
Package:
Microsoft.ML v1.7.0
Package:
Microsoft.ML v2.0.0

Overloads

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).
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).

public ProgressHeader (params string[] unitNames);
new Microsoft.ML.Runtime.ProgressHeader : string[] -> Microsoft.ML.Runtime.ProgressHeader
Public Sub New (ParamArray unitNames As String())

Parameters

unitNames
String[]

Applies to

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.

public ProgressHeader (string[] metricNames, string[] unitNames);
new Microsoft.ML.Runtime.ProgressHeader : string[] * string[] -> Microsoft.ML.Runtime.ProgressHeader
Public Sub New (metricNames As String(), unitNames As String())

Parameters

metricNames
String[]

The metrics that the calculation reports. These are completely independent, and there is no contract on whether the metric values should increase or not. As naming convention, metricNames can have multiple words with spaces, and should be title-cased.

unitNames
String[]

The names of the progress units, listed from least granular to most granular. The idea is that the progress should be lexicographically increasing (like [0,0], [0,10], [1,0], [1,15], [2,5] etc.). As naming convention, unitNames should be lower-cased and typically plural (for example, iterations, clusters, examples).

Applies to