IsotonicRegressionModel (Spark 3.5.5 JavaDoc) (original) (raw)

Object
- org.apache.spark.ml.PipelineStage
- - org.apache.spark.ml.Transformer
    - - org.apache.spark.ml.Model<IsotonicRegressionModel>
        * * org.apache.spark.ml.regression.IsotonicRegressionModel
All Implemented Interfaces:
java.io.Serializable, org.apache.spark.internal.Logging, Params, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasWeightCol, IsotonicRegressionBase, Identifiable, MLWritable

public class IsotonicRegressionModel
extends Model<IsotonicRegressionModel>
implements IsotonicRegressionBase, MLWritable
Model fitted by IsotonicRegression. Predicts using a piecewise linear function.
For detailed rules see org.apache.spark.mllib.regression.IsotonicRegressionModel.predict().
param: oldModel A IsotonicRegressionModel model trained by IsotonicRegression.
See Also:
Serialized Form

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method and Description
Vector	boundaries() Boundaries in increasing order for which predictions are known.
IsotonicRegressionModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
IntParam	featureIndex() Param for the index of the feature if featuresCol is a vector column (default: 0), no effect otherwise.
Param	featuresCol() Param for features column name.
BooleanParam	isotonic() Param for whether the output sequence should be isotonic/increasing (true) or antitonic/decreasing (false).
Param	labelCol() Param for label column name.
static IsotonicRegressionModel	load(String path)
int	numFeatures()
double	predict(double value)
Param	predictionCol() Param for prediction column name.
Vector	predictions() Predictions associated with the boundaries at the same index, monotone because of isotonic regression.
static MLReader<IsotonicRegressionModel>	read()
IsotonicRegressionModel	setFeatureIndex(int value)
IsotonicRegressionModel	setFeaturesCol(String value)
IsotonicRegressionModel	setPredictionCol(String value)
String	toString()
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) Check transform validity and derive the output schema from the input schema.
String	uid() An immutable unique ID for the object and its derivatives.
Param	weightCol() Param for weight column name.
MLWriter	write() Returns an MLWriter instance for this ML instance.

   * ### Methods inherited from class org.apache.spark.ml.[Model](../../../../../org/apache/spark/ml/Model.html "class in org.apache.spark.ml")  
   `[hasParent](../../../../../org/apache/spark/ml/Model.html#hasParent--), [parent](../../../../../org/apache/spark/ml/Model.html#parent--), [setParent](../../../../../org/apache/spark/ml/Model.html#setParent-org.apache.spark.ml.Estimator-)`  
   * ### Methods inherited from class org.apache.spark.ml.[Transformer](../../../../../org/apache/spark/ml/Transformer.html "class in org.apache.spark.ml")  
   `[transform](../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-), [transform](../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-), [transform](../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-)`  
   * ### Methods inherited from class org.apache.spark.ml.[PipelineStage](../../../../../org/apache/spark/ml/PipelineStage.html "class in org.apache.spark.ml")  
   `[params](../../../../../org/apache/spark/ml/PipelineStage.html#params--)`  
   * ### Methods inherited from class Object  
   `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`  
   * ### Methods inherited from interface org.apache.spark.ml.regression.[IsotonicRegressionBase](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html "interface in org.apache.spark.ml.regression")  
   `[extractWeightedLabeledPoints](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html#extractWeightedLabeledPoints-org.apache.spark.sql.Dataset-), [getFeatureIndex](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html#getFeatureIndex--), [getIsotonic](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html#getIsotonic--), [hasWeightCol](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html#hasWeightCol--), [validateAndTransformSchema](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-)`  
   * ### 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")  
   `[getFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#getFeaturesCol--)`  
   * ### 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--)`  
   * ### 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html "interface in org.apache.spark.ml.param.shared")  
   `[getWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#getWeightCol--)`  
   * ### 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-), [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.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`  
   * ### Methods inherited from interface org.apache.spark.ml.util.[MLWritable](../../../../../org/apache/spark/ml/util/MLWritable.html "interface in org.apache.spark.ml.util")  
   `[save](../../../../../org/apache/spark/ml/util/MLWritable.html#save-java.lang.String-)`

Method Detail

 * #### read  
 public static [MLReader](../../../../../org/apache/spark/ml/util/MLReader.html "class in org.apache.spark.ml.util")<[IsotonicRegressionModel](../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html "class in org.apache.spark.ml.regression")> read()  
 * #### load  
 public static [IsotonicRegressionModel](../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html "class in org.apache.spark.ml.regression") load(String path)  
 * #### isotonic  
 public final [BooleanParam](../../../../../org/apache/spark/ml/param/BooleanParam.html "class in org.apache.spark.ml.param") isotonic()  
 Param for whether the output sequence should be isotonic/increasing (true) or antitonic/decreasing (false). Default: true  
 Specified by:  
 `[isotonic](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html#isotonic--)` in interface `[IsotonicRegressionBase](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html "interface in org.apache.spark.ml.regression")`  
 Returns:  
 (undocumented)  
 * #### featureIndex  
 public final [IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param") featureIndex()  
 Param for the index of the feature if `featuresCol` is a vector column (default: `0`), no effect otherwise.  
 Specified by:  
 `[featureIndex](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html#featureIndex--)` in interface `[IsotonicRegressionBase](../../../../../org/apache/spark/ml/regression/IsotonicRegressionBase.html "interface in org.apache.spark.ml.regression")`  
 Returns:  
 (undocumented)  
 * #### weightCol  
 public final [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> weightCol()  
 Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.  
 Specified by:  
 `[weightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#weightCol--)` in interface `[HasWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### predictionCol  
 public final [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> predictionCol()  
 Param for prediction column name.  
 Specified by:  
 `[predictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#predictionCol--)` in interface `[HasPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### labelCol  
 public final [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> labelCol()  
 Description copied from interface: `[HasLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#labelCol--)`  
 Param for label column name.  
 Specified by:  
 `[labelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#labelCol--)` in interface `[HasLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### featuresCol  
 public final [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String> featuresCol()  
 Param for features column name.  
 Specified by:  
 `[featuresCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#featuresCol--)` in interface `[HasFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html "interface in org.apache.spark.ml.param.shared")`  
 Returns:  
 (undocumented)  
 * #### uid  
 public String uid()  
 An immutable unique ID for the object and its derivatives.  
 Specified by:  
 `[uid](../../../../../org/apache/spark/ml/util/Identifiable.html#uid--)` in interface `[Identifiable](../../../../../org/apache/spark/ml/util/Identifiable.html "interface in org.apache.spark.ml.util")`  
 Returns:  
 (undocumented)  
 * #### setFeaturesCol  
 public [IsotonicRegressionModel](../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html "class in org.apache.spark.ml.regression") setFeaturesCol(String value)  
 * #### setPredictionCol  
 public [IsotonicRegressionModel](../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html "class in org.apache.spark.ml.regression") setPredictionCol(String value)  
 * #### setFeatureIndex  
 public [IsotonicRegressionModel](../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html "class in org.apache.spark.ml.regression") setFeatureIndex(int value)  
 * #### boundaries  
 public [Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg") boundaries()  
 Boundaries in increasing order for which predictions are known.  
 * #### predictions  
 public [Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg") predictions()  
 Predictions associated with the boundaries at the same index, monotone because of isotonic regression.  
 Returns:  
 (undocumented)  
 * #### copy  
 public [IsotonicRegressionModel](../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html "class in org.apache.spark.ml.regression") copy([ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param") extra)  
 Description copied from interface: `[Params](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-)`  
 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()`.  
 Specified by:  
 `[copy](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-)` in interface `[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")`  
 Specified by:  
 `[copy](../../../../../org/apache/spark/ml/Model.html#copy-org.apache.spark.ml.param.ParamMap-)` in class `[Model](../../../../../org/apache/spark/ml/Model.html "class in org.apache.spark.ml")<[IsotonicRegressionModel](../../../../../org/apache/spark/ml/regression/IsotonicRegressionModel.html "class in org.apache.spark.ml.regression")>`  
 Parameters:  
 `extra` \- (undocumented)  
 Returns:  
 (undocumented)  
 * #### transform  
 public [Dataset](../../../../../org/apache/spark/sql/Dataset.html "class in org.apache.spark.sql")<[Row](../../../../../org/apache/spark/sql/Row.html "interface in org.apache.spark.sql")> transform([Dataset](../../../../../org/apache/spark/sql/Dataset.html "class in org.apache.spark.sql")<?> dataset)  
 Transforms the input dataset.  
 Specified by:  
 `[transform](../../../../../org/apache/spark/ml/Transformer.html#transform-org.apache.spark.sql.Dataset-)` in class `[Transformer](../../../../../org/apache/spark/ml/Transformer.html "class in org.apache.spark.ml")`  
 Parameters:  
 `dataset` \- (undocumented)  
 Returns:  
 (undocumented)  
 * #### predict  
 public double predict(double value)  
 * #### transformSchema  
 public [StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") transformSchema([StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") schema)  
 Check transform validity and derive the output schema from the input schema.  
  We check validity for interactions between parameters during `transformSchema` and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by `Param.validate()`.  
  Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.  
 Specified by:  
 `[transformSchema](../../../../../org/apache/spark/ml/PipelineStage.html#transformSchema-org.apache.spark.sql.types.StructType-)` in class `[PipelineStage](../../../../../org/apache/spark/ml/PipelineStage.html "class in org.apache.spark.ml")`  
 Parameters:  
 `schema` \- (undocumented)  
 Returns:  
 (undocumented)  
 * #### write  
 public [MLWriter](../../../../../org/apache/spark/ml/util/MLWriter.html "class in org.apache.spark.ml.util") write()  
 Description copied from interface: `[MLWritable](../../../../../org/apache/spark/ml/util/MLWritable.html#write--)`  
 Returns an `MLWriter` instance for this ML instance.  
 Specified by:  
 `[write](../../../../../org/apache/spark/ml/util/MLWritable.html#write--)` in interface `[MLWritable](../../../../../org/apache/spark/ml/util/MLWritable.html "interface in org.apache.spark.ml.util")`  
 Returns:  
 (undocumented)  
 * #### numFeatures  
 public int numFeatures()  
 * #### toString  
 public String toString()  
 Specified by:  
 `[toString](../../../../../org/apache/spark/ml/util/Identifiable.html#toString--)` in interface `[Identifiable](../../../../../org/apache/spark/ml/util/Identifiable.html "interface in org.apache.spark.ml.util")`  
 Overrides:  
 `toString` in class `Object`

IsotonicRegressionModel (Spark 3.5.5 JavaDoc) (original) (raw)

Nested Class Summary

Method Summary

Method Detail