oa::MetricLoss

MetricLoss class in the OA Ml public surface.

ClC++ public headers

Public Types

Inheritance

public Metric

Public Methods

oa::I64 oa::MetricLoss::count()

bool oa::MetricLoss::isLossMetric()

oa::F64 oa::MetricLoss::last()

oa::F64 oa::MetricLoss::mean()

const char * oa::MetricLoss::name()

oa::I32 oa::MetricLoss::render(char * outBuffer, oa::I32 inBufferSize, bool inFirst)

void oa::MetricLoss::reset()

oa::F64 oa::MetricLoss::result()

void oa::MetricLoss::update(const Matrix & inPreds, const Matrix & inLabels)

void oa::MetricLoss::update(oa::F32 inLossValue)

void oa::MetricLoss::updateStep(oa::F32 inLoss, bool inHasLoss, oa::F64, oa::I64)

Examples

ExMl

Learn a 300-token BPE vocabulary, train a causal Transformer for 300 optimizer steps, verify that cross-entropy falls, and generate text from the trained model.

Constructor & Destructor Documentation

oa::MetricLoss::MetricLoss()

No public source comment is attached to this declaration.

oa::MetricLoss::MetricLoss(
	oa::String inName,
	Mode inMode = Mode::Mean
)

No public source comment is attached to this declaration.

Parameters

inName

oa::String

—

inMode

Mode

Default: Mode::Mean

Public Method Documentation

oa::I64 oa::MetricLoss::count()

No public source comment is attached to this declaration.

Returns

oa::I64

The declared return value.

bool oa::MetricLoss::isLossMetric()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

oa::F64 oa::MetricLoss::last()

No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

oa::F64 oa::MetricLoss::mean()

No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

const char * oa::MetricLoss::name()

No public source comment is attached to this declaration.

Returns

const char *

The declared return value.

oa::I32 oa::MetricLoss::render(
	char * outBuffer,
	oa::I32 inBufferSize,
	bool inFirst
)

No public source comment is attached to this declaration.

Parameters

outBuffer

char *

—

inBufferSize

oa::I32

—

inFirst

bool

—

Returns

oa::I32

The declared return value.

void oa::MetricLoss::reset()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

oa::F64 oa::MetricLoss::result()

No public source comment is attached to this declaration.

Returns

oa::F64

The declared return value.

void oa::MetricLoss::update(
	const Matrix & inPreds,
	const Matrix & inLabels
)

No public source comment is attached to this declaration.

Parameters

inPreds

const Matrix &

—

inLabels

const Matrix &

—

Returns

void

The declared return value.

void oa::MetricLoss::update(
	oa::F32 inLossValue
)

No public source comment is attached to this declaration.

Parameters

inLossValue

oa::F32

—

Returns

void

The declared return value.

void oa::MetricLoss::updateStep(
	oa::F32 inLoss,
	bool inHasLoss,
	oa::F64,
	oa::I64
)

No public source comment is attached to this declaration.

Parameters

inLoss

oa::F32

—

inHasLoss

bool

—

(unnamed)

oa::F64

—

(unnamed)

oa::I64

—

Returns

void

The declared return value.