magpie.csp

Class CSPPerformanceStats

java.lang.Object

magpie.csp.CSPPerformanceStats

All Implemented Interfaces:

Printable

public class CSPPerformanceStats
extends java.lang.Object
implements Printable

Holds data about the performance of a CSP algorithm.

Constructor Summary

Constructors

Constructor and Description
CSPPerformanceStats()

Method Summary

Modifier and Type	Method and Description
java.lang.String	about() Prints a simple status message about this object
void	addResult(java.lang.String correctAnswer, java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Double>> predictions) Add results of a prediction to performance dataset.
void	clear() Removes results from previous tests.
double[][]	computeListLengthCurve(double minSuccess, int maxLength) Compute the minimum length of a list required to find the correct structure
int	NResults() Number of crystal structure predictions that have been evaluated.
java.lang.String	printCommand(java.util.List<java.lang.String> Command) Handles more complicated printing commands.
java.lang.String	printDescription(boolean htmlFormat) Print full name of object, and a simple description of the options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSPPerformanceStats

public CSPPerformanceStats()

Method Detail

NResults

public int NResults()

Number of crystal structure predictions that have been evaluated.

Returns:

Number results

addResult

public void addResult(java.lang.String correctAnswer,
                      java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.lang.Double>> predictions)

Add results of a prediction to performance dataset.

Parameters:

correctAnswer - Correct prototype

predictions - Predicted prototypes ordered such that the most probable answer is first

clear

public void clear()

Removes results from previous tests.

computeListLengthCurve

public double[][] computeListLengthCurve(double minSuccess,
                                         int maxLength)

Compute the minimum length of a list required to find the correct structure

Parameters:

minSuccess - Minimum probability to predict the correct structure (between 0 and 1)

maxLength - Maximum list length to evaluate

Returns:

List where [][0] is the prediction accuracy, and [][1] is the corresponding list length.

about

public java.lang.String about()

Description copied from interface: Printable

Prints a simple status message about this object

Specified by:

about in interface Printable

Returns:

Short status message

printDescription

public java.lang.String printDescription(boolean htmlFormat)

Description copied from interface: Printable

Print full name of object, and a simple description of the options. This description should print enough information to reproduce how this object was created, but not necessarily enough to run it (e.g., coefficients for the model).

Example: For a model training a separate WekaRegression for intermetallics

magpie.models.regression.SplitRegression

Splitter: AllMetalsSplitter
All Metals: magpie.models.regression.WekaRegression trees.REPTree
Contains Nonmetal: magpie.regression.LASSORegreession -maxterms 2

Specified by:

printDescription in interface Printable

Parameters:

htmlFormat - Whether format for output to an HTML page (e.g., <div> to create indentation) or for printing to screen.

Returns:

String describing the model

See Also:

#printModel()

printCommand

public java.lang.String printCommand(java.util.List<java.lang.String> Command)
                              throws java.lang.Exception

Description copied from interface: Printable

Handles more complicated printing commands.

Specified by:

printCommand in interface Printable

Parameters:

Command - Command specifying what to print

Returns:

String formatted as requested

Throws:

java.lang.Exception - If command not understood