Class: AFTSurvivalRegression

eclairjs/ml/regression. AFTSurvivalRegression

new AFTSurvivalRegression(uidopt)

:: 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.
Parameters:
Name Type Attributes Description
uid string <optional>
 An immutable unique ID for the object and its derivatives.
Source:

Methods

(static) load(path) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
path string
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

censorCol() → {module:eclairjs/ml/param.Param}

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.
Source:
Returns:
Type
module:eclairjs/ml/param.Param

copy(extra) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
extra module:eclairjs/ml/param.ParamMap
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

fit(dataset) → {module:eclairjs/ml/regression.AFTSurvivalRegressionModel}

Parameters:
Name Type Description
dataset module:eclairjs/sql.Dataset
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegressionModel

getCensorCol() → {string}

Source:
Returns:
Type
string

getQuantileProbabilities() → {Array.<float>}

Source:
Returns:
Type
Array.<float>

getQuantilesCol() → {string}

Source:
Returns:
Type
string

hasQuantilesCol() → {boolean}

Checks whether the input has quantiles column name.
Source:
Returns:
Type
boolean

quantileProbabilities() → {module:eclairjs/ml/param.DoubleArrayParam}

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.
Source:
Returns:
Type
module:eclairjs/ml/param.DoubleArrayParam

quantilesCol() → {module:eclairjs/ml/param.Param}

Param for quantiles column name. This column will output quantiles of corresponding quantileProbabilities if it is set.
Source:
Returns:
Type
module:eclairjs/ml/param.Param

setCensorCol(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
value string
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setFeaturesCol(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
value string
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setFitIntercept(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Set if we should fit the intercept Default is true.
Parameters:
Name Type Description
value boolean
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setLabelCol(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
value string
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setMaxIter(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Set the maximum number of iterations. Default is 100.
Parameters:
Name Type Description
value integer
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setPredictionCol(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
value string
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setQuantileProbabilities(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
value Array.<float>
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setQuantilesCol(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Parameters:
Name Type Description
value string
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

setTol(value) → {module:eclairjs/ml/regression.AFTSurvivalRegression}

Set the convergence tolerance of iterations. Smaller value will lead to higher accuracy with the cost of more iterations. Default is 1E-6.
Parameters:
Name Type Description
value float
Source:
Returns:
Type
module:eclairjs/ml/regression.AFTSurvivalRegression

transformSchema(schema) → {module:eclairjs/sql/types.StructType}

Parameters:
Name Type Description
schema module:eclairjs/sql/types.StructType
Source:
Returns:
Type
module:eclairjs/sql/types.StructType

uid() → {string}

An immutable unique ID for the object and its derivatives.
Source:
Returns:
Type
string

validateAndTransformSchema(schema, fitting) → {module:eclairjs/sql/types.StructType}

Validates and transforms the input schema with the provided param map.
Parameters:
Name Type Description
schema module:eclairjs/sql/types.StructType input schema
fitting boolean whether this is in fitting or prediction
Source:
Returns:
Type
module:eclairjs/sql/types.StructType