water.api

Class AUC

java.lang.Object

water.Iced

water.api.Constants

water.api.RequestStatics

water.api.RequestArguments

water.api.RequestQueries

water.api.RequestBuilders

water.api.Request

water.Request2

water.Func

water.api.AUC

All Implemented Interfaces:

java.lang.Cloneable, Freezable

public class AUC
extends Func

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AUC.ThresholdCriterion

Nested classes/interfaces inherited from class water.Request2

Request2.ColumnSelect, Request2.Dependent, Request2.DoClassBoolean, Request2.DRFCopyDataBoolean, Request2.MultiVecSelect, Request2.MultiVecSelectType, Request2.TypeaheadKey, Request2.VecClassSelect, Request2.VecSelect

Nested classes/interfaces inherited from class water.api.Request

Request.API, Request.Default, Request.Filter, Request.Validator<V>

Nested classes/interfaces inherited from class water.api.RequestBuilders

RequestBuilders.ArrayBuilder, RequestBuilders.ArrayHeaderRowBuilder, RequestBuilders.ArrayRowBuilder, RequestBuilders.ArrayRowElementBuilder, RequestBuilders.ArrayRowSingleColBuilder, RequestBuilders.BooleanStringBuilder, RequestBuilders.Builder, RequestBuilders.ElementBuilder, RequestBuilders.HideBuilder, RequestBuilders.KeyCellBuilder, RequestBuilders.KeyElementBuilder, RequestBuilders.KeyLinkElementBuilder, RequestBuilders.KeyMinAvgMaxBuilder, RequestBuilders.NoCaptionObjectBuilder, RequestBuilders.ObjectBuilder, RequestBuilders.PaginatedTable, RequestBuilders.PreFormattedBuilder, RequestBuilders.Response, RequestBuilders.ResponseInfo, RequestBuilders.WarningCellBuilder

Nested classes/interfaces inherited from class water.api.RequestArguments

RequestArguments.Argument<T>, RequestArguments.Bool, RequestArguments.CaseModeSelect, RequestArguments.CaseSelect, RequestArguments.ClassifyBool, RequestArguments.DRFCopyDataBool, RequestArguments.EnumArgument<T extends java.lang.Enum<T>>, RequestArguments.ExistingFile, RequestArguments.FrameClassVec, RequestArguments.FrameKeyMultiVec, RequestArguments.FrameKeyVec, RequestArguments.GeneralFile, RequestArguments.H2OCategoryStrata, RequestArguments.H2OCategoryWeights, RequestArguments.H2OExistingKey, RequestArguments.H2OGLMModelKey, RequestArguments.H2OHexKey, RequestArguments.H2OHexKeyCol, RequestArguments.H2OIllegalArgumentException, RequestArguments.H2OKey, RequestArguments.H2OKey2, RequestArguments.H2OKMeansModelKey, RequestArguments.H2OModelKey<TM extends OldModel,TK extends TypeaheadKeysRequest>, RequestArguments.HexAllColumnSelect, RequestArguments.HexColumnSelect, RequestArguments.HexKeyClassCol, RequestArguments.HexNonClassColumnSelect, RequestArguments.HexNonConstantColumnSelect, RequestArguments.HexPCAColumnSelect, RequestArguments.InputCheckBox, RequestArguments.InputSelect<T>, RequestArguments.InputText<T>, RequestArguments.Int, RequestArguments.LongInt, RequestArguments.MultipleSelect<T>, RequestArguments.MultipleText<T>, RequestArguments.NTree, RequestArguments.NumberSequence, RequestArguments.NumberSequenceFloat, RequestArguments.Real, RequestArguments.Record<T>, RequestArguments.RFModelKey, RequestArguments.RSeq, RequestArguments.RSeqFloat, RequestArguments.Str, RequestArguments.StringList, RequestArguments.TypeaheadInputText<T>

Nested classes/interfaces inherited from class water.api.RequestStatics

RequestStatics.RequestType

Nested classes/interfaces inherited from class water.api.Constants

Constants.Extensions, Constants.Schemes, Constants.Suffixes

Field Summary

Fields

Modifier and Type	Field and Description
float[]	accuracy
Frame	actual
double	AUC
long[][][]	confusion_matrices
static DocGen.FieldDoc[]	DOC_FIELDS
static java.lang.String	DOC_GET
float[]	errorr
float[]	F0point5
float[]	F1
float[]	F2
double	Gini
float[]	max_per_class_error
float[]	mcc
float[]	precision
Frame	predict
float[]	recall
float[]	specificity
AUC.ThresholdCriterion	threshold_criterion
float[]	thresholds
Vec	vactual
Vec	vpredict

Fields inherited from class water.Request2

_parms, response_info

Fields inherited from class water.api.Request

_requestHelp, SUPPORTS_ONLY_V1, SUPPORTS_ONLY_V2, SUPPORTS_V1_V2

Fields inherited from class water.api.RequestBuilders

ARRAY_BUILDER, ARRAY_HEADER_ROW_BUILDER, ARRAY_ROW_BUILDER, ARRAY_ROW_ELEMENT_BUILDER, ARRAY_ROW_SINGLECOL_BUILDER, ELEMENT_BUILDER, GSON_BUILDER, OBJECT_BUILDER, ROOT_OBJECT

Fields inherited from class water.api.RequestQueries

_queryHtml

Fields inherited from class water.api.RequestArguments

_arguments

Fields inherited from class water.api.Constants

ALPHA, ARGUMENTS, BASE, BEST_THRESHOLD, BETA_EPS, BIN_LIMIT, BROWSE, BUCKET, BUILT_IN_KEY_JOBS, CANCELLED, CARDINALITY, CASE, CASE_MODE, CHUNK, CLASS, CLOUD_HEALTH, CLOUD_NAME, CLOUD_SIZE, CLOUD_UPTIME_MILLIS, CLUSTERS, COEFFICIENTS, COL_INDEX, COLS, COLUMN_NAME, COLUMNS_DISPLAY, CONSENSUS, CONTENTS, COUNT, DATA_KEY, DEPTH, DESCRIPTION, DEST_KEY, DTHRESHOLDS, ELAPSED, END_TIME, ENUM_DOMAIN_SIZE, ERROR, ESCAPE_NAN, EXCLUSIVE_SPLIT_LIMIT, EXPRESSION, FAILED, FAMILY, FEATURES, FILE, FILES, FILTER, FIRST_CHUNK, FJ_QUEUE_HI, FJ_QUEUE_LO, FJ_THREADS_HI, FJ_THREADS_LO, FREE_DISK, FREE_MEM, HEADER, HEIGHT, HELP, IGNORE, ITEMS, ITERATIVE_CM, JOB, JOB_KEY, JOBS, JSON_H2O, KEY, KEYS, LAMBDA, LAST_CONTACT, LIMIT, LINK, LOCKED, MAX, MAX_DISK, MAX_ITER, MAX_MEM, MAX_ROWS, MEAN, MIN, MODEL_KEY, MODELS, MORE, MTRY, MTRY_NODES, NAME, NEG_X, NO_CM, NODE, NODE_HEALTH, NODE_NAME, NODES, NORMALIZE, NUM_COLS, NUM_CPUS, NUM_FAILED, NUM_KEYS, NUM_MISSING_VALUES, NUM_ROWS, NUM_SUCCEEDED, NUM_TREES, OBJECT, OFFSET, OOBEE, PARALLEL, PARSER_TYPE, PATH, PREVIEW, PREVIOUS_MODEL_KEY, PRIOR, PROGRESS, PROGRESS_KEY, PROGRESS_TOTAL, REDIRECT, REDIRECT_ARGS, REPLICATION_FACTOR, REQUEST_TIME, RESPONSE, RHO, ROW, ROW_SIZE, ROWS, RPCS, SAMPLE, SAMPLING_STRATEGY, SCALE, SEED, SENT_ROWS, SEPARATOR, SIZE, SOURCE_KEY, STACK_TRACES, START_TIME, STAT_TYPE, STATUS, STEP, STRATA_SAMPLES, SUCCEEDED, SYSTEM_LOAD, TASK_KEY, TCPS_ACTIVE, TCPS_DUTY, TIME, TO_ENUM, TOT_MEM, TREE_COUNT, TREE_DEPTH, TREE_LEAVES, TREE_NUM, TREES, TWEEDIE_POWER, TYPE, URL, USE_NON_LOCAL_DATA, VALUE, VALUE_SIZE, VALUE_TYPE, VARIANCE, VERSION, VIEW, WARNINGS, WEIGHT, WEIGHTS, WIDTH, X, XVAL, Y

Constructor Summary

Constructors

Constructor and Description
AUC()
AUC(ConfusionMatrix[] cms, float[] thresh) Constructor for algos that make their own CMs
AUC(ConfusionMatrix[] cms, float[] thresh, java.lang.String[] domain) Constructor for algos that make their own CMs

Method Summary

Methods

Modifier and Type	Method and Description
double	accuracy()
double	accuracy(AUC.ThresholdCriterion criter)
double	AUC()
double	bestErr()
double	bestF1()
void	clear() Clean out large JSON fields.
long[][]	cm()
ConfusionMatrix	CM()
long[][]	cm(AUC.ThresholdCriterion criter)
double	err()
double	err(AUC.ThresholdCriterion criter)
protected void	execImpl() The real implementation which should be provided by ancestors.
double	F0point5()
double	F0point5(AUC.ThresholdCriterion criter)
double	F1()
double	F1(AUC.ThresholdCriterion criter)
double	F2()
double	F2(AUC.ThresholdCriterion criter)
double	Gini()
protected void	init() Invoked before run.
double	max_per_class_error()
double	max_per_class_error(AUC.ThresholdCriterion criter)
double	mcc()
double	mcc(AUC.ThresholdCriterion criter)
double	precision()
double	precision(AUC.ThresholdCriterion criter)
double	recall()
double	recall(AUC.ThresholdCriterion criter)
double	specificity()
double	specificity(AUC.ThresholdCriterion criter)
float	threshold()
float	threshold(AUC.ThresholdCriterion criter)
void	toASCII(java.lang.StringBuilder sb)
boolean	toHTML(java.lang.StringBuilder sb)

Methods inherited from class water.Func

cleanup, emptyLTrash, exec, gtrash, gtrash, invoke, ltrash, ltrash, serve

Methods inherited from class water.Request2

create, fillResponseInfo, filterNaCols, input, logStart, makeJsonBox, registered, serveGrid, set, split, superServeGrid, supportedVersions, toJSON, toString

Methods inherited from class water.api.Request

addToNavbar, addToNavbar, addToNavbar, DocExampleFail, DocExampleSucc, href, href, hrefType, HTMLHelp, htmlTemplate, initializeNavBar, log, mapTypeahead, ReSTHelp, serve, serveJava, serveResponse, toDocGET, toJava, wrap, wrap, wrap, writeJSONFields

Methods inherited from class water.api.RequestBuilders

build, buildJSONResponseBox, buildResponseHeader, name

Methods inherited from class water.api.RequestQueries

buildQuery, checkArguments, queryArgumentValueSet

Methods inherited from class water.api.RequestArguments

arguments, argumentsToJson, frameColumnNameToIndex, vaCategoryNames, vaCategoryNames, vaColumnNameToIndex

Methods inherited from class water.api.RequestStatics

checkJsonName, encodeRedirectArgs, JSON2HTML, jsonError, requestName, Str2JSON

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

DOC_FIELDS

public static DocGen.FieldDoc[] DOC_FIELDS

DOC_GET

public static final java.lang.String DOC_GET

See Also:

Constant Field Values

actual

@Request.API(help="",
             required=true,
             filter=Request.Default.class,
             json=true)
public Frame actual

vactual

@Request.API(help="Column of the actual results (will display vertically)",
             required=true,
             filter=water.api.AUC.actualVecSelect.class,
             json=true)
public Vec vactual

predict

@Request.API(help="",
             required=true,
             filter=Request.Default.class,
             json=true)
public Frame predict

vpredict

@Request.API(help="Column of the predicted results (will display horizontally)",
             required=true,
             filter=water.api.AUC.predictVecSelect.class,
             json=true)
public Vec vpredict

thresholds

@Request.API(help="Thresholds (optional, e.g. 0:1:0.01 or 0.0,0.2,0.4,0.6,0.8,1.0).",
             required=false,
             filter=Request.Default.class,
             json=true)
public float[] thresholds

threshold_criterion

@Request.API(help="Threshold criterion",
             filter=Request.Default.class,
             json=true)
public AUC.ThresholdCriterion threshold_criterion

AUC

@Request.API(help="AUC (ROC)")
public double AUC

Gini

@Request.API(help="Gini")
public double Gini

confusion_matrices

@Request.API(help="Confusion Matrices for all thresholds")
public long[][][] confusion_matrices

F1

@Request.API(help="F1 for all thresholds")
public float[] F1

F2

@Request.API(help="F2 for all thresholds")
public float[] F2

F0point5

@Request.API(help="F0point5 for all thresholds")
public float[] F0point5

accuracy

@Request.API(help="Accuracy for all thresholds")
public float[] accuracy

errorr

@Request.API(help="Error for all thresholds")
public float[] errorr

precision

@Request.API(help="Precision for all thresholds")
public float[] precision

recall

@Request.API(help="Recall for all thresholds")
public float[] recall

specificity

@Request.API(help="Specificity for all thresholds")
public float[] specificity

mcc

@Request.API(help="MCC for all thresholds")
public float[] mcc

max_per_class_error

@Request.API(help="Max per class error for all thresholds")
public float[] max_per_class_error

Constructor Detail

AUC

public AUC()

AUC

public AUC(ConfusionMatrix[] cms,
   float[] thresh)

Constructor for algos that make their own CMs

Parameters:

cms - ConfusionMatrices

thresh - Thresholds

AUC

public AUC(ConfusionMatrix[] cms,
   float[] thresh,
   java.lang.String[] domain)

Constructor for algos that make their own CMs

Parameters:

cms - ConfusionMatrices

thresh - Thresholds

domain - Domain

Method Detail

clear

public void clear()

Clean out large JSON fields. Only keep AUC and Gini. Useful for models that score often.

AUC

public double AUC()

Gini

public double Gini()

F1

public double F1(AUC.ThresholdCriterion criter)

F2

public double F2(AUC.ThresholdCriterion criter)

F0point5

public double F0point5(AUC.ThresholdCriterion criter)

precision

public double precision(AUC.ThresholdCriterion criter)

recall

public double recall(AUC.ThresholdCriterion criter)

specificity

public double specificity(AUC.ThresholdCriterion criter)

mcc

public double mcc(AUC.ThresholdCriterion criter)

accuracy

public double accuracy(AUC.ThresholdCriterion criter)

err

public double err(AUC.ThresholdCriterion criter)

max_per_class_error

public double max_per_class_error(AUC.ThresholdCriterion criter)

threshold

public float threshold(AUC.ThresholdCriterion criter)

cm

public long[][] cm(AUC.ThresholdCriterion criter)

F1

public double F1()

F2

public double F2()

F0point5

public double F0point5()

err

public double err()

precision

public double precision()

recall

public double recall()

specificity

public double specificity()

mcc

public double mcc()

accuracy

public double accuracy()

max_per_class_error

public double max_per_class_error()

threshold

public float threshold()

cm

public long[][] cm()

CM

public ConfusionMatrix CM()

bestF1

public double bestF1()

bestErr

public double bestErr()

init

protected void init()
             throws java.lang.IllegalArgumentException

Description copied from class: Func

Invoked before run. This is the place to checks arguments are valid or throw IllegalArgumentException. It will get invoked both from the Web and Java APIs.

Overrides:

init in class Func

Throws:

java.lang.IllegalArgumentException - throws the exception if initialization fails to ensure correct job runtime environment.

execImpl

protected void execImpl()

Description copied from class: Func

The real implementation which should be provided by ancestors.

Overrides:

execImpl in class Func

toHTML

public boolean toHTML(java.lang.StringBuilder sb)

Overrides:

toHTML in class Request

toASCII

public void toASCII(java.lang.StringBuilder sb)