RealmOA Library

oa::ItTraining

ItTraining class in the OA Ml public surface.

ClC++ public headers

Inheritance

public Iterator

Public Methods

void oa::ItTraining::addCallback(CbTraining * inCallback)
void oa::ItTraining::addMetric(Metric * inMetric)
void oa::ItTraining::attachSession(TrainingSession * inSession)
const ItTrainingConfig & oa::ItTraining::cfg()
oa::F64 oa::ItTraining::elapsedSeconds()
oa::I64 oa::ItTraining::epoch()
oa::I64 oa::ItTraining::epochLossCount()
oa::F64 oa::ItTraining::epochLossSum()
oa::F64 oa::ItTraining::epochMeanLoss()
oa::F64 oa::ItTraining::epochSampledMeanLoss()
oa::F64 oa::ItTraining::epochSeconds()
oa::F64 oa::ItTraining::epochSourceUnitsPerSecond()
void oa::ItTraining::excludeWallTime(oa::F64 inSeconds)
oa::Status oa::ItTraining::finish()
oa::F64 oa::ItTraining::gpuSamplesPerSecond()
oa::F64 oa::ItTraining::gpuSourceUnitsPerSecond()
GpuTimingStats oa::ItTraining::gpuTimingStats()
oa::F64 oa::ItTraining::gpuUnitsPerSecond()
bool oa::ItTraining::hasEpochs()
bool oa::ItTraining::hasGpuTimeSample()
bool oa::ItTraining::hasLossSample()
oa::I64 oa::ItTraining::index()
bool oa::ItTraining::isDone()
bool oa::ItTraining::isEpochBoundary()
bool oa::ItTraining::isLastStep()
oa::F64 oa::ItTraining::lastGpuMs()
oa::I64 oa::ItTraining::lastGpuTimeStep()
oa::F32 oa::ItTraining::lastLoss()
oa::I64 oa::ItTraining::lastLossStep()
const oa::Status & oa::ItTraining::lastStatus()
oa::F32 oa::ItTraining::liveAccuracy()
void oa::ItTraining::next()
void oa::ItTraining::next(const Matrix & inLoss)
Optimizer & oa::ItTraining::optimizer()
void oa::ItTraining::recordAccuracy(oa::F32 inAcc)
void oa::ItTraining::recordLoss(const Matrix & inLoss)
void oa::ItTraining::recordSourceUnits(oa::I64 inUnits)
oa::Status oa::ItTraining::requestProgramRecapture()
void oa::ItTraining::requestStop()
void oa::ItTraining::reset()
TrainingSession * oa::ItTraining::session()
void oa::ItTraining::step(const oa::Fn<void ()> & inOpFn)
void oa::ItTraining::step(const oa::Fn<void ()> & inPrepareFn, const oa::Fn<void ()> & inRecordFn)
oa::I64 oa::ItTraining::stepCount()
oa::I64 oa::ItTraining::stepInEpoch()
oa::I64 oa::ItTraining::stepsInCurrentEpoch()
bool oa::ItTraining::stopRequested()
oa::I64 oa::ItTraining::totalEpochs()
oa::I64 oa::ItTraining::totalSamples()
oa::I64 oa::ItTraining::totalSourceUnits()
oa::I64 oa::ItTraining::totalSteps()
oa::I64 oa::ItTraining::totalUnits()
oa::F64 oa::ItTraining::trainingMeanLoss()
const TrainingPhaseStats & oa::ItTraining::trainingPhaseStats()
oa::F64 oa::ItTraining::wallMsPerStep()
oa::F64 oa::ItTraining::wallSamplesPerSecond()
oa::F64 oa::ItTraining::wallSourceUnitsPerSecond()
oa::F64 oa::ItTraining::wallUnitsPerSecond()

Examples

Constructor & Destructor Documentation

oa::ItTraining::ItTraining( Engine & inEngine, Optimizer & inOpt, ItTrainingConfig inCfg = {} )
No public source comment is attached to this declaration.

Parameters

inEngine
Engine &

—

inOpt
Optimizer &

—

inCfg
ItTrainingConfig

Default: {}

void oa::ItTraining::~ItTraining()
No public source comment is attached to this declaration.

Public Method Documentation

void oa::ItTraining::addCallback( CbTraining * inCallback )
─── callbacks ────────────────────────────────────────────────────────

Parameters

inCallback
CbTraining *

—

Returns

void

The declared return value.

void oa::ItTraining::addMetric( Metric * inMetric )
No public source comment is attached to this declaration.

Parameters

inMetric
Metric *

—

Returns

void

The declared return value.

void oa::ItTraining::attachSession( TrainingSession * inSession )
No public source comment is attached to this declaration.

Parameters

inSession
TrainingSession *

—

Returns

void

The declared return value.

const ItTrainingConfig & oa::ItTraining::cfg()
No public source comment is attached to this declaration.

Returns

const ItTrainingConfig &

The declared return value.

oa::F64 oa::ItTraining::elapsedSeconds()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::I64 oa::ItTraining::epoch()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::I64 oa::ItTraining::epochLossCount()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::F64 oa::ItTraining::epochLossSum()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::epochMeanLoss()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::epochSampledMeanLoss()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::epochSeconds()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::epochSourceUnitsPerSecond()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

void oa::ItTraining::excludeWallTime( oa::F64 inSeconds )
No public source comment is attached to this declaration.

Parameters

inSeconds
oa::F64

—

Returns

void

The declared return value.

oa::Status oa::ItTraining::finish()
No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::F64 oa::ItTraining::gpuSamplesPerSecond()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::gpuSourceUnitsPerSecond()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

GpuTimingStats oa::ItTraining::gpuTimingStats()
No public source comment is attached to this declaration.

Returns

GpuTimingStats

The declared return value.

oa::F64 oa::ItTraining::gpuUnitsPerSecond()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

bool oa::ItTraining::hasEpochs()
No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::ItTraining::hasGpuTimeSample()
No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::ItTraining::hasLossSample()
No public source comment is attached to this declaration.

Returns

bool

The declared return value.

oa::I64 oa::ItTraining::index()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

bool oa::ItTraining::isDone()
─── oa::Iterator interface ─────────────────────────────────────────────

Returns

bool

The declared return value.

bool oa::ItTraining::isEpochBoundary()
No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::ItTraining::isLastStep()
No public source comment is attached to this declaration.

Returns

bool

The declared return value.

oa::F64 oa::ItTraining::lastGpuMs()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::I64 oa::ItTraining::lastGpuTimeStep()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::F32 oa::ItTraining::lastLoss()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

oa::I64 oa::ItTraining::lastLossStep()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

const oa::Status & oa::ItTraining::lastStatus()
No public source comment is attached to this declaration.

Returns

const oa::Status &

The declared return value.

oa::F32 oa::ItTraining::liveAccuracy()
No public source comment is attached to this declaration.

Returns

oa::F32

The declared return value.

void oa::ItTraining::next()
No public source comment is attached to this declaration.

Returns

void

The declared return value.

void oa::ItTraining::next( const Matrix & inLoss )
No public source comment is attached to this declaration.

Parameters

inLoss
const Matrix &

—

Returns

void

The declared return value.

Optimizer & oa::ItTraining::optimizer()
No public source comment is attached to this declaration.

Returns

Optimizer &

The declared return value.

void oa::ItTraining::recordAccuracy( oa::F32 inAcc )
No public source comment is attached to this declaration.

Parameters

inAcc
oa::F32

—

Returns

void

The declared return value.

void oa::ItTraining::recordLoss( const Matrix & inLoss )
No public source comment is attached to this declaration.

Parameters

inLoss
const Matrix &

—

Returns

void

The declared return value.

void oa::ItTraining::recordSourceUnits( oa::I64 inUnits )
No public source comment is attached to this declaration.

Parameters

inUnits
oa::I64

—

Returns

void

The declared return value.

oa::Status oa::ItTraining::requestProgramRecapture()
No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

void oa::ItTraining::requestStop()
No public source comment is attached to this declaration.

Returns

void

The declared return value.

void oa::ItTraining::reset()
No public source comment is attached to this declaration.

Returns

void

The declared return value.

TrainingSession * oa::ItTraining::session()
No public source comment is attached to this declaration.

Returns

TrainingSession *

The declared return value.

void oa::ItTraining::step( const oa::Fn<void ()> & inOpFn )
─── training step (lambda sugar) ─────────────────────────────────────

Parameters

inOpFn
const oa::Fn<void ()> &

—

Returns

void

The declared return value.

void oa::ItTraining::step( const oa::Fn<void ()> & inPrepareFn, const oa::Fn<void ()> & inRecordFn )
No public source comment is attached to this declaration.

Parameters

inPrepareFn
const oa::Fn<void ()> &

—

inRecordFn
const oa::Fn<void ()> &

—

Returns

void

The declared return value.

oa::I64 oa::ItTraining::stepCount()
─── State ────────────────────────────────────────────────────────────

Returns

oa::I64

The declared return value.

oa::I64 oa::ItTraining::stepInEpoch()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::I64 oa::ItTraining::stepsInCurrentEpoch()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

bool oa::ItTraining::stopRequested()
No public source comment is attached to this declaration.

Returns

bool

The declared return value.

oa::I64 oa::ItTraining::totalEpochs()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::I64 oa::ItTraining::totalSamples()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::I64 oa::ItTraining::totalSourceUnits()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::I64 oa::ItTraining::totalSteps()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::I64 oa::ItTraining::totalUnits()
No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

oa::F64 oa::ItTraining::trainingMeanLoss()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

const TrainingPhaseStats & oa::ItTraining::trainingPhaseStats()
No public source comment is attached to this declaration.

Returns

const TrainingPhaseStats &

The declared return value.

oa::F64 oa::ItTraining::wallMsPerStep()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::wallSamplesPerSecond()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::wallSourceUnitsPerSecond()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::ItTraining::wallUnitsPerSecond()
No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.