hex.coxph

Class CoxPH

java.lang.Object

water.Iced

hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

hex.coxph.CoxPH

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

public class CoxPH
extends hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

Cox Proportional Hazards Model

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CoxPH.CoxPHDriver
protected static class	CoxPH.CoxPHTask

Nested classes/interfaces inherited from class hex.ModelBuilder

hex.ModelBuilder.BuilderVisibility, hex.ModelBuilder.Driver, hex.ModelBuilder.FilterCols, hex.ModelBuilder.ModelTrainingCoordinator, hex.ModelBuilder.ValidationMessage

Field Summary

Fields inherited from class hex.ModelBuilder

_coordinator, _desc, _eventPublisher, _fold, _input_parms, _job, _messages, _nclass, _offset, _orig_projection_array, _origDomains, _origNames, _origTrain, _parms, _priorClassDist, _removedCols, _response, _result, _startUpOnceModelBuilder, _train, _treatment, _valid, _vresponse, _weights

Constructor Summary

Constructors

Constructor and Description
CoxPH(boolean startup_once)
CoxPH(CoxPHModel.CoxPHParameters parms)

Method Summary

Modifier and Type	Method and Description
hex.ModelBuilder.BuilderVisibility	builderVisibility()
hex.ModelCategory[]	can_build()
boolean	hasStartColumn()
boolean	haveMojo()
protected int	init_getNClass()
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
boolean	isSupervised()
protected CoxPH.CoxPHDriver	trainModelImpl()
protected boolean	validateBinaryResponse()

Methods inherited from class hex.ModelBuilder

algoName, algos, canLearnFromNAs, checkCustomMetricForEarlyStopping, checkDistributions, checkEarlyStoppingReproducibility, checkMemoryFootPrint_impl, checkMemoryFootPrint, checkResponseVariable, clearInitState, clearValidationErrors, computeCrossValidation, computePriorClassDistribution, cv_buildModels, cv_canBuildMainModelInParallel, cv_computeAndSetOptimalParameters, cv_initStoppingParameters, cv_mainModelScores, cv_makeAggregateModelMetrics, cv_scoreCVModels, cv_updateOptimalParameters, defaultKey, desiredChunks, dest, error_count, error, get, getMessagesByFieldAndSeverity, getName, getSysProperty, getToEigenVec, hasFoldCol, hasOffsetCol, hasTreatmentCol, hasWeightCol, havePojo, hide, ignoreBadColumns, ignoreConstColumns, ignoreInvalidColumns, ignoreStringColumns, ignoreUuidColumns, info, init_adaptFrameToTrain, initWorkspace, isClassifier, isResponseOptional, isStopped, javaName, logMe, make, make, make, makeCVMetrics, makeCVModelBuilder, makeParameters, makePojoWriter, message, nclasses, nFoldCV, nFoldWork, nModelsInParallel, nModelsInParallel, nModelsInParallel, numSpecialCols, paramName, raiseReproducibilityWarning, rebalance, remainingTimeSecs, response, schemaDirectory, separateFeatureVecs, setMaxRuntimeSecsForMainModel, setTrain, setValid, shouldReorder, smallDataSize, stop_requested, timeout, train, trainModel, trainModel, trainModelNested, trainModelNested, trainModelOnH2ONode, valid, validateStoppingMetric, validationErrors, validationWarnings, vresponse, warn

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

Constructor Detail

CoxPH

public CoxPH(boolean startup_once)

CoxPH

public CoxPH(CoxPHModel.CoxPHParameters parms)

Method Detail

can_build

public hex.ModelCategory[] can_build()

Specified by:

can_build in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

builderVisibility

public hex.ModelBuilder.BuilderVisibility builderVisibility()

Overrides:

builderVisibility in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

isSupervised

public boolean isSupervised()

Specified by:

isSupervised in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

trainModelImpl

protected CoxPH.CoxPHDriver trainModelImpl()

Specified by:

trainModelImpl in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

haveMojo

public boolean haveMojo()

Overrides:

haveMojo in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

init

public void init(boolean expensive)

Initialize the ModelBuilder, validating all arguments and preparing the training frame. This call is expected to be overridden in the subclasses and each subclass will start with "super.init();". This call is made by the front-end whenever the GUI is clicked, and needs to be fast; heavy-weight prep needs to wait for the trainModel() call.

Overrides:

init in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

init_getNClass

protected int init_getNClass()

Overrides:

init_getNClass in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>

hasStartColumn

public boolean hasStartColumn()

validateBinaryResponse

protected boolean validateBinaryResponse()

Overrides:

validateBinaryResponse in class hex.ModelBuilder<CoxPHModel,CoxPHModel.CoxPHParameters,CoxPHModel.CoxPHOutput>