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, MLWritable

public class TrainValidationSplitModel
extends Model<TrainValidationSplitModel>
implements MLWritable

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

Modifier and Type	Method and Description
Model<?>	bestModel()
static Params	clear(Param<?> param)
TrainValidationSplitModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
static Param<Estimator<?>>	estimator()
Param<Estimator<?>>	estimator() param for the estimator to be validated
static Param<ParamMap[]>	estimatorParamMaps()
Param<ParamMap[]>	estimatorParamMaps() param for estimator param maps
static Param<Evaluator>	evaluator()
Param<Evaluator>	evaluator() param for the evaluator used to select hyper-parameters that maximize the validated metric
static String	explainParam(Param<?> param)
static String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static Estimator<?>	getEstimator()
Estimator<?>	getEstimator()
static ParamMap[]	getEstimatorParamMaps()
ParamMap[]	getEstimatorParamMaps()
static Evaluator	getEvaluator()
Evaluator	getEvaluator()
static <T> T	getOrDefault(Param<T> param)
static Param<Object>	getParam(String paramName)
static long	getSeed()
static double	getTrainRatio()
double	getTrainRatio()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static boolean	hasParent()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static TrainValidationSplitModel	load(String path)
void	logTuningParams(<any> instrumentation) Instrumentation logging for tuning params including the inner estimator and evaluator info.
static Param<?>[]	params()
static void	parent_$eq(Estimator<M> x$1)
static Estimator<M>	parent()
static MLReader<TrainValidationSplitModel>	read()
static void	save(String path)
static LongParam	seed()
static <T> Params	set(Param<T> param, T value)
static M	setParent(Estimator<M> parent)
static String	toString()
static DoubleParam	trainRatio()
DoubleParam	trainRatio() Param for ratio between train and validation data.
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
StructType	transformSchemaImpl(StructType schema)
String	uid() An immutable unique ID for the object and its derivatives.
double[]	validationMetrics()
MLWriter	write() Returns an MLWriter instance for this ML instance.

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.ml.util.MLWritable

save

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

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

Method Detail

read

public static MLReader<TrainValidationSplitModel> read()

load

public static TrainValidationSplitModel load(String path)

toString

public static String toString()

params

public static Param<?>[] params()

explainParam

public static String explainParam(Param<?> param)

explainParams

public static String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(String paramName)

getParam

public static Param<Object> getParam(String paramName)

set

public static final <T> Params set(Param<T> param,
                                   T value)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

parent

public static Estimator<M> parent()

parent_$eq

public static void parent_$eq(Estimator<M> x$1)

setParent

public static M setParent(Estimator<M> parent)

hasParent

public static boolean hasParent()

seed

public static final LongParam seed()

getSeed

public static final long getSeed()

estimator

public static Param<Estimator<?>> estimator()

getEstimator

public static Estimator<?> getEstimator()

estimatorParamMaps

public static Param<ParamMap[]> estimatorParamMaps()

getEstimatorParamMaps

public static ParamMap[] getEstimatorParamMaps()

evaluator

public static Param<Evaluator> evaluator()

getEvaluator

public static Evaluator getEvaluator()

trainRatio

public static DoubleParam trainRatio()

getTrainRatio

public static double getTrainRatio()

save

public static void save(String path)
                 throws java.io.IOException

Throws:

java.io.IOException

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 Model<?> bestModel()

validationMetrics

public double[] validationMetrics()

transform

public Dataset<Row> transform(Dataset<?> 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 ::

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)

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

Specified by:

copy in interface Params

Specified by:

copy in class Model<TrainValidationSplitModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

write

public MLWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)

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

transformSchemaImpl

public StructType transformSchemaImpl(StructType schema)

logTuningParams

public void logTuningParams(<any> instrumentation)

Instrumentation logging for tuning params including the inner estimator and evaluator info.

Parameters:

instrumentation - (undocumented)