AFTSurvivalRegressionParams (Spark 3.5.5 JavaDoc) (original) (raw)

• All Superinterfaces:
  HasAggregationDepth, HasFeaturesCol, HasFitIntercept, HasLabelCol, HasMaxBlockSizeInMB, HasMaxIter, HasPredictionCol, HasTol, Identifiable, org.apache.spark.internal.Logging, Params, PredictorParams, java.io.Serializable
  All Known Implementing Classes:
  AFTSurvivalRegression, AFTSurvivalRegressionModel

public interface AFTSurvivalRegressionParams
extends PredictorParams, HasMaxIter, HasTol, HasFitIntercept, HasAggregationDepth, HasMaxBlockSizeInMB, org.apache.spark.internal.Logging
Params for accelerated failure time (AFT) regression.

• • Nested Class Summary

     * ### Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging  
     `org.apache.spark.internal.Logging.SparkShellLoggingFilter`  

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method and Description
  Param	censorCol() Param for censor column name.
  String	getCensorCol()
  double[]	getQuantileProbabilities()
  String	getQuantilesCol()
  boolean	hasQuantilesCol() Checks whether the input has quantiles column name.
  DoubleArrayParam	quantileProbabilities() Param for quantile probabilities array.
  Param	quantilesCol() Param for quantiles column name.
  StructType	validateAndTransformSchema(StructType schema, boolean fitting) Validates and transforms the input schema with the provided param map.

     * ### Methods inherited from interface org.apache.spark.ml.[PredictorParams](../../../../../org/apache/spark/ml/PredictorParams.html "interface in org.apache.spark.ml")  
     `[validateAndTransformSchema](../../../../../org/apache/spark/ml/PredictorParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html "interface in org.apache.spark.ml.param.shared")  
     `[getLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#getLabelCol--), [labelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#labelCol--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html "interface in org.apache.spark.ml.param.shared")  
     `[featuresCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#featuresCol--), [getFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#getFeaturesCol--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html "interface in org.apache.spark.ml.param.shared")  
     `[getPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#getPredictionCol--), [predictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#predictionCol--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")  
     `[clear](../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-), [copy](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-), [copyValues](../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-), [defaultCopy](../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-), [defaultParamMap](../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--), [explainParam](../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-), [explainParams](../../../../../org/apache/spark/ml/param/Params.html#explainParams--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-), [get](../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-), [getDefault](../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-), [getOrDefault](../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-), [getParam](../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-), [hasDefault](../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-), [hasParam](../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-), [isDefined](../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-), [isSet](../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-), [onParamChange](../../../../../org/apache/spark/ml/param/Params.html#onParamChange-org.apache.spark.ml.param.Param-), [paramMap](../../../../../org/apache/spark/ml/param/Params.html#paramMap--), [params](../../../../../org/apache/spark/ml/param/Params.html#params--), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-), [shouldOwn](../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-)`  
     * ### Methods inherited from interface org.apache.spark.ml.util.[Identifiable](../../../../../org/apache/spark/ml/util/Identifiable.html "interface in org.apache.spark.ml.util")  
     `[toString](../../../../../org/apache/spark/ml/util/Identifiable.html#toString--), [uid](../../../../../org/apache/spark/ml/util/Identifiable.html#uid--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html "interface in org.apache.spark.ml.param.shared")  
     `[getMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#getMaxIter--), [maxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#maxIter--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasTol](../../../../../org/apache/spark/ml/param/shared/HasTol.html "interface in org.apache.spark.ml.param.shared")  
     `[getTol](../../../../../org/apache/spark/ml/param/shared/HasTol.html#getTol--), [tol](../../../../../org/apache/spark/ml/param/shared/HasTol.html#tol--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasFitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html "interface in org.apache.spark.ml.param.shared")  
     `[fitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#fitIntercept--), [getFitIntercept](../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#getFitIntercept--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasAggregationDepth](../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html "interface in org.apache.spark.ml.param.shared")  
     `[aggregationDepth](../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html#aggregationDepth--), [getAggregationDepth](../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html#getAggregationDepth--)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasMaxBlockSizeInMB](../../../../../org/apache/spark/ml/param/shared/HasMaxBlockSizeInMB.html "interface in org.apache.spark.ml.param.shared")  
     `[getMaxBlockSizeInMB](../../../../../org/apache/spark/ml/param/shared/HasMaxBlockSizeInMB.html#getMaxBlockSizeInMB--), [maxBlockSizeInMB](../../../../../org/apache/spark/ml/param/shared/HasMaxBlockSizeInMB.html#maxBlockSizeInMB--)`  
     * ### Methods inherited from interface org.apache.spark.internal.Logging  
     `$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize`

• • Method Detail

     * #### censorCol  
     [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<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  
     String getCensorCol()  
     * #### getQuantileProbabilities  
     double[] getQuantileProbabilities()  
     * #### getQuantilesCol  
     String getQuantilesCol()  
     * #### hasQuantilesCol  
     boolean hasQuantilesCol()  
     Checks whether the input has quantiles column name.  
     * #### quantileProbabilities  
     [DoubleArrayParam](../../../../../org/apache/spark/ml/param/DoubleArrayParam.html "class in org.apache.spark.ml.param") 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)  
     * #### quantilesCol  
     [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> quantilesCol()  
     Param for quantiles column name. This column will output quantiles of corresponding quantileProbabilities if it is set.  
     Returns:  
     (undocumented)  
     * #### validateAndTransformSchema  
     [StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") validateAndTransformSchema([StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") 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