TrainValidationSplitModel (Spark 3.5.5 JavaDoc) (original) (raw)

• 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, org.apache.spark.internal.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.

     * ### 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
  Model<?>	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
  boolean	hasSubModels()
  static TrainValidationSplitModel	load(String path)
  static MLReader<TrainValidationSplitModel>	read()
  LongParam	seed() Param for random seed.
  Model<?>[]	subModels()
  String	toString()
  DoubleParam	trainRatio() Param for ratio between train and validation data.
  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.
  double[]	validationMetrics()
  TrainValidationSplitModel.TrainValidationSplitModelWriter	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.tuning.[TrainValidationSplitParams](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitParams.html "interface in org.apache.spark.ml.tuning")  
     `[getTrainRatio](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitParams.html#getTrainRatio--)`  
     * ### Methods inherited from interface org.apache.spark.ml.tuning.[ValidatorParams](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html "interface in org.apache.spark.ml.tuning")  
     `[getEstimator](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#getEstimator--), [getEstimatorParamMaps](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#getEstimatorParamMaps--), [getEvaluator](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#getEvaluator--), [logTuningParams](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#logTuningParams-org.apache.spark.ml.util.Instrumentation-), [transformSchemaImpl](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#transformSchemaImpl-org.apache.spark.sql.types.StructType-)`  
     * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html "interface in org.apache.spark.ml.param.shared")  
     `[getSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#getSeed--)`  
     * ### 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.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-)`  
     * ### 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`

• • Method Detail

     * #### read  
     public static [MLReader](../../../../../org/apache/spark/ml/util/MLReader.html "class in org.apache.spark.ml.util")<[TrainValidationSplitModel](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitModel.html "class in org.apache.spark.ml.tuning")> read()  
     * #### load  
     public static [TrainValidationSplitModel](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitModel.html "class in org.apache.spark.ml.tuning") load(String path)  
     * #### trainRatio  
     public [DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param") trainRatio()  
     Param for ratio between train and validation data. Must be between 0 and 1\. Default: 0.75  
     Specified by:  
     `[trainRatio](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitParams.html#trainRatio--)` in interface `[TrainValidationSplitParams](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitParams.html "interface in org.apache.spark.ml.tuning")`  
     Returns:  
     (undocumented)  
     * #### estimator  
     public [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<[Estimator](../../../../../org/apache/spark/ml/Estimator.html "class in org.apache.spark.ml")<?>> estimator()  
     param for the estimator to be validated  
     Specified by:  
     `[estimator](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#estimator--)` in interface `[ValidatorParams](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html "interface in org.apache.spark.ml.tuning")`  
     Returns:  
     (undocumented)  
     * #### estimatorParamMaps  
     public [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<[ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param")[]> estimatorParamMaps()  
     param for estimator param maps  
     Specified by:  
     `[estimatorParamMaps](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#estimatorParamMaps--)` in interface `[ValidatorParams](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html "interface in org.apache.spark.ml.tuning")`  
     Returns:  
     (undocumented)  
     * #### evaluator  
     public [Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<[Evaluator](../../../../../org/apache/spark/ml/evaluation/Evaluator.html "class in org.apache.spark.ml.evaluation")> evaluator()  
     param for the evaluator used to select hyper-parameters that maximize the validated metric  
     Specified by:  
     `[evaluator](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html#evaluator--)` in interface `[ValidatorParams](../../../../../org/apache/spark/ml/tuning/ValidatorParams.html "interface in org.apache.spark.ml.tuning")`  
     Returns:  
     (undocumented)  
     * #### seed  
     public final [LongParam](../../../../../org/apache/spark/ml/param/LongParam.html "class in org.apache.spark.ml.param") seed()  
     Description copied from interface: `[HasSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--)`  
     Param for random seed.  
     Specified by:  
     `[seed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--)` in interface `[HasSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.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)  
     * #### bestModel  
     public [Model](../../../../../org/apache/spark/ml/Model.html "class in org.apache.spark.ml")<?> bestModel()  
     * #### validationMetrics  
     public double[] validationMetrics()  
     * #### subModels  
     public [Model](../../../../../org/apache/spark/ml/Model.html "class in org.apache.spark.ml")<?>[] 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](../../../../../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)  
     * #### 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)  
     * #### copy  
     public [TrainValidationSplitModel](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitModel.html "class in org.apache.spark.ml.tuning") 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")<[TrainValidationSplitModel](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitModel.html "class in org.apache.spark.ml.tuning")>`  
     Parameters:  
     `extra` \- (undocumented)  
     Returns:  
     (undocumented)  
     * #### write  
     public [TrainValidationSplitModel.TrainValidationSplitModelWriter](../../../../../org/apache/spark/ml/tuning/TrainValidationSplitModel.TrainValidationSplitModelWriter.html "class in org.apache.spark.ml.tuning") 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)  
     * #### 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`