org.apache.spark.ml.regression

Class IsotonicRegression

Object

org.apache.spark.ml.PipelineStage

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

org.apache.spark.ml.regression.IsotonicRegression

All Implemented Interfaces:

java.io.Serializable, Logging, Params, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasWeightCol, IsotonicRegressionBase, DefaultParamsWritable, Identifiable, MLWritable

public class IsotonicRegression
extends Estimator<IsotonicRegressionModel>
implements IsotonicRegressionBase, DefaultParamsWritable

Isotonic regression.

Currently implemented using parallelized pool adjacent violators algorithm. Only univariate (single feature) algorithm supported.

Uses IsotonicRegression.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IsotonicRegression()
IsotonicRegression(String uid)

Method Summary

Modifier and Type	Method and Description
IsotonicRegression	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
IsotonicRegressionModel	fit(Dataset<?> dataset) Fits a model to the input data.
static IsotonicRegression	load(String path)
static MLReader<T>	read()
IsotonicRegression	setFeatureIndex(int value)
IsotonicRegression	setFeaturesCol(String value)
IsotonicRegression	setIsotonic(boolean value)
IsotonicRegression	setLabelCol(String value)
IsotonicRegression	setPredictionCol(String value)
IsotonicRegression	setWeightCol(String value)
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.

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

fit, fit, fit, fit

Methods inherited from class Object

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

Methods inherited from interface org.apache.spark.ml.regression.IsotonicRegressionBase

extractWeightedLabeledPoints, featureIndex, getFeatureIndex, getIsotonic, hasWeightCol, isotonic, validateAndTransformSchema

Methods inherited from interface org.apache.spark.ml.param.shared.HasFeaturesCol

featuresCol, getFeaturesCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasLabelCol

getLabelCol, labelCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasPredictionCol

getPredictionCol, predictionCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasWeightCol

getWeightCol, weightCol

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

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

toString

Methods inherited from interface org.apache.spark.internal.Logging

initializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

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

write

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

save

Constructor Detail

IsotonicRegression

public IsotonicRegression(String uid)

IsotonicRegression

public IsotonicRegression()

Method Detail

load

public static IsotonicRegression load(String path)

read

public static MLReader<T> read()

uid

public 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)

setLabelCol

public IsotonicRegression setLabelCol(String value)

setFeaturesCol

public IsotonicRegression setFeaturesCol(String value)

setPredictionCol

public IsotonicRegression setPredictionCol(String value)

setIsotonic

public IsotonicRegression setIsotonic(boolean value)

setWeightCol

public IsotonicRegression setWeightCol(String value)

setFeatureIndex

public IsotonicRegression setFeatureIndex(int value)

copy

public IsotonicRegression 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. See defaultCopy().

Specified by:

copy in interface Params

Specified by:

copy in class Estimator<IsotonicRegressionModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

fit

public IsotonicRegressionModel fit(Dataset<?> dataset)

Description copied from class: Estimator

Fits a model to the input data.

Specified by:

fit in class Estimator<IsotonicRegressionModel>

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

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 in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)