Class/Object

com.microsoft.ml.spark

TuneHyperparameters

Related Docs: object TuneHyperparameters | package spark

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, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. final def clear(param: Param[_]): TuneHyperparameters.this.type

    Permalink
    Definition Classes
    Params

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def copy(extra: ParamMap): Estimator[TuneHyperparametersModel]

    Permalink
    Definition Classes
    TuneHyperparameters → Estimator → PipelineStage → Params

  9. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  10. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  13. val evaluationMetric: Param[String]

    Permalink
    Definition Classes
    HasEvaluationMetric

  14. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  15. def explainParams(): String

    Permalink
    Definition Classes
    Params

  16. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  17. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. 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

  20. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[TuneHyperparametersModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  21. def fit(dataset: Dataset[_], paramMap: ParamMap): TuneHyperparametersModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  22. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TuneHyperparametersModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()

  23. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  26. def getEvaluationMetric: String

    Permalink

    Definition Classes
    HasEvaluationMetric

  27. def getModels: Array[Estimator[_]]

    Permalink

  28. def getNumFolds: Int

    Permalink

  29. def getNumRuns: Int

    Permalink

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

    Permalink
    Definition Classes
    Params

  31. def getParallelism: Int

    Permalink

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

    Permalink
    Definition Classes
    Params

  33. def getParamSpace: ParamSpace

    Permalink

  34. def getSeed: Long

    Permalink

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

    Permalink
    Definition Classes
    Params

  36. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  37. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  38. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  39. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  40. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  41. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  42. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  43. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  44. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  45. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  46. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  47. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  48. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  49. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  50. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  53. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  54. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  55. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  56. val models: EstimatorArrayParam

    Permalink

    Estimators to run

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

    Permalink
    Definition Classes
    AnyRef

  58. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  59. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  60. val numFolds: IntParam

    Permalink

  61. val numRuns: IntParam

    Permalink

  62. val parallelism: IntParam

    Permalink

  63. val paramSpace: ParamSpaceParam

    Permalink

  64. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  65. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  66. val seed: LongParam

    Permalink

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  68. final def set(param: String, value: Any): TuneHyperparameters.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  69. final def set[T](param: Param[T], value: T): TuneHyperparameters.this.type

    Permalink
    Definition Classes
    Params

  70. final def setDefault(paramPairs: ParamPair[_]*): TuneHyperparameters.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  71. final def setDefault[T](param: Param[T], value: T): TuneHyperparameters.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  72. def setEvaluationMetric(value: String): TuneHyperparameters.this.type

    Permalink

    Definition Classes
    HasEvaluationMetric

  73. def setModels(value: Array[Estimator[_]]): TuneHyperparameters.this.type

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  80. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  81. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    TuneHyperparameters → PipelineStage
    Annotations
    @DeveloperApi()

  82. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  83. val uid: String

    Permalink
    Definition Classes
    TuneHyperparameters → Identifiable

  84. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  85. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  86. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  87. 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 org.apache.spark.internal.Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters

Parameter setters

Parameter getters

Members