src.eval.evaluation

Classes

Evaluation(**kwargs)

Exceptions

EvaluationException([message])

exception src.eval.evaluation.EvaluationException(message='')

Author:: Alberto M. Esmoris Pena

Class for exceptions related to evaluations. See VL3DException and EvaluatorException

__init__(message='')

class src.eval.evaluation.Evaluation(**kwargs)

Author:: Alberto M. Esmoris Pena

Class for evaluation results. See Evaluator.

Variables:: problem_name (str) – The name of the evaluated problem.

__init__(**kwargs)

Initialize/instantiate an Evaluation.

Parameters:: kwargs – The attributes for the Evaluation.

report(**kwargs)

Transform the evaluation into a report.

By default, this method is not supported. Depending on the evaluation subclass, this method might be overridden to provide automatic report generation.

Returns:: The report representing the evaluation.
Return type:: Report

can_report()

Check whether the evaluation object can generate a report or not.

Returns:: True if a report can be generated, False otherwise.
Return type:: bool

plot(**kwargs)

Transform the evaluation into a plot (or many plots).

By default, this method is not supported. Depending on the evaluation subclass, this method might be overridden to provide automatic plot generation.

Returns:: The plot representing the evaluation.
Return type:: Plot

can_plot()

Check whether the evaluation object can generate a plot or not.

Returns:: True if a plot can be generated, False otherwise.