com.amazonaws.services.machinelearning.model

Class PerformanceMetrics

java.lang.Object

com.amazonaws.services.machinelearning.model.PerformanceMetrics

All Implemented Interfaces:

Serializable, Cloneable

public class PerformanceMetrics
extends Object
implements Serializable, Cloneable

Measurements of how well the MLModel performed on known observations. One of the following metrics is returned, based on the type of the MLModel :

• BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

• RegressionRMSE: The regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

• MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PerformanceMetrics()

Method Summary

Methods

Modifier and Type	Method and Description
PerformanceMetrics	addPropertiesEntry(String key, String value) Sets the value of the Properties property for this object.
PerformanceMetrics	clearPropertiesEntries() Removes all the entries added into Properties.
PerformanceMetrics	clone()
boolean	equals(Object obj)
Map<String,String>	getProperties() Returns the value of the Properties property for this object.
int	hashCode()
void	setProperties(Map<String,String> properties) Sets the value of the Properties property for this object.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PerformanceMetrics	withProperties(Map<String,String> properties) Sets the value of the Properties property for this object.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PerformanceMetrics

public PerformanceMetrics()

Method Detail

getProperties

public Map<String,String> getProperties()

Returns the value of the Properties property for this object.

Returns:

The value of the Properties property for this object.

setProperties

public void setProperties(Map<String,String> properties)

Sets the value of the Properties property for this object.

Parameters:

properties - The new value for the Properties property for this object.

withProperties

public PerformanceMetrics withProperties(Map<String,String> properties)

Sets the value of the Properties property for this object.

Returns a reference to this object so that method calls can be chained together.

Parameters:

properties - The new value for the Properties property for this object.

Returns:

A reference to this updated object so that method calls can be chained together.

addPropertiesEntry

public PerformanceMetrics addPropertiesEntry(String key,
                                    String value)

Sets the value of the Properties property for this object.

The method adds a new key-value pair into Properties parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Properties.

value - The corresponding value of the entry to be added into Properties.

clearPropertiesEntries

public PerformanceMetrics clearPropertiesEntries()

Removes all the entries added into Properties.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PerformanceMetrics clone()

Overrides:

clone in class Object