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, HasSeed, TrainValidationSplitParams, ValidatorParams, Identifiable, MLWritable

public class TrainValidationSplitModel
extends Model<TrainValidationSplitModel>
implements TrainValidationSplitParams, MLWritable

Model from train validation split.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrainValidationSplitModel.TrainValidationSplitModelWriter Writer for TrainValidationSplitModel.

Method Summary

Modifier and Type	Method and Description
Model<?>	bestModel()
TrainValidationSplitModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
boolean	hasSubModels()
static TrainValidationSplitModel	load(String path)
static MLReader<TrainValidationSplitModel>	read()
Model<?>[]	subModels()
Dataset<Row>	transform(Dataset<?> dataset) Transforms the input dataset.
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.
double[]	validationMetrics()
TrainValidationSplitModel.TrainValidationSplitModelWriter	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.tuning.TrainValidationSplitParams

getTrainRatio, trainRatio

Methods inherited from interface org.apache.spark.ml.tuning.ValidatorParams

estimator, estimatorParamMaps, evaluator, getEstimator, getEstimatorParamMaps, getEvaluator, logTuningParams, transformSchemaImpl

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

getSeed, seed

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

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

subModels

public Model<?>[] subModels()

Returns:

submodels represented in array. The index of array corresponds to the ordering of estimatorParamMaps

Throws:

IllegalArgumentException - if subModels are not available. To retrieve subModels, make sure to set collectSubModels to true before fitting.

hasSubModels

public boolean hasSubModels()

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 TrainValidationSplitModel.TrainValidationSplitModelWriter write()

Description copied from interface: MLWritable

Returns an MLWriter instance for this ML instance.

Specified by:

write in interface MLWritable

Returns:

(undocumented)