opennn::TrainingResults Struct Reference

History and final metrics produced by a training run. More...

#include <optimizer.h>

Public Member Functions
	TrainingResults (const Index=0)
	Constructs a TrainingResults pre-sized for the given number of epochs.
virtual	~TrainingResults ()=default
string	write_stopping_condition () const
	Returns a human-readable label for the stored stopping condition.
float	get_training_error () const
	Returns the final training error.
float	get_validation_error () const
	Returns the final validation (selection) error.
Index	get_epochs_number () const
	Returns the number of epochs that were actually executed.
void	save (const filesystem::path &) const
	Saves the training-error and validation-error histories to a JSON file.
void	print (const string &message={}) const
	Prints a summary of the training run, optionally prefixed by a message.
Tensor< string, 2 >	write_override_results (const Index=3) const
	Builds a table of final metrics for embedding in higher-level reports.
void	resize_training_error_history (const Index)
	Resizes the stored training-error history.
void	resize_validation_error_history (const Index)
	Resizes the stored validation-error history.

Public Attributes
Optimizer::StoppingCondition	stopping_condition = Optimizer::StoppingCondition::None
VectorR	training_error_history
VectorR	validation_error_history
string	elapsed_time
float	loss = NAN
Index	validation_failures = 0
float	loss_decrease = 0.0f

Detailed Description

History and final metrics produced by a training run.

Constructor & Destructor Documentation

TrainingResults()

opennn::TrainingResults::TrainingResults

(

const Index

= 0

)

Constructs a TrainingResults pre-sized for the given number of epochs.

~TrainingResults()

virtual opennn::TrainingResults::~TrainingResults ( )

virtualdefault

Member Function Documentation

get_epochs_number()

Index opennn::TrainingResults::get_epochs_number

(

)

const

Returns the number of epochs that were actually executed.

get_training_error()

float opennn::TrainingResults::get_training_error

(

)

const

Returns the final training error.

get_validation_error()

float opennn::TrainingResults::get_validation_error

(

)

const

Returns the final validation (selection) error.

print()

void opennn::TrainingResults::print

(

const string &

message = {}

)

const

Prints a summary of the training run, optionally prefixed by a message.

resize_training_error_history()

void opennn::TrainingResults::resize_training_error_history

(

const Index

)

Resizes the stored training-error history.

resize_validation_error_history()

void opennn::TrainingResults::resize_validation_error_history

(

const Index

)

Resizes the stored validation-error history.

save()

void opennn::TrainingResults::save

(

const filesystem::path &

)

const

Saves the training-error and validation-error histories to a JSON file.

write_override_results()

Tensor< string, 2 > opennn::TrainingResults::write_override_results

(

const Index

= 3

)

const

Builds a table of final metrics for embedding in higher-level reports.

write_stopping_condition()

string opennn::TrainingResults::write_stopping_condition

(

)

const

Returns a human-readable label for the stored stopping condition.

Member Data Documentation

elapsed_time

string opennn::TrainingResults::elapsed_time

loss

float opennn::TrainingResults::loss = NAN

loss_decrease

float opennn::TrainingResults::loss_decrease = 0.0f

stopping_condition

Optimizer::StoppingCondition opennn::TrainingResults::stopping_condition = Optimizer::StoppingCondition::None

training_error_history

VectorR opennn::TrainingResults::training_error_history

validation_error_history

VectorR opennn::TrainingResults::validation_error_history

validation_failures

Index opennn::TrainingResults::validation_failures = 0