CrossValidator

Instance Constructors

new CrossValidator()
new CrossValidator(uid: String)

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

An alias for getOrDefault().
An alias for getOrDefault().

Attributes
protected
Definition Classes
Params
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def clear(param: Param[_]): CrossValidator.this.type

Clears the user-supplied value for the input param.
Clears the user-supplied value for the input param.

Attributes
protected
Definition Classes
Params
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copy(extra: ParamMap): CrossValidator

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.

Definition Classes
CrossValidator → Estimator → PipelineStage → Params
See also
defaultCopy()
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.
to
the target instance
extra
extra params to be copied
returns
the target instance with param values copied

Attributes
protected
Definition Classes
Params
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val estimator: Param[Estimator[_]]

param for the estimator to be cross-validated
param for the estimator to be cross-validated

Definition Classes
CrossValidatorParams
val estimatorParamMaps: Param[Array[ParamMap]]

param for estimator param maps
param for estimator param maps

Definition Classes
CrossValidatorParams
val evaluator: Param[Evaluator]

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

Definition Classes
CrossValidatorParams
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
def explainParams(): String

Explains all params of this instance.
Explains all params of this instance.

Definition Classes
Params
See also
explainParam()
final def extractParamMap(): ParamMap

extractParamMap with no extra values.
extractParamMap with no extra values.

Definition Classes
Params
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.
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 < user-supplied values < extra.

Definition Classes
Params
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fit(dataset: DataFrame): CrossValidatorModel

Fits a model to the input data.
Fits a model to the input data.

Definition Classes
CrossValidator → Estimator
def fit(dataset: DataFrame, paramMaps: Array[ParamMap]): Seq[CrossValidatorModel]

Fits multiple models to the input data with multiple sets of parameters.
Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training.
dataset
input dataset
paramMaps
An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.
returns
fitted models, matching the input parameter maps

Definition Classes
Estimator
def fit(dataset: DataFrame, paramMap: ParamMap): CrossValidatorModel

Fits a single model to the input data with provided parameter map.
Fits a single model to the input data with provided parameter map.
dataset
input dataset
paramMap
Parameter map. These values override any specified in this Estimator's embedded ParamMap.
returns
fitted model

Definition Classes
Estimator
def fit(dataset: DataFrame, firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): CrossValidatorModel

Fits a single model to the input data with optional parameters.
Fits a single model to the input data with optional parameters.
dataset
input dataset
firstParamPair
the first param pair, overrides embedded params
otherParamPairs
other param pairs. These values override any specified in this Estimator's embedded ParamMap.
returns
fitted model

Definition Classes
Estimator
Annotations
@varargs()
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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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
def getEstimator: Estimator[_]

Definition Classes
CrossValidatorParams
def getEstimatorParamMaps: Array[ParamMap]

Definition Classes
CrossValidatorParams
def getEvaluator: Evaluator

Definition Classes
CrossValidatorParams
def getNumFolds: Int

Definition Classes
CrossValidatorParams
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
def getParam(paramName: String): Param[Any]

Gets a param by its name.
Gets a param by its name.

Definition Classes
Params
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
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
def hashCode(): Int

Definition Classes
AnyRef → Any
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isSet(param: Param[_]): Boolean

Checks whether a param is explicitly set.
Checks whether a param is explicitly set.

Definition Classes
Params
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def log: Logger

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logName: String

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numFolds: IntParam

Param for number of folds for cross validation.
Param for number of folds for cross validation. Must be >= 2. Default: 3

Definition Classes
CrossValidatorParams
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.
Note: Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

Definition Classes
Params
final def set(paramPair: ParamPair[_]): CrossValidator.this.type

Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.

Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): CrossValidator.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
final def set[T](param: Param[T], value: T): CrossValidator.this.type

Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.

Attributes
protected
Definition Classes
Params
final def setDefault(paramPairs: ParamPair[_]*): CrossValidator.this.type

Sets default values for a list of params.
Sets default values for a list of params.
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
Annotations
@varargs()
final def setDefault[T](param: Param[T], value: T): CrossValidator.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
def setEstimator(value: Estimator[_]): CrossValidator.this.type
def setEstimatorParamMaps(value: Array[ParamMap]): CrossValidator.this.type
def setEvaluator(value: Evaluator): CrossValidator.this.type
def setNumFolds(value: Int): CrossValidator.this.type
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
def transformSchema(schema: StructType): StructType

:: DeveloperApi ::
:: DeveloperApi ::
Derives the output schema from the input schema.

Definition Classes
CrossValidator → PipelineStage
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()
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
CrossValidator → Identifiable
def validateParams(): Unit

Validates parameter values stored internally.
Validates parameter values stored internally. Raise an exception if any parameter value is invalid.
This only needs to check for interactions between parameters. Parameter value checks which do not depend on other parameters are handled by Param.validate(). This method does not handle input/output column parameters; those are checked during schema validation.

Definition Classes
CrossValidator → Params
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from CrossValidatorParams

Inherited from Estimator[CrossValidatorModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters

class CrossValidator extends Estimator[CrossValidatorModel] with CrossValidatorParams with Logging

Instance Constructors

new CrossValidator()

new CrossValidator(uid: String)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def $[T](param: Param[T]): T

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def clear(param: Param[_]): CrossValidator.this.type

def clone(): AnyRef

def copy(extra: ParamMap): CrossValidator

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

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val estimator: Param[Estimator[_]]

val estimatorParamMaps: Param[Array[ParamMap]]

val evaluator: Param[Evaluator]

def explainParam(param: Param[_]): String

def explainParams(): String

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

def finalize(): Unit

def fit(dataset: DataFrame): CrossValidatorModel

def fit(dataset: DataFrame, paramMaps: Array[ParamMap]): Seq[CrossValidatorModel]

def fit(dataset: DataFrame, paramMap: ParamMap): CrossValidatorModel

def fit(dataset: DataFrame, firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): CrossValidatorModel

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

final def getClass(): Class[_]

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

def getEstimator: Estimator[_]

def getEstimatorParamMaps: Array[ParamMap]

def getEvaluator: Evaluator

def getNumFolds: Int

final def getOrDefault[T](param: Param[T]): T

def getParam(paramName: String): Param[Any]

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

def hasParam(paramName: String): Boolean

def hashCode(): Int

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

final def isInstanceOf[T0]: Boolean

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

def isTraceEnabled(): Boolean

def log: Logger

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

def logDebug(msg: ⇒ String): Unit

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

def logError(msg: ⇒ String): Unit

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

def logInfo(msg: ⇒ String): Unit

def logName: String

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

def logTrace(msg: ⇒ String): Unit

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

def logWarning(msg: ⇒ String): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numFolds: IntParam

lazy val params: Array[Param[_]]

final def set(paramPair: ParamPair[_]): CrossValidator.this.type

final def set(param: String, value: Any): CrossValidator.this.type

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

final def setDefault(paramPairs: ParamPair[_]*): CrossValidator.this.type

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

def setEstimator(value: Estimator[_]): CrossValidator.this.type

def setEstimatorParamMaps(value: Array[ParamMap]): CrossValidator.this.type

def setEvaluator(value: Evaluator): CrossValidator.this.type

def setNumFolds(value: Int): CrossValidator.this.type

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def transformSchema(schema: StructType): StructType

def transformSchema(schema: StructType, logging: Boolean): StructType

val uid: String

def validateParams(): Unit