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, DotnetWrappable, 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. DotnetWrappable
  8. RWrappable
  9. PythonWrappable
  10. BaseWrappable
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. 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. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  15. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  16. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  17. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  18. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  19. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  20. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  21. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. val evaluationMetric: Param[String]
    Definition Classes
    HasEvaluationMetric
  34. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  35. def explainParams(): String
    Definition Classes
    Params
  36. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  37. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. 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
  40. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[TuneHyperparametersModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  41. def fit(dataset: Dataset[_], paramMap: ParamMap): TuneHyperparametersModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  42. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TuneHyperparametersModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. def getEvaluationMetric: String

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

  48. def getNumFolds: Int

  49. def getNumRuns: Int

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

  52. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  53. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  54. def getParamSpace: ParamSpace

  55. def getSeed: Long

  56. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  57. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  60. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  62. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  63. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  64. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  65. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  66. def logBase(info: SynapseMLLogInfo): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  67. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  68. def logClass(): Unit
    Definition Classes
    SynapseMLLogging
  69. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  74. def logFit[T](f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  75. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logTrain[T](f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  81. def logTransform[T](f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  82. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  83. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  86. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  87. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  88. val models: EstimatorArrayParam

    Estimators to run

  89. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  90. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  91. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  92. val numFolds: IntParam
  93. val numRuns: IntParam
  94. val parallelism: IntParam
  95. val paramSpace: ParamSpaceParam
  96. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  97. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  98. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  99. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  100. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  101. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  102. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  103. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  104. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  105. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  106. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  107. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  108. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  109. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  110. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  111. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  112. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  113. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  114. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  115. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  116. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  117. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  118. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  119. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  120. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  121. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  122. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  123. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  124. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  125. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  126. val seed: LongParam
  127. final def set(paramPair: ParamPair[_]): TuneHyperparameters.this.type
    Attributes
    protected
    Definition Classes
    Params
  128. final def set(param: String, value: Any): TuneHyperparameters.this.type
    Attributes
    protected
    Definition Classes
    Params
  129. final def set[T](param: Param[T], value: T): TuneHyperparameters.this.type
    Definition Classes
    Params
  130. final def setDefault(paramPairs: ParamPair[_]*): TuneHyperparameters.this.type
    Attributes
    protected
    Definition Classes
    Params
  131. final def setDefault[T](param: Param[T], value: T): TuneHyperparameters.this.type
    Attributes
    protected
    Definition Classes
    Params
  132. def setEvaluationMetric(value: String): TuneHyperparameters.this.type

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

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

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

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

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

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

  140. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  141. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  142. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  143. def transformSchema(schema: StructType): StructType
    Definition Classes
    TuneHyperparameters → PipelineStage
    Annotations
    @DeveloperApi()
  144. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  145. val uid: String
    Definition Classes
    TuneHyperparameters → SynapseMLLogging → Identifiable
  146. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  147. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  148. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  149. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from SynapseMLLogging

Inherited from HasEvaluationMetric

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from DotnetWrappable

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