org.apache.spark.ml.tuning

Class TrainValidationSplitModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<TrainValidationSplitModel>

org.apache.spark.ml.tuning.TrainValidationSplitModel

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class TrainValidationSplitModel
extends Model<TrainValidationSplitModel>

:: Experimental :: Model from train validation split.

param: uid Id. param: bestModel Estimator determined best model. param: validationMetrics Evaluated validation metrics.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
Object	bestModel()
TrainValidationSplitModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
Param<Estimator<?>>	estimator() param for the estimator to be validated
Param<ParamMap[]>	estimatorParamMaps() param for estimator param maps
Param<Evaluator>	evaluator() param for the evaluator used to select hyper-parameters that maximize the validated metric
Estimator<?>	getEstimator()
ParamMap[]	getEstimatorParamMaps()
Evaluator	getEvaluator()
double	getTrainRatio()
DoubleParam	trainRatio() Param for ratio between train and validation data.
DataFrame	transform(DataFrame dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
void	validateParams()
double[]	validationMetrics()

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

hasParent, parent, setParent

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

transform, transform, transform

Methods inherited from class Object

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

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.Logging

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

Method Detail

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)

bestModel

public Object bestModel()

validationMetrics

public double[] validationMetrics()

validateParams

public void validateParams()

Specified by:

validateParams in interface Params

transform

public DataFrame transform(DataFrame dataset)

Description copied from class: Transformer

Transforms the input dataset.

Specified by:

transform in class Transformer

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public TrainValidationSplitModel 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.

Specified by:

copy in interface Params

Specified by:

copy in class Model<TrainValidationSplitModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

trainRatio

public DoubleParam trainRatio()

Param for ratio between train and validation data. Must be between 0 and 1. Default: 0.75

Returns:

(undocumented)

getTrainRatio

public double getTrainRatio()

estimator

public Param<Estimator<?>> estimator()

param for the estimator to be validated

Returns:

(undocumented)

getEstimator

public Estimator<?> getEstimator()

estimatorParamMaps

public Param<ParamMap[]> estimatorParamMaps()

param for estimator param maps

Returns:

(undocumented)

getEstimatorParamMaps

public ParamMap[] getEstimatorParamMaps()

evaluator

public Param<Evaluator> evaluator()

param for the evaluator used to select hyper-parameters that maximize the validated metric

Returns:

(undocumented)

getEvaluator

public Evaluator getEvaluator()