org.deeplearning4j.evaluation

Class EvaluationTools

java.lang.Object

org.deeplearning4j.evaluation.EvaluationTools

public class EvaluationTools
extends Object

Tools for evaluation and rendering ROC and ROCMultiClass results

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
static String	evaluationCalibrationToHtml(EvaluationCalibration ec)
static void	exportevaluationCalibrationToHtmlFile(EvaluationCalibration ec, File file) Given a EvaluationCalibration instance, export the charts to a stand-alone HTML file
static void	exportRocChartsToHtmlFile(ROC roc, File file) Given a ROC chart, export the ROC chart and precision vs.
static void	exportRocChartsToHtmlFile(ROCMultiClass roc, File file) Given a ROCMultiClass chart, export the ROC chart and precision vs.
static String	rocChartToHtml(ROC roc) Given a ROC instance, render the ROC chart and precision vs.
static String	rocChartToHtml(ROCMultiClass rocMultiClass) Given a ROCMultiClass instance, render the ROC chart and precision vs.
static String	rocChartToHtml(ROCMultiClass rocMultiClass, List<String> classNames) Given a ROCMultiClass instance and (optionally) names for each class, render the ROC chart to a stand-alone HTML file (returned as a String)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

exportRocChartsToHtmlFile

public static void exportRocChartsToHtmlFile(ROC roc,
                                             File file)
                                      throws IOException

Given a ROC chart, export the ROC chart and precision vs. recall charts to a stand-alone HTML file

Parameters:

roc - ROC to export

file - File to export to

Throws:

IOException

exportRocChartsToHtmlFile

public static void exportRocChartsToHtmlFile(ROCMultiClass roc,
                                             File file)
                                      throws Exception

Given a ROCMultiClass chart, export the ROC chart and precision vs. recall charts to a stand-alone HTML file

Parameters:

roc - ROC to export

file - File to export to

Throws:

Exception

rocChartToHtml

public static String rocChartToHtml(ROC roc)

Given a ROC instance, render the ROC chart and precision vs. recall charts to a stand-alone HTML file (returned as a String)

Parameters:

roc - ROC to render

rocChartToHtml

public static String rocChartToHtml(ROCMultiClass rocMultiClass)

Given a ROCMultiClass instance, render the ROC chart and precision vs. recall charts to a stand-alone HTML file (returned as a String)

Parameters:

rocMultiClass - ROC to render

rocChartToHtml

public static String rocChartToHtml(ROCMultiClass rocMultiClass,
                                    List<String> classNames)

Given a ROCMultiClass instance and (optionally) names for each class, render the ROC chart to a stand-alone HTML file (returned as a String)

Parameters:

rocMultiClass - ROC to render

classNames - Names of the classes. May be null

exportevaluationCalibrationToHtmlFile

public static void exportevaluationCalibrationToHtmlFile(EvaluationCalibration ec,
                                                         File file)
                                                  throws IOException

Given a EvaluationCalibration instance, export the charts to a stand-alone HTML file

Parameters:

roc - ROC to export

file - File to export to

Throws:

IOException

evaluationCalibrationToHtml

public static String evaluationCalibrationToHtml(EvaluationCalibration ec)