Share via

IProgressChannel.Checkpoint(Nullable<Double>[]) Method

  • 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

Submit a 'checkpoint' entry. These entries are guaranteed to be delivered to the progress listener, if it is interested. Typically, this would contain some intermediate metrics, that are only calculated at certain moments ('checkpoints') of the computation.

For example, SDCA may report a checkpoint every time it computes the loss, or LBFGS may report a checkpoint every iteration.

The only parameter, values, is interpreted in the following fashion:

  • First MetricNames.Length items, if present, are metrics.
  • Subsequent ProgressNames.Length items, if present, are progress units.
  • Subsequent ProgressNames.Length items, if present, are progress limits.
  • If any more values remain, an exception is thrown.
public void Checkpoint (params double?[] values);
abstract member Checkpoint : Nullable<double>[] -> unit
Public Sub Checkpoint (ParamArray values As Nullable(Of Double)())

Parameters

values
Nullable<Double>[]

The metrics, progress units and progress limits.

Applies to