npu.eval.kfold_evaluation

Classes

KFoldEvaluation(**kwargs)

class npu.eval.kfold_evaluation.KFoldEvaluation(**kwargs)
Author:

Alberto M. Esmoris Pena

Class representing the result of evaluating a kfold procedure. See npu.eval.kfold_evaluator.KFoldEvaluator.

Variables:

  • metric_names (list or tuple) – The name for each metric, i.e., the name of each component in mu or sigma vectors.

  • mu (np.ndarray vector-like) – The vector of means such that each component represents the mean value of an evaluation metric used to assess the k-folding procedure.

  • sigma (np.ndarray vector-like) – The vector of standard deviations such that each component represents the standard deviation of an evaluation metric used to assess the k-folding procedure.

  • Q (np.ndarray matrix-like) – The matrix of quantiles such that the component of each column vector represents the quantiles of an evaluation metric used to assess the k-folding procedure.

__init__(**kwargs)

Initialize/instantiate a KFoldEvaluation.

Parameters:

kwargs – The attributes for the KFoldEvaluation.

report(KFoldReport, problem_name, **kwargs)

Transform the KFoldEvaluation into a KFoldReport.

Parameters:

KFoldReport (class) – The k-folding report class that must be instantiated.

Returns:

The KFoldReport representing the KFoldEvaluation.

Return type:

KFoldReport

can_report()

See Evaluation and evaluation.Evaluation.can_report().

plot(KFoldPlot, **kwargs)

Transform the KFoldEvaluation into a KFoldPlot.

Keyword Arguments:

  • path (str) – The path to store the plot.

  • show (bool) – Boolean flag to handle whether to show the plot (True) or not (False).

Parameters:

KFoldPlot (class) – The k-folding plot class that must be instantiated.

Returns:

The KFoldReport representing the KFoldEvaluation.

Return type:

KFoldPlot

can_plot()

See Evaluation and evaluation.Evaluation.can_plot().