org.apache.spark.ml.regression

Class AFTSurvivalRegression

java.lang.Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<AFTSurvivalRegressionModel>

org.apache.spark.ml.regression.AFTSurvivalRegression

All Implemented Interfaces:

java.io.Serializable, Params, Identifiable

public class AFTSurvivalRegression
extends Estimator<AFTSurvivalRegressionModel>

:: Experimental :: Fit a parametric survival regression model named accelerated failure time (AFT) model (https://en.wikipedia.org/wiki/Accelerated_failure_time_model) based on the Weibull distribution of the survival time.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AFTSurvivalRegression()
AFTSurvivalRegression(java.lang.String uid)

Method Summary

Methods

Modifier and Type	Method and Description
protected static <T> T	$(Param<T> param)
static Param<java.lang.String>	censorCol()
Param<java.lang.String>	censorCol() Param for censor column name.
static Params	clear(Param<?> param)
AFTSurvivalRegression	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
protected static <T extends Params> T	copyValues(T to, ParamMap extra)
protected static <T extends Params> ParamMap	copyValues$default$2()
protected static <T extends Params> T	defaultCopy(ParamMap extra)
static java.lang.String	explainParam(Param<?> param)
static java.lang.String	explainParams()
protected RDD<org.apache.spark.ml.regression.AFTPoint>	extractAFTPoints(Dataset<?> dataset) Extract featuresCol, labelCol and censorCol from input dataset, and put it in an RDD with strong types.
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static Param<java.lang.String>	featuresCol()
AFTSurvivalRegressionModel	fit(Dataset<?> dataset) Fits a model to the input data.
static BooleanParam	fitIntercept()
static <T> scala.Option<T>	get(Param<T> param)
static java.lang.String	getCensorCol()
java.lang.String	getCensorCol()
static <T> scala.Option<T>	getDefault(Param<T> param)
static java.lang.String	getFeaturesCol()
static boolean	getFitIntercept()
static java.lang.String	getLabelCol()
static int	getMaxIter()
static <T> T	getOrDefault(Param<T> param)
static Param<java.lang.Object>	getParam(java.lang.String paramName)
static java.lang.String	getPredictionCol()
static double[]	getQuantileProbabilities()
double[]	getQuantileProbabilities()
static java.lang.String	getQuantilesCol()
java.lang.String	getQuantilesCol()
static double	getTol()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(java.lang.String paramName)
protected static boolean	hasQuantilesCol()
boolean	hasQuantilesCol() Checks whether the input has quantiles column name.
protected static void	initializeLogIfNecessary(boolean isInterpreter)
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
protected static boolean	isTraceEnabled()
static Param<java.lang.String>	labelCol()
static AFTSurvivalRegression	load(java.lang.String path)
protected static org.slf4j.Logger	log()
protected static void	logDebug(scala.Function0<java.lang.String> msg)
protected static void	logDebug(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logError(scala.Function0<java.lang.String> msg)
protected static void	logError(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logInfo(scala.Function0<java.lang.String> msg)
protected static void	logInfo(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static java.lang.String	logName()
protected static void	logTrace(scala.Function0<java.lang.String> msg)
protected static void	logTrace(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logWarning(scala.Function0<java.lang.String> msg)
protected static void	logWarning(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
static IntParam	maxIter()
static Param<?>[]	params()
static Param<java.lang.String>	predictionCol()
static DoubleArrayParam	quantileProbabilities()
DoubleArrayParam	quantileProbabilities() Param for quantile probabilities array.
static Param<java.lang.String>	quantilesCol()
Param<java.lang.String>	quantilesCol() Param for quantiles column name.
static void	save(java.lang.String path)
static <T> Params	set(Param<T> param, T value)
protected static Params	set(ParamPair<?> paramPair)
protected static Params	set(java.lang.String param, java.lang.Object value)
AFTSurvivalRegression	setCensorCol(java.lang.String value)
protected static <T> Params	setDefault(Param<T> param, T value)
protected static Params	setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)
AFTSurvivalRegression	setFeaturesCol(java.lang.String value)
AFTSurvivalRegression	setFitIntercept(boolean value) Set if we should fit the intercept Default is true.
AFTSurvivalRegression	setLabelCol(java.lang.String value)
AFTSurvivalRegression	setMaxIter(int value) Set the maximum number of iterations.
AFTSurvivalRegression	setPredictionCol(java.lang.String value)
AFTSurvivalRegression	setQuantileProbabilities(double[] value)
AFTSurvivalRegression	setQuantilesCol(java.lang.String value)
AFTSurvivalRegression	setTol(double value) Set the convergence tolerance of iterations.
static DoubleParam	tol()
static java.lang.String	toString()
StructType	transformSchema(StructType schema) :: DeveloperApi ::
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
protected static StructType	validateAndTransformSchema(StructType schema, boolean fitting)
StructType	validateAndTransformSchema(StructType schema, boolean fitting) Validates and transforms the input schema with the provided param map.
static void	validateParams()
static MLWriter	write()

Methods inherited from class org.apache.spark.ml.Estimator

fit, fit, fit, fit

Methods inherited from class org.apache.spark.ml.PipelineStage

transformSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Constructor Detail

AFTSurvivalRegression

public AFTSurvivalRegression(java.lang.String uid)

AFTSurvivalRegression

public AFTSurvivalRegression()

Method Detail

load

public static AFTSurvivalRegression load(java.lang.String path)

toString

public static java.lang.String toString()

params

public static Param<?>[] params()

validateParams

public static void validateParams()

explainParam

public static java.lang.String explainParam(Param<?> param)

explainParams

public static java.lang.String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(java.lang.String paramName)

getParam

public static Param<java.lang.Object> getParam(java.lang.String paramName)

set

public static final <T> Params set(Param<T> param,
             T value)

set

protected static final Params set(java.lang.String param,
         java.lang.Object value)

set

protected static final Params set(ParamPair<?> paramPair)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

$

protected static final <T> T $(Param<T> param)

setDefault

protected static final <T> Params setDefault(Param<T> param,
                    T value)

setDefault

protected static final Params setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

defaultCopy

protected static final <T extends Params> T defaultCopy(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

copyValues

protected static <T extends Params> T copyValues(T to,
                              ParamMap extra)

copyValues$default$2

protected static <T extends Params> ParamMap copyValues$default$2()

logName

protected static java.lang.String logName()

log

protected static org.slf4j.Logger log()

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg)

logError

protected static void logError(scala.Function0<java.lang.String> msg)

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg,
           java.lang.Throwable throwable)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg,
              java.lang.Throwable throwable)

logError

protected static void logError(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

isTraceEnabled

protected static boolean isTraceEnabled()

initializeLogIfNecessary

protected static void initializeLogIfNecessary(boolean isInterpreter)

featuresCol

public static final Param<java.lang.String> featuresCol()

getFeaturesCol

public static final java.lang.String getFeaturesCol()

labelCol

public static final Param<java.lang.String> labelCol()

getLabelCol

public static final java.lang.String getLabelCol()

predictionCol

public static final Param<java.lang.String> predictionCol()

getPredictionCol

public static final java.lang.String getPredictionCol()

maxIter

public static final IntParam maxIter()

getMaxIter

public static final int getMaxIter()

tol

public static final DoubleParam tol()

getTol

public static final double getTol()

fitIntercept

public static final BooleanParam fitIntercept()

getFitIntercept

public static final boolean getFitIntercept()

censorCol

public static final Param<java.lang.String> censorCol()

getCensorCol

public static java.lang.String getCensorCol()

quantileProbabilities

public static final DoubleArrayParam quantileProbabilities()

getQuantileProbabilities

public static double[] getQuantileProbabilities()

quantilesCol

public static final Param<java.lang.String> quantilesCol()

getQuantilesCol

public static java.lang.String getQuantilesCol()

hasQuantilesCol

protected static boolean hasQuantilesCol()

validateAndTransformSchema

protected static StructType validateAndTransformSchema(StructType schema,
                                    boolean fitting)

save

public static void save(java.lang.String path)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public static MLWriter write()

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

setFeaturesCol

public AFTSurvivalRegression setFeaturesCol(java.lang.String value)

setLabelCol

public AFTSurvivalRegression setLabelCol(java.lang.String value)

setCensorCol

public AFTSurvivalRegression setCensorCol(java.lang.String value)

setPredictionCol

public AFTSurvivalRegression setPredictionCol(java.lang.String value)

setQuantileProbabilities

public AFTSurvivalRegression setQuantileProbabilities(double[] value)

setQuantilesCol

public AFTSurvivalRegression setQuantilesCol(java.lang.String value)

setFitIntercept

public AFTSurvivalRegression setFitIntercept(boolean value)

Set if we should fit the intercept Default is true.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMaxIter

public AFTSurvivalRegression setMaxIter(int value)

Set the maximum number of iterations. Default is 100.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setTol

public AFTSurvivalRegression setTol(double value)

Set the convergence tolerance of iterations. Smaller value will lead to higher accuracy with the cost of more iterations. Default is 1E-6.

Parameters:

value - (undocumented)

Returns:

(undocumented)

extractAFTPoints

protected RDD<org.apache.spark.ml.regression.AFTPoint> extractAFTPoints(Dataset<?> dataset)

Extract featuresCol, labelCol and censorCol from input dataset, and put it in an RDD with strong types.

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

fit

public AFTSurvivalRegressionModel fit(Dataset<?> dataset)

Description copied from class: Estimator

Fits a model to the input data.

Specified by:

fit in class Estimator<AFTSurvivalRegressionModel>

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public AFTSurvivalRegression copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly.

Specified by:

copy in interface Params

Specified by:

copy in class Estimator<AFTSurvivalRegressionModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

censorCol

public Param<java.lang.String> censorCol()

Param for censor column name. The value of this column could be 0 or 1. If the value is 1, it means the event has occurred i.e. uncensored; otherwise censored.

Returns:

(undocumented)

getCensorCol

public java.lang.String getCensorCol()

quantileProbabilities

public DoubleArrayParam quantileProbabilities()

Param for quantile probabilities array. Values of the quantile probabilities array should be in the range (0, 1) and the array should be non-empty.

Returns:

(undocumented)

getQuantileProbabilities

public double[] getQuantileProbabilities()

quantilesCol

public Param<java.lang.String> quantilesCol()

Param for quantiles column name. This column will output quantiles of corresponding quantileProbabilities if it is set.

Returns:

(undocumented)

getQuantilesCol

public java.lang.String getQuantilesCol()

hasQuantilesCol

public boolean hasQuantilesCol()

Checks whether the input has quantiles column name.

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema,
                                    boolean fitting)

Validates and transforms the input schema with the provided param map.

Parameters:

schema - input schema

fitting - whether this is in fitting or prediction

Returns:

output schema