hex.leaderboard

Class MetricScore

java.lang.Object

water.Iced<MetricScore>

hex.leaderboard.MetricScore

All Implemented Interfaces:

LeaderboardCell<java.lang.Double,MetricScore>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<MetricScore>

public class MetricScore
extends Iced<MetricScore>
implements LeaderboardCell<java.lang.Double,MetricScore>

A cell for a scoring metric column.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricScore(Key<Model> modelId, java.lang.String metric, java.lang.Double score)

Method Summary

Modifier and Type	Method and Description
LeaderboardColumn	getColumn()
static LeaderboardColumn	getColumn(java.lang.String metric)
Key<Model>	getModelId()
java.lang.Double	getValue() gets the current value of the cell.
void	setValue(java.lang.Double value) sets the cell value.

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Methods inherited from interface hex.leaderboard.LeaderboardCell

fetch, isNA

Methods inherited from interface water.Freezable

asBytes, clone, frozenType, read, readJSON, reloadFromBytes, write, writeJSON

Constructor Detail

MetricScore

public MetricScore(Key<Model> modelId,
                   java.lang.String metric,
                   java.lang.Double score)

Method Detail

getColumn

public static LeaderboardColumn getColumn(java.lang.String metric)

getColumn

public LeaderboardColumn getColumn()

Specified by:

getColumn in interface LeaderboardCell<java.lang.Double,MetricScore>

Returns:

the column to which this cell belongs.

getModelId

public Key<Model> getModelId()

Specified by:

getModelId in interface LeaderboardCell<java.lang.Double,MetricScore>

Returns:

the row index of this cell.

getValue

public java.lang.Double getValue()

Description copied from interface: LeaderboardCell

gets the current value of the cell. If the value is not immediately available, this should return null, so that the client code can decide to call LeaderboardCell.fetch(). This is an accessor, it is safe to call LeaderboardCell.getValue() multiple times without triggering any side effect.

Specified by:

getValue in interface LeaderboardCell<java.lang.Double,MetricScore>

Returns:

the current cell value.

setValue

public void setValue(java.lang.Double value)

Description copied from interface: LeaderboardCell

sets the cell value. This can be useful for optimization, when the value is expensive to compute and available at some point during the automl run.

Specified by:

setValue in interface LeaderboardCell<java.lang.Double,MetricScore>