Package org.apache.spark.ml.tuning

Interface ValidatorParams

All Superinterfaces:

HasSeed, Identifiable, Params, Serializable

All Known Subinterfaces:

CrossValidatorParams, TrainValidationSplitParams

All Known Implementing Classes:

CrossValidator, CrossValidatorModel, TrainValidationSplit, TrainValidationSplitModel

public interface ValidatorParams
extends HasSeed, Params

Common params for TrainValidationSplitParams and CrossValidatorParams.

Method Summary

Modifier and Type	Method	Description
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
Estimator<?>	getEstimator()
ParamMap[]	getEstimatorParamMaps()
Evaluator	getEvaluator()
void	logTuningParams(org.apache.spark.ml.util.Instrumentation instrumentation)	Instrumentation logging for tuning params including the inner estimator and evaluator info.
StructType	transformSchemaImpl(StructType schema)

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

getSeed, seed

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString, uid

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copy, copyValues, defaultCopy, defaultParamMap, estimateMatadataSize, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, onParamChange, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Method Details

estimator

Param<Estimator<?>> estimator()

param for the estimator to be validated

Returns:

(undocumented)

getEstimator

Estimator<?> getEstimator()

estimatorParamMaps

Param<ParamMap[]> estimatorParamMaps()

param for estimator param maps

Returns:

(undocumented)

getEstimatorParamMaps

ParamMap[] getEstimatorParamMaps()

evaluator

Param<Evaluator> evaluator()

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

Returns:

(undocumented)

getEvaluator

Evaluator getEvaluator()

transformSchemaImpl

StructType transformSchemaImpl(StructType schema)

logTuningParams

void logTuningParams(org.apache.spark.ml.util.Instrumentation instrumentation)

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

Parameters:

instrumentation - (undocumented)