org.apache.spark.ml.regression
AFTSurvivalRegressionModel
Companion object AFTSurvivalRegressionModel
class AFTSurvivalRegressionModel extends RegressionModel[Vector, AFTSurvivalRegressionModel] with AFTSurvivalRegressionParams with MLWritable
Model produced by AFTSurvivalRegression.
- Annotations
- @Since("1.6.0")
- Source
- AFTSurvivalRegression.scala
- Grouped
- Alphabetic
- By Inheritance
- AFTSurvivalRegressionModel
- MLWritable
- AFTSurvivalRegressionParams
- HasMaxBlockSizeInMB
- HasAggregationDepth
- HasFitIntercept
- HasTol
- HasMaxIter
- RegressionModel
- PredictionModel
- PredictorParams
- HasPredictionCol
- HasFeaturesCol
- HasLabelCol
- Model
- Transformer
- PipelineStage
- Logging
- Params
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- implicit class LogStringContext extends AnyRef
- Definition Classes
- Logging
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def $[T](param: Param[T]): T
An alias for
getOrDefault().An alias for
getOrDefault().- Attributes
- protected
- Definition Classes
- Params
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def MDC(key: LogKey, value: Any): MDC
- Attributes
- protected
- Definition Classes
- Logging
- final val aggregationDepth: IntParam
Param for suggested depth for treeAggregate (>= 2).
Param for suggested depth for treeAggregate (>= 2).
- Definition Classes
- HasAggregationDepth
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final val censorCol: Param[String]
Param for censor column name.
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.
- Definition Classes
- AFTSurvivalRegressionParams
- Annotations
- @Since("1.6.0")
- final def clear(param: Param[_]): AFTSurvivalRegressionModel.this.type
Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.
- Definition Classes
- Params
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val coefficients: Vector
- Annotations
- @Since("2.0.0")
- def copy(extra: ParamMap): AFTSurvivalRegressionModel
Creates a copy of this instance with the same UID and some extra 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. See
defaultCopy().- Definition Classes
- AFTSurvivalRegressionModel → Model → Transformer → PipelineStage → Params
- Annotations
- @Since("1.6.0")
- def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T
Copies param values from this instance to another instance for params shared by them.
Copies param values from this instance to another instance for params shared by them.
This handles default Params and explicitly set Params separately. Default Params are copied from and to
defaultParamMap, and explicitly set Params are copied from and toparamMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.- to
the target instance, which should work with the same set of default Params as this source instance
- extra
extra params to be copied to the target's
paramMap- returns
the target instance with param values copied
- Attributes
- protected
- Definition Classes
- Params
- final def defaultCopy[T <: Params](extra: ParamMap): T
Default implementation of copy with extra params.
Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.
- Attributes
- protected
- Definition Classes
- Params
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def explainParam(param: Param[_]): String
Explains a param.
Explains a param.
- param
input param, must belong to this instance.
- returns
a string that contains the input param name, doc, and optionally its default value and the user-supplied value
- Definition Classes
- Params
- def explainParams(): String
Explains all params of this instance.
Explains all params of this instance. See
explainParam().- Definition Classes
- Params
- final def extractParamMap(): ParamMap
extractParamMapwith no extra values.extractParamMapwith no extra values.- Definition Classes
- Params
- final def extractParamMap(extra: ParamMap): ParamMap
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.
- Definition Classes
- Params
- final val featuresCol: Param[String]
Param for features column name.
Param for features column name.
- Definition Classes
- HasFeaturesCol
- def featuresDataType: DataType
Returns the SQL DataType corresponding to the FeaturesType type parameter.
Returns the SQL DataType corresponding to the FeaturesType type parameter.
This is used by
validateAndTransformSchema(). This workaround is needed since SQL has different APIs for Scala and Java.The default value is VectorUDT, but it may be overridden if FeaturesType is not Vector.
- Attributes
- protected
- Definition Classes
- PredictionModel
- final val fitIntercept: BooleanParam
Param for whether to fit an intercept term.
Param for whether to fit an intercept term.
- Definition Classes
- HasFitIntercept
- final def get[T](param: Param[T]): Option[T]
Optionally returns the user-supplied value of a param.
Optionally returns the user-supplied value of a param.
- Definition Classes
- Params
- final def getAggregationDepth: Int
- Definition Classes
- HasAggregationDepth
- def getCensorCol: String
- Definition Classes
- AFTSurvivalRegressionParams
- Annotations
- @Since("1.6.0")
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def getDefault[T](param: Param[T]): Option[T]
Gets the default value of a parameter.
Gets the default value of a parameter.
- Definition Classes
- Params
- final def getFeaturesCol: String
- Definition Classes
- HasFeaturesCol
- final def getFitIntercept: Boolean
- Definition Classes
- HasFitIntercept
- final def getLabelCol: String
- Definition Classes
- HasLabelCol
- final def getMaxBlockSizeInMB: Double
- Definition Classes
- HasMaxBlockSizeInMB
- final def getMaxIter: Int
- Definition Classes
- HasMaxIter
- final def getOrDefault[T](param: Param[T]): T
Gets the value of a param in the embedded param map or its default value.
Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.
- Definition Classes
- Params
- def getParam(paramName: String): Param[Any]
Gets a param by its name.
Gets a param by its name.
- Definition Classes
- Params
- final def getPredictionCol: String
- Definition Classes
- HasPredictionCol
- def getQuantileProbabilities: Array[Double]
- Definition Classes
- AFTSurvivalRegressionParams
- Annotations
- @Since("1.6.0")
- def getQuantilesCol: String
- Definition Classes
- AFTSurvivalRegressionParams
- Annotations
- @Since("1.6.0")
- final def getTol: Double
- Definition Classes
- HasTol
- final def hasDefault[T](param: Param[T]): Boolean
Tests whether the input param has a default value set.
Tests whether the input param has a default value set.
- Definition Classes
- Params
- def hasParam(paramName: String): Boolean
Tests whether this instance contains a param with a given name.
Tests whether this instance contains a param with a given name.
- Definition Classes
- Params
- def hasParent: Boolean
Indicates whether this Model has a corresponding parent.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
- Attributes
- protected
- Definition Classes
- Logging
- def initializeLogIfNecessary(isInterpreter: Boolean): Unit
- Attributes
- protected
- Definition Classes
- Logging
- val intercept: Double
- Annotations
- @Since("1.6.0")
- final def isDefined(param: Param[_]): Boolean
Checks whether a param is explicitly set or has a default value.
Checks whether a param is explicitly set or has a default value.
- Definition Classes
- Params
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def isSet(param: Param[_]): Boolean
Checks whether a param is explicitly set.
Checks whether a param is explicitly set.
- Definition Classes
- Params
- def isTraceEnabled(): Boolean
- Attributes
- protected
- Definition Classes
- Logging
- final val labelCol: Param[String]
Param for label column name.
Param for label column name.
- Definition Classes
- HasLabelCol
- def log: Logger
- Attributes
- protected
- Definition Classes
- Logging
- def logBasedOnLevel(level: Level)(f: => MessageWithContext): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logName: String
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- final val maxBlockSizeInMB: DoubleParam
Param for Maximum memory in MB for stacking input data into blocks.
Param for Maximum memory in MB for stacking input data into blocks. Data is stacked within partitions. If more than remaining data size in a partition then it is adjusted to the data size. Default 0.0 represents choosing optimal value, depends on specific algorithm. Must be >= 0..
- Definition Classes
- HasMaxBlockSizeInMB
- final val maxIter: IntParam
Param for maximum number of iterations (>= 0).
Param for maximum number of iterations (>= 0).
- Definition Classes
- HasMaxIter
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def numFeatures: Int
Returns the number of features the model was trained on.
Returns the number of features the model was trained on. If unknown, returns -1
- Definition Classes
- AFTSurvivalRegressionModel → PredictionModel
- Annotations
- @Since("3.0.0")
- lazy val params: Array[Param[_]]
Returns all params sorted by their names.
Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.
- Definition Classes
- Params
- Note
Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.
- var parent: Estimator[AFTSurvivalRegressionModel]
The parent estimator that produced this model.
The parent estimator that produced this model.
- Definition Classes
- Model
- Note
For ensembles' component Models, this value can be null.
- def predict(features: Vector): Double
Predict label for the given features.
Predict label for the given features. This method is used to implement
transform()and output predictionCol.- Definition Classes
- AFTSurvivalRegressionModel → PredictionModel
- Annotations
- @Since("2.0.0")
- def predictQuantiles(features: Vector): Vector
- Annotations
- @Since("2.0.0")
- final val predictionCol: Param[String]
Param for prediction column name.
Param for prediction column name.
- Definition Classes
- HasPredictionCol
- final val quantileProbabilities: DoubleArrayParam
Param for quantile probabilities array.
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.
- Definition Classes
- AFTSurvivalRegressionParams
- Annotations
- @Since("1.6.0")
- final val quantilesCol: Param[String]
Param for quantiles column name.
Param for quantiles column name. This column will output quantiles of corresponding quantileProbabilities if it is set.
- Definition Classes
- AFTSurvivalRegressionParams
- Annotations
- @Since("1.6.0")
- def save(path: String): Unit
Saves this ML instance to the input path, a shortcut of
write.save(path).Saves this ML instance to the input path, a shortcut of
write.save(path).- Definition Classes
- MLWritable
- Annotations
- @Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")
- val scale: Double
- Annotations
- @Since("1.6.0")
- final def set(paramPair: ParamPair[_]): AFTSurvivalRegressionModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
- Attributes
- protected
- Definition Classes
- Params
- final def set(param: String, value: Any): AFTSurvivalRegressionModel.this.type
Sets a parameter (by name) in the embedded param map.
Sets a parameter (by name) in the embedded param map.
- Attributes
- protected
- Definition Classes
- Params
- final def set[T](param: Param[T], value: T): AFTSurvivalRegressionModel.this.type
Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.
- Definition Classes
- Params
- final def setDefault(paramPairs: ParamPair[_]*): AFTSurvivalRegressionModel.this.type
Sets default values for a list of params.
Sets default values for a list of params.
Note: Java developers should use the single-parameter
setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.- paramPairs
a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.
- Attributes
- protected
- Definition Classes
- Params
- final def setDefault[T](param: Param[T], value: T): AFTSurvivalRegressionModel.this.type
Sets a default value for a param.
- def setFeaturesCol(value: String): AFTSurvivalRegressionModel
- Definition Classes
- PredictionModel
- def setParent(parent: Estimator[AFTSurvivalRegressionModel]): AFTSurvivalRegressionModel
Sets the parent of this model (Java API).
Sets the parent of this model (Java API).
- Definition Classes
- Model
- def setPredictionCol(value: String): AFTSurvivalRegressionModel
- Definition Classes
- PredictionModel
- def setQuantileProbabilities(value: Array[Double]): AFTSurvivalRegressionModel.this.type
- Annotations
- @Since("1.6.0")
- def setQuantilesCol(value: String): AFTSurvivalRegressionModel.this.type
- Annotations
- @Since("1.6.0")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AFTSurvivalRegressionModel → Identifiable → AnyRef → Any
- Annotations
- @Since("3.0.0")
- final val tol: DoubleParam
Param for the convergence tolerance for iterative algorithms (>= 0).
Param for the convergence tolerance for iterative algorithms (>= 0).
- Definition Classes
- HasTol
- def transform(dataset: Dataset[_]): DataFrame
Transforms dataset by reading from featuresCol, calling
predict, and storing the predictions as a new column predictionCol.Transforms dataset by reading from featuresCol, calling
predict, and storing the predictions as a new column predictionCol.- dataset
input dataset
- returns
transformed dataset with predictionCol of type
Double
- Definition Classes
- AFTSurvivalRegressionModel → PredictionModel → Transformer
- Annotations
- @Since("2.0.0")
- def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
Transforms the dataset with provided parameter map as additional parameters.
Transforms the dataset with provided parameter map as additional parameters.
- dataset
input dataset
- paramMap
additional parameters, overwrite embedded params
- returns
transformed dataset
- Definition Classes
- Transformer
- Annotations
- @Since("2.0.0")
- def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
Transforms the dataset with optional parameters
Transforms the dataset with optional parameters
- dataset
input dataset
- firstParamPair
the first param pair, overwrite embedded params
- otherParamPairs
other param pairs, overwrite embedded params
- returns
transformed dataset
- Definition Classes
- Transformer
- Annotations
- @Since("2.0.0") @varargs()
- def transformImpl(dataset: Dataset[_]): DataFrame
- Attributes
- protected
- Definition Classes
- PredictionModel
- def transformSchema(schema: StructType): StructType
Check transform validity and derive the output schema from the input schema.
Check transform validity and derive the output schema from the input schema.
We check validity for interactions between parameters during
transformSchemaand raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled byParam.validate().Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.
- Definition Classes
- AFTSurvivalRegressionModel → PredictionModel → PipelineStage
- Annotations
- @Since("1.6.0")
- def transformSchema(schema: StructType, logging: Boolean): StructType
:: DeveloperApi ::
:: DeveloperApi ::
Derives the output schema from the input schema and parameters, optionally with logging.
This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.
- Attributes
- protected
- Definition Classes
- PipelineStage
- Annotations
- @DeveloperApi()
- val uid: String
An immutable unique ID for the object and its derivatives.
An immutable unique ID for the object and its derivatives.
- Definition Classes
- AFTSurvivalRegressionModel → Identifiable
- Annotations
- @Since("1.6.0")
- def validateAndTransformSchema(schema: StructType, fitting: Boolean): StructType
Validates and transforms the input schema with the provided param map.
Validates and transforms the input schema with the provided param map.
- schema
input schema
- fitting
whether this is in fitting or prediction
- returns
output schema
- Attributes
- protected
- Definition Classes
- AFTSurvivalRegressionParams
- def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
Validates and transforms the input schema with the provided param map.
Validates and transforms the input schema with the provided param map.
- schema
input schema
- fitting
whether this is in fitting
- featuresDataType
SQL DataType for FeaturesType. E.g.,
VectorUDTfor vector features.- returns
output schema
- Attributes
- protected
- Definition Classes
- PredictorParams
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withLogContext(context: Map[String, String])(body: => Unit): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def write: MLWriter
Returns an
MLWriterinstance for this ML instance.Returns an
MLWriterinstance for this ML instance.- Definition Classes
- AFTSurvivalRegressionModel → MLWritable
- Annotations
- @Since("1.6.0")
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
Inherited from MLWritable
Inherited from AFTSurvivalRegressionParams
Inherited from HasMaxBlockSizeInMB
Inherited from HasAggregationDepth
Inherited from HasFitIntercept
Inherited from HasTol
Inherited from HasMaxIter
Inherited from RegressionModel[Vector, AFTSurvivalRegressionModel]
Inherited from PredictionModel[Vector, AFTSurvivalRegressionModel]
Inherited from PredictorParams
Inherited from HasPredictionCol
Inherited from HasFeaturesCol
Inherited from HasLabelCol
Inherited from Model[AFTSurvivalRegressionModel]
Inherited from Transformer
Inherited from PipelineStage
Inherited from Logging
Inherited from Params
Inherited from Serializable
Inherited from Identifiable
Inherited from AnyRef
Inherited from Any
Parameters
A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.
Members
Parameter setters
Parameter getters
(expert-only) Parameters
A list of advanced, expert-only (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.