oa::TrainingProgram

TrainingProgram class in the OA Ml public surface.

ClC++ public headers

Public Methods

oa::U32 oa::TrainingProgram::aliasCandidateCount()

oa::Status oa::TrainingProgram::capture(oa::Engine & inEngine, const TrainingProgramOptions & inOptions = {})

oa::U32 oa::TrainingProgram::capturedResourceCount()

oa::Span<const oa::CapturedResourceDesc> oa::TrainingProgram::capturedResources()

oa::String oa::TrainingProgram::compilationDebugReportJson(oa::StringView inName = "TrainingStep")

oa::Span<const TrainingCompilationStageRecord> oa::TrainingProgram::compilationStages()

oa::String oa::TrainingProgram::debugReportJson(oa::StringView inName = "TrainingStep")

oa::Bool oa::TrainingProgram::isCaptured()

oa::F64 oa::TrainingProgram::lastGpuMs()

const oa::SemanticLoweringAnalysis & oa::TrainingProgram::loweringAnalysis()

oa::U64 oa::TrainingProgram::materializedAliasSavings()

oa::U32 oa::TrainingProgram::nodeCount()

oa::U32 oa::TrainingProgram::plannedAliasGroupCount()

oa::U64 oa::TrainingProgram::potentialAliasSavings()

oa::Status oa::TrainingProgram::replay()

oa::Result<oa::Event> oa::TrainingProgram::replayAsync()

oa::Status oa::TrainingProgram::reset()

oa::String oa::TrainingProgram::semanticDebugReportJson(oa::StringView inName = "TrainingStep")

const oa::SemanticGraph & oa::TrainingProgram::semanticGraph()

oa::U32 oa::TrainingProgram::semanticOpCount()

oa::Span<const oa::SemanticStorageBinding> oa::TrainingProgram::semanticStorageBindings()

oa::GraphStats oa::TrainingProgram::stats()

oa::Status oa::TrainingProgram::wait()

Constructor & Destructor Documentation

oa::TrainingProgram::TrainingProgram()

No public source comment is attached to this declaration.

void oa::TrainingProgram::~TrainingProgram()

No public source comment is attached to this declaration.

Public Method Documentation

oa::U32 oa::TrainingProgram::aliasCandidateCount()

No public source comment is attached to this declaration.

Returns

oa::U32

The declared return value.

oa::Status oa::TrainingProgram::capture(
	oa::Engine & inEngine,
	const TrainingProgramOptions & inOptions = {}
)

compile the engine's currently recorded fixed-shape step. On success the source graph is cleared without execution and this program becomes its sole executable owner. On failure the source graph is left intact so the caller may execute it eagerly or diagnose the rejected node. The engine and its vulkan device must outlive this program.

Parameters

inEngine

oa::Engine &

—

inOptions

const TrainingProgramOptions &

Default: {}

Returns

oa::Status

The declared return value.

oa::U32 oa::TrainingProgram::capturedResourceCount()

No public source comment is attached to this declaration.

Returns

oa::U32

The declared return value.

oa::Span<const oa::CapturedResourceDesc> oa::TrainingProgram::capturedResources()

No public source comment is attached to this declaration.

Returns

oa::Span<const oa::CapturedResourceDesc>

The declared return value.

oa::String oa::TrainingProgram::compilationDebugReportJson(
	oa::StringView inName = "TrainingStep"
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

Default: "TrainingStep"

Returns

oa::String

The declared return value.

oa::Span<const TrainingCompilationStageRecord> oa::TrainingProgram::compilationStages()

No public source comment is attached to this declaration.

Returns

oa::Span<const TrainingCompilationStageRecord>

The declared return value.

oa::String oa::TrainingProgram::debugReportJson(
	oa::StringView inName = "TrainingStep"
)

No public source comment is attached to this declaration.

oa::Status

The declared return value.

oa::String oa::TrainingProgram::semanticDebugReportJson(
	oa::StringView inName = "TrainingStep"
)

No public source comment is attached to this declaration.

oa::Status

The declared return value.