Share via

IProgressChannel.SetHeader 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

Set up the reporting structure:

  • Set the 'header' of the progress reports, defining which progress units and metrics are going to be reported.
  • Provide a thread-safe delegate to be invoked whenever anyone needs to know the progress.

It is acceptable to call SetHeader(ProgressHeader, Action<IProgressEntry>) multiple times (or none), regardless of whether the calculation is running or not. Because of synchronization, the computation should not deny calls to the 'old' fillAction delegates even after a new one is provided.

public void SetHeader (Microsoft.ML.Runtime.ProgressHeader header, Action<Microsoft.ML.Runtime.IProgressEntry> fillAction);
abstract member SetHeader : Microsoft.ML.Runtime.ProgressHeader * Action<Microsoft.ML.Runtime.IProgressEntry> -> unit
Public Sub SetHeader (header As ProgressHeader, fillAction As Action(Of IProgressEntry))

Parameters

header
ProgressHeader

The header object.

fillAction
Action<IProgressEntry>

The delegate to provide actual progress. The IProgressEntry parameter of the delegate will correspond to the provided header.

Applies to