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 !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    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. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  7. final def clear(param: Param[_]): TuneHyperparameters.this.type
    Definition Classes
    Params
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  10. def copy(extra: ParamMap): Estimator[TuneHyperparametersModel]
    Definition Classes
    TuneHyperparameters → Estimator → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  12. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  13. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. val evaluationMetric: Param[String]
    Definition Classes
    HasEvaluationMetric
  17. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  18. def explainParams(): String
    Definition Classes
    Params
  19. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  20. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. 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
  23. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[TuneHyperparametersModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], paramMap: ParamMap): TuneHyperparametersModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  25. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TuneHyperparametersModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  26. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. def getEvaluationMetric: String

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

  31. def getNumFolds: Int

  32. def getNumRuns: Int

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

  35. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  36. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  37. def getParamSpace: ParamSpace

  38. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  39. def getSeed: Long

  40. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  41. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  44. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  48. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  49. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  50. def logBase(info: Map[String, String], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  51. def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  52. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  53. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  58. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  59. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  62. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  65. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  66. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  69. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  70. val models: EstimatorArrayParam

    Estimators to run

  71. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  72. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. val numFolds: IntParam
  75. val numRuns: IntParam
  76. val parallelism: IntParam
  77. val paramSpace: ParamSpaceParam
  78. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  79. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  80. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  81. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  82. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  83. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  84. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  85. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  86. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  87. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  88. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  89. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  90. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  91. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  92. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  93. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  94. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  95. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  96. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  97. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  98. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  99. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  100. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  101. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  102. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  103. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  104. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  105. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  106. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  107. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  108. val seed: LongParam
  109. final def set(paramPair: ParamPair[_]): TuneHyperparameters.this.type
    Attributes
    protected
    Definition Classes
    Params
  110. final def set(param: String, value: Any): TuneHyperparameters.this.type
    Attributes
    protected
    Definition Classes
    Params
  111. final def set[T](param: Param[T], value: T): TuneHyperparameters.this.type
    Definition Classes
    Params
  112. final def setDefault(paramPairs: ParamPair[_]*): TuneHyperparameters.this.type
    Attributes
    protected
    Definition Classes
    Params
  113. final def setDefault[T](param: Param[T], value: T): TuneHyperparameters.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  114. def setEvaluationMetric(value: String): TuneHyperparameters.this.type

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

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

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

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

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

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

  122. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  123. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  124. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  125. def transformSchema(schema: StructType): StructType
    Definition Classes
    TuneHyperparameters → PipelineStage
    Annotations
    @DeveloperApi()
  126. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  127. val uid: String
    Definition Classes
    TuneHyperparameters → SynapseMLLogging → Identifiable
  128. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  129. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  131. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from SynapseMLLogging

Inherited from HasEvaluationMetric

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Estimator[TuneHyperparametersModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped