Class/Object

com.microsoft.ml.spark.automl

TuneHyperparameters

Related Docs: object TuneHyperparameters | package automl

Permalink

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

Tunes model hyperparameters

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

Annotations
@InternalWrapper()
Linear Supertypes
HasEvaluationMetric, ComplexParamsWritable, MLWritable, Wrappable, Estimator[TuneHyperparametersModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TuneHyperparameters
  2. HasEvaluationMetric
  3. ComplexParamsWritable
  4. MLWritable
  5. Wrappable
  6. Estimator
  7. PipelineStage
  8. Logging
  9. Params
  10. Serializable
  11. Serializable
  12. Identifiable
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TuneHyperparameters()

    Permalink
  2. new TuneHyperparameters(uid: String)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    Wrappable
  6. final def asInstanceOf[T0]: T0

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

    Permalink
    Definition Classes
    Params
  8. def clone(): AnyRef

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

    Permalink
    Definition Classes
    TuneHyperparameters → Estimator → PipelineStage → Params
  10. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  11. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. val evaluationMetric: Param[String]

    Permalink
    Definition Classes
    HasEvaluationMetric
  15. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  16. def explainParams(): String

    Permalink
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def fit(dataset: Dataset[_]): TuneHyperparametersModel

    Permalink

    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
  21. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[TuneHyperparametersModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  22. def fit(dataset: Dataset[_], paramMap: ParamMap): TuneHyperparametersModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TuneHyperparametersModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  24. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  27. def getEvaluationMetric: String

    Permalink

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

    Permalink

  29. def getNumFolds: Int

    Permalink

  30. def getNumRuns: Int

    Permalink

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

    Permalink
    Definition Classes
    Params
  32. def getParallelism: Int

    Permalink

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

    Permalink
    Definition Classes
    Params
  34. def getParamSpace: ParamSpace

    Permalink

  35. def getSeed: Long

    Permalink

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

    Permalink
    Definition Classes
    Params
  37. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  38. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  39. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  40. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  42. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    Params
  44. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. def log: Logger

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. def logName: String

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. val models: EstimatorArrayParam

    Permalink

    Estimators to run

  58. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  59. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  60. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  61. val numFolds: IntParam

    Permalink
  62. val numRuns: IntParam

    Permalink
  63. val parallelism: IntParam

    Permalink
  64. val paramSpace: ParamSpaceParam

    Permalink
  65. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  66. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  67. val seed: LongParam

    Permalink
  68. final def set(paramPair: ParamPair[_]): TuneHyperparameters.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  69. final def set(param: String, value: Any): TuneHyperparameters.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  70. final def set[T](param: Param[T], value: T): TuneHyperparameters.this.type

    Permalink
    Definition Classes
    Params
  71. final def setDefault(paramPairs: ParamPair[_]*): TuneHyperparameters.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  72. final def setDefault[T](param: Param[T], value: T): TuneHyperparameters.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  73. def setEvaluationMetric(value: String): TuneHyperparameters.this.type

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  81. def toString(): String

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

    Permalink
    Definition Classes
    TuneHyperparameters → PipelineStage
    Annotations
    @DeveloperApi()
  83. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  84. val uid: String

    Permalink
    Definition Classes
    TuneHyperparameters → Identifiable
  85. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. def write: MLWriter

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasEvaluationMetric

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from Wrappable

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