class TuneHyperparameters extends Estimator[TuneHyperparametersModel] with Wrappable with ComplexParamsWritable with HasEvaluationMetric with SynapseMLLogging

Tunes model hyperparameters

Allows user to specify multiple untrained models to tune using various search strategies. Currently supports cross validation with random grid search.

Linear Supertypes
SynapseMLLogging, HasEvaluationMetric, ComplexParamsWritable, MLWritable, Wrappable, RWrappable, PythonWrappable, BaseWrappable, Estimator[TuneHyperparametersModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TuneHyperparameters
  2. SynapseMLLogging
  3. HasEvaluationMetric
  4. ComplexParamsWritable
  5. MLWritable
  6. Wrappable
  7. RWrappable
  8. PythonWrappable
  9. BaseWrappable
  10. Estimator
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TuneHyperparameters()
  2. new TuneHyperparameters(uid: String)

Value Members

  1. final def clear(param: Param[_]): TuneHyperparameters.this.type
    Definition Classes
    Params
  2. def copy(extra: ParamMap): Estimator[TuneHyperparametersModel]
    Definition Classes
    TuneHyperparameters → Estimator → PipelineStage → Params
  3. val evaluationMetric: Param[String]
    Definition Classes
    HasEvaluationMetric
  4. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  5. def explainParams(): String
    Definition Classes
    Params
  6. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  7. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  8. def fit(dataset: Dataset[_]): TuneHyperparametersModel

    Tunes model hyperparameters for given number of runs and returns the best model found based on evaluation metric.

    Tunes model hyperparameters for given number of runs and returns the best model found based on evaluation metric.

    dataset

    The input dataset to train.

    returns

    The trained classification model.

    Definition Classes
    TuneHyperparameters → Estimator
  9. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[TuneHyperparametersModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  10. def fit(dataset: Dataset[_], paramMap: ParamMap): TuneHyperparametersModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  11. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TuneHyperparametersModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  12. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  13. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  14. def getEvaluationMetric: String

    Definition Classes
    HasEvaluationMetric
  15. def getModels: Array[Estimator[_]]

  16. def getNumFolds: Int

  17. def getNumRuns: Int

  18. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  19. def getParallelism: Int

  20. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  21. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  22. def getParamSpace: ParamSpace

  23. def getSeed: Long

  24. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  25. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  26. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  27. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  28. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  29. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  30. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  31. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  32. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  33. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  34. val models: EstimatorArrayParam

    Estimators to run

  35. val numFolds: IntParam
  36. val numRuns: IntParam
  37. val parallelism: IntParam
  38. val paramSpace: ParamSpaceParam
  39. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  40. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  41. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  42. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  43. val seed: LongParam
  44. final def set[T](param: Param[T], value: T): TuneHyperparameters.this.type
    Definition Classes
    Params
  45. def setEvaluationMetric(value: String): TuneHyperparameters.this.type

    Definition Classes
    HasEvaluationMetric
  46. def setModels(value: ArrayList[Estimator[_]]): TuneHyperparameters.this.type
  47. def setModels(value: Array[Estimator[_]]): TuneHyperparameters.this.type

  48. def setNumFolds(value: Int): TuneHyperparameters.this.type

  49. def setNumRuns(value: Int): TuneHyperparameters.this.type

  50. def setParallelism(value: Int): TuneHyperparameters.this.type

  51. def setParamSpace(value: ParamSpace): TuneHyperparameters.this.type

  52. def setSeed(value: Long): TuneHyperparameters.this.type

  53. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  54. def transformSchema(schema: StructType): StructType
    Definition Classes
    TuneHyperparameters → PipelineStage
    Annotations
    @DeveloperApi()
  55. val uid: String
    Definition Classes
    TuneHyperparameters → SynapseMLLogging → Identifiable
  56. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable