Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def $[T](param: Param[T]): T

   An alias for getOrDefault().

   An alias for getOrDefault().

   Attributes

   protected

   Definition Classes

   Params

4.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

5.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

6.  val bestModel: Model[_]

   Annotations

   @Since( "1.5.0" )

7.  final def clear(param: Param[_]): TrainValidationSplitModel.this.type

   Clears the user-supplied value for the input param.

   Clears the user-supplied value for the input param.

   Definition Classes

   Params

8.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

9.  def copy(extra: ParamMap): TrainValidationSplitModel

   Creates a copy of this instance with the same UID and some extra 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().

   Definition Classes

   TrainValidationSplitModel → Model → Transformer → PipelineStage → Params

   Annotations

   @Since( "1.5.0" )

10.  def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

    Attributes

    protected

    Definition Classes

    Params

11.  final def defaultCopy[T <: Params](extra: ParamMap): T

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes

    protected

    Definition Classes

    Params

12.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

13.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

14.  val estimator: Param[Estimator[_]]

    param for the estimator to be validated

    param for the estimator to be validated

    Definition Classes

    ValidatorParams

15.  val estimatorParamMaps: Param[Array[ParamMap]]

    param for estimator param maps

    param for estimator param maps

    Definition Classes

    ValidatorParams

16.  val evaluator: Param[Evaluator]

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

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

    Definition Classes

    ValidatorParams

17.  def explainParam(param: Param[_]): String

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes

    Params

18.  def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes

    Params

19.  final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes

    Params

20.  final def extractParamMap(extra: ParamMap): ParamMap

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes

    Params

21.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

22.  final def get[T](param: Param[T]): Option[T]

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes

    Params

23.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

24.  final def getDefault[T](param: Param[T]): Option[T]

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes

    Params

25.  def getEstimator: Estimator[_]
    Definition Classes

    ValidatorParams

26.  def getEstimatorParamMaps: Array[ParamMap]
    Definition Classes

    ValidatorParams

27.  def getEvaluator: Evaluator
    Definition Classes

    ValidatorParams

28.  final def getOrDefault[T](param: Param[T]): T

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

    Definition Classes

    Params

29.  def getParam(paramName: String): Param[Any]

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes

    Params

30.  final def getSeed: Long
    Definition Classes

    HasSeed

31.  def getTrainRatio: Double
    Definition Classes

    TrainValidationSplitParams

32.  final def hasDefault[T](param: Param[T]): Boolean

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

    Definition Classes

    Params

33.  def hasParam(paramName: String): Boolean

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes

    Params

34.  def hasParent: Boolean

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes

    Model

35.  def hasSubModels: Boolean

    Annotations

    @Since( "2.3.0" )

36.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

37.  def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Attributes

    protected

    Definition Classes

    Logging

38.  def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes

    protected

    Definition Classes

    Logging

39.  final def isDefined(param: Param[_]): Boolean

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

    Definition Classes

    Params

40.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

41.  final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes

    Params

42.  def isTraceEnabled(): Boolean

    Attributes

    protected

    Definition Classes

    Logging

43.  def log: Logger

    Attributes

    protected

    Definition Classes

    Logging

44.  def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

45.  def logDebug(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

46.  def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

47.  def logError(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

48.  def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

49.  def logInfo(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

50.  def logName: String

    Attributes

    protected

    Definition Classes

    Logging

51.  def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

52.  def logTrace(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

53.  def logTuningParams(instrumentation: Instrumentation): Unit

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

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

    Attributes

    protected

    Definition Classes

    ValidatorParams

54.  def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes

    protected

    Definition Classes

    Logging

55.  def logWarning(msg: ⇒ String): Unit

    Attributes

    protected

    Definition Classes

    Logging

56.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

57.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

58.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

59.  lazy val params: Array[Param[_]]

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Definition Classes

    Params

    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

60.  var parent: Estimator[TrainValidationSplitModel]

    The parent estimator that produced this model.

    The parent estimator that produced this model.

    Definition Classes

    Model

    Note

    For ensembles' component Models, this value can be null.

61.  def save(path: String): Unit

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Definition Classes

    MLWritable

    Annotations

    @Since( "1.6.0" ) @throws( ... )

62.  final val seed: LongParam

    Param for random seed.

    Param for random seed.

    Definition Classes

    HasSeed

63.  final def set(paramPair: ParamPair[_]): TrainValidationSplitModel.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes

    protected

    Definition Classes

    Params

64.  final def set(param: String, value: Any): TrainValidationSplitModel.this.type

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

    Attributes

    protected

    Definition Classes

    Params

65.  final def set[T](param: Param[T], value: T): TrainValidationSplitModel.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes

    Params

66.  final def setDefault(paramPairs: ParamPair[_]*): TrainValidationSplitModel.this.type

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

    Attributes

    protected

    Definition Classes

    Params

67.  final def setDefault[T](param: Param[T], value: T): TrainValidationSplitModel.this.type

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes

    protected

    Definition Classes

    Params

68.  def setParent(parent: Estimator[TrainValidationSplitModel]): TrainValidationSplitModel

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes

    Model

69.  def subModels: Array[Model[_]]
    returns

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

    Annotations

    @Since( "2.3.0" )

    Exceptions thrown

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

70.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

71.  def toString(): String

    Definition Classes

    TrainValidationSplitModel → Identifiable → AnyRef → Any

    Annotations

    @Since( "3.0.0" )

72.  val trainRatio: DoubleParam

    Param for ratio between train and validation data.

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

    Definition Classes

    TrainValidationSplitParams

73.  def transform(dataset: Dataset[_]): DataFrame

    Transforms the input dataset.

    Transforms the input dataset.

    Definition Classes

    TrainValidationSplitModel → Transformer

    Annotations

    @Since( "2.0.0" )

74.  def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Transforms the dataset with provided parameter map as additional parameters.

    Transforms the dataset with provided parameter map as additional parameters.

    dataset

    input dataset

    paramMap

    additional parameters, overwrite embedded params

    returns

    transformed dataset

    Definition Classes

    Transformer

    Annotations

    @Since( "2.0.0" )

75.  def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Transforms the dataset with optional parameters

    Transforms the dataset with optional parameters

    dataset

    input dataset

    firstParamPair

    the first param pair, overwrite embedded params

    otherParamPairs

    other param pairs, overwrite embedded params

    returns

    transformed dataset

    Definition Classes

    Transformer

    Annotations

    @Since( "2.0.0" ) @varargs()

76.  def transformSchema(schema: StructType): StructType

    Check transform validity and derive the output schema from the input 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.

    Definition Classes

    TrainValidationSplitModel → PipelineStage

    Annotations

    @Since( "1.5.0" )

77.  def transformSchema(schema: StructType, logging: Boolean): StructType

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema and parameters, optionally with logging.

    This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

    Attributes

    protected

    Definition Classes

    PipelineStage

    Annotations

    @DeveloperApi()

78.  def transformSchemaImpl(schema: StructType): StructType

    Attributes

    protected

    Definition Classes

    ValidatorParams

79.  val uid: String

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes

    TrainValidationSplitModel → Identifiable

    Annotations

    @Since( "1.5.0" )

80.  val validationMetrics: Array[Double]

    Annotations

    @Since( "1.5.0" )

81.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

82.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

83.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()

84.  def write: TrainValidationSplitModelWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes

    TrainValidationSplitModel → MLWritable

    Annotations

    @Since( "2.0.0" )