Table of Contents

Class InferenceEngineStatus

Namespace
InferenceEngine.Core.Diagnostics
Assembly
InferenceEngine.Core.dll

The consumer-facing object model for one engine's state: a single immutable snapshot covering lifecycle (State), runtime details (Info) and failure details (LoadError). Delivered both as a pollable property (BaseInferenceEngine{TInput,TOutput}.Status, mirrored onto out-of-process proxies) and via the InferenceEngineOptions.OnStatusChanged callback on every transition.

public sealed record InferenceEngineStatus : IEquatable<InferenceEngineStatus>
Inheritance
InferenceEngineStatus
Implements
Inherited Members

Remarks

The graph consumers program against:

InferenceEngineOptions                    // configuration (model, GPU flags, callbacks)
  └─ OnStatusChanged(InferenceEngineStatus)
       ├─ State: EngineLoadState          // NotLoaded → Loading → Loaded | Failed
       ├─ Detail: string?                 // display-only phase text while Loading
       ├─ Info: InferenceEngineInfo       // Provider, DeviceId, ModelName/Path/Source,
       │                                    IsFallback + FallbackReason, Checks trail
       │                                    (partial — checks only — when State=Failed)
       └─ LoadError: string?              // populated when State=Failed

OnSessionInitialized remains as the success-only hook; new consumers should prefer OnStatusChanged, which also covers failures.

Properties

Detail

Best-effort human-readable phase text while State is Loading (e.g. "Starting engine worker…", "Constructing inference session…", "Compiling MIGraphX kernels…"). Consumed for progress UI during slow first loads; null means "no finer phase is known". Not a stable contract — treat as display text only.

public string? Detail { get; init; }

Property Value

string

Info

Runtime details. Full when Loaded; partial (provider-selection checks, Provider=Unknown) when Failed; null while NotLoaded/Loading.

public InferenceEngineInfo? Info { get; init; }

Property Value

InferenceEngineInfo

IsGpuActive

True when the engine is loaded AND running on a hardware provider (not CPU, not unknown).

public bool IsGpuActive { get; }

Property Value

bool

LoadError

The error that failed the load (exception message, or the worker-reported error for out-of-process engines). Null unless State is Failed.

public string? LoadError { get; init; }

Property Value

string

NotLoaded

public static InferenceEngineStatus NotLoaded { get; }

Property Value

InferenceEngineStatus

State

public EngineLoadState State { get; init; }

Property Value

EngineLoadState

Timestamp

When this snapshot was produced (UTC).

public DateTimeOffset Timestamp { get; init; }

Property Value

DateTimeOffset