Class

org.apache.spark.ml.odkl.hyperopt

StochasticHyperopt

Related Doc: package hyperopt

Permalink

class StochasticHyperopt[ModelIn <: ModelWithSummary[ModelIn]] extends ForkedEstimator[ModelIn, ConfigNumber, ModelIn] with HyperparametersOptimizer[ModelIn] with HasMaxIter with HasTol with HasSeed

Searches for optimal parameters using Bayesian approach. Important difference of this searcher compared to other forked estimators is the need to get previous evaluation to know where to sample next params.

Linear Supertypes
HasSeed, HasTol, HasMaxIter, HyperparametersOptimizer[ModelIn], HasConfigurations, ForkedEstimator[ModelIn, ConfigNumber, ModelIn], ForkedModelParams, SummarizableEstimator[ModelIn], Estimator[ModelIn], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StochasticHyperopt
  2. HasSeed
  3. HasTol
  4. HasMaxIter
  5. HyperparametersOptimizer
  6. HasConfigurations
  7. ForkedEstimator
  8. ForkedModelParams
  9. SummarizableEstimator
  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 StochasticHyperopt(nested: SummarizableEstimator[ModelIn])

    Permalink
  2. new StochasticHyperopt(nested: SummarizableEstimator[ModelIn], 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[_]): StochasticHyperopt.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val configurationIndexColumn: Param[String]

    Permalink
    Definition Classes
    HyperparametersOptimizer
  9. val configurations: Block

    Permalink
    Definition Classes
    HasConfigurations
  10. def copy(extra: ParamMap): StochasticHyperopt[ModelIn]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. def createConfigDF(config: ParamMap): DataFrame

    Permalink
  13. def createConfigurationsBlock(sqlContext: SQLContext, failedModels: Seq[(ParamMap, Try[ModelIn])], rankedModels: Seq[(ParamMap, ModelIn, Double)]): DataFrame

    Permalink

    Create summary block with investigated configurations.

    Create summary block with investigated configurations.

    Attributes
    protected
    Definition Classes
    HyperparametersOptimizer
  14. def createForkSource(dataset: Dataset[_]): ForkSource[ModelIn, ConfigNumber, ModelIn]

    Permalink
    Attributes
    protected
    Definition Classes
    StochasticHyperoptForkedEstimator
  15. def createForks(dataset: Dataset[_]): Seq[(ConfigNumber, DataFrame)]

    Permalink

    Not used due to custom forks source

    Not used due to custom forks source

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. val epsilonGreedy: DoubleParam

    Permalink
  18. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. val errorColumn: Param[String]

    Permalink
    Definition Classes
    HyperparametersOptimizer
  21. def explainParam(param: Param[_]): String

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

    Permalink
    Definition Classes
    Params
  23. def extractBestModel(sqlContext: SQLContext, failedModels: Seq[(ParamMap, Try[ModelIn])], rankedModels: Seq[(ParamMap, ModelIn, Double)]): ModelIn

    Permalink

    Given all the history of the optimization create the resulting model with the configurations summary block.

    Given all the history of the optimization create the resulting model with the configurations summary block.

    Attributes
    protected
    Definition Classes
    HyperparametersOptimizer
  24. def extractConfig(row: Row): (Double, ParamMap)

    Permalink

    Extract model configuration from the configurations data frame row.

    Extract model configuration from the configurations data frame row.

    Attributes
    protected
    Definition Classes
    StochasticHyperoptHyperparametersOptimizer
  25. def extractConfig(model: ModelIn): (Double, ParamMap)

    Permalink
    Definition Classes
    HyperparametersOptimizer
  26. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  28. def extractParamsAndQuality(params: ParamMap, model: ModelIn): (ParamMap, ModelIn, Double)

    Permalink

    Extracts information of the resulting metrics from the trained model.

    Extracts information of the resulting metrics from the trained model.

    Attributes
    protected
    Definition Classes
    HyperparametersOptimizer
  29. def failFast(key: ConfigNumber, triedIn: Try[ModelIn]): Try[ModelIn]

    Permalink
    Attributes
    protected
    Definition Classes
    StochasticHyperoptForkedEstimator
  30. def finalize(): Unit

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

    Permalink
    Definition Classes
    StochasticHyperoptForkedEstimator → Estimator
  32. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[ModelIn]

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  35. def fitFork(estimator: SummarizableEstimator[ModelIn], wholeData: Dataset[_], partialData: (ConfigNumber, DataFrame)): (ConfigNumber, Try[ModelIn])

    Permalink
    Definition Classes
    StochasticHyperoptForkedEstimator
  36. final def get[T](param: Param[T]): Option[T]

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

    Permalink
    Definition Classes
    AnyRef → Any
  38. def getConfigurationIndexColumn: String

    Permalink
    Definition Classes
    HyperparametersOptimizer
  39. def getCurrentContext: Seq[String]

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedEstimator
  40. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  41. final def getMaxIter: Int

    Permalink
    Definition Classes
    HasMaxIter
  42. def getMetricsBlock: String

    Permalink
    Definition Classes
    HyperparametersOptimizer
  43. def getMetricsExpression: String

    Permalink
    Definition Classes
    HyperparametersOptimizer
  44. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  45. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  46. def getResultingMetricColumn: String

    Permalink
    Definition Classes
    HyperparametersOptimizer
  47. final def getSeed: Long

    Permalink
    Definition Classes
    HasSeed
  48. final def getTol: Double

    Permalink
    Definition Classes
    HasTol
  49. final def hasDefault[T](param: Param[T]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. final val maxIter: IntParam

    Permalink
    Definition Classes
    HasMaxIter
  71. val maxNoImproveIters: IntParam

    Permalink
  72. def mayBePropagateKey(data: DataFrame, key: Any): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedModelParams
  73. def mergeModels(sqlContext: SQLContext, models: Seq[(ConfigNumber, Try[ModelIn])]): ModelIn

    Permalink

    Not used due to custom forks source

    Not used due to custom forks source

    Attributes
    protected
    Definition Classes
    StochasticHyperoptForkedEstimator
  74. val metricsBlock: Param[String]

    Permalink
    Definition Classes
    HyperparametersOptimizer
  75. val metricsExpression: Param[String]

    Permalink
    Definition Classes
    HyperparametersOptimizer
  76. val nanReplacement: DoubleParam

    Permalink
  77. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  78. val nested: SummarizableEstimator[ModelIn]

    Permalink

    Nested estimator to call for each fork.

    Nested estimator to call for each fork.

    Definition Classes
    ForkedEstimator
  79. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  81. final val numThreads: IntParam

    Permalink
    Definition Classes
    ForkedEstimator
  82. final val overwriteModels: BooleanParam

    Permalink
    Definition Classes
    ForkedEstimator
  83. val paramDomains: Param[Seq[ParamDomainPair[_]]]

    Permalink
  84. val paramNames: Param[Map[Param[_], String]]

    Permalink
    Definition Classes
    HyperparametersOptimizer
  85. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  86. final val pathForTempModels: Param[String]

    Permalink
    Definition Classes
    ForkedEstimator
  87. final val persistingKeyColumns: StringArrayParam

    Permalink
    Definition Classes
    ForkedEstimator
  88. val priorsContextFilter: Param[String]

    Permalink
  89. val priorsPath: Param[String]

    Permalink
  90. val priorsToSample: IntParam

    Permalink
  91. final val propagatedKeyColumn: Param[String]

    Permalink
    Definition Classes
    ForkedModelParams
  92. def resolveParamName(param: Param[_]): String

    Permalink
    Definition Classes
    HyperparametersOptimizer
  93. val resultingMetricColumn: Param[String]

    Permalink
    Definition Classes
    HyperparametersOptimizer
  94. val searchMode: Param[BayesianParamOptimizerFactory]

    Permalink
  95. final val seed: LongParam

    Permalink
    Definition Classes
    HasSeed
  96. final def set(paramPair: ParamPair[_]): StochasticHyperopt.this.type

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

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

    Permalink
    Definition Classes
    Params
  99. def setConfigurationIndexColumn(value: String): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  100. final def setDefault(paramPairs: ParamPair[_]*): StochasticHyperopt.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  102. def setEpsilonGreedy(value: Double): StochasticHyperopt.this.type

    Permalink
  103. def setMaxIter(iters: Int): StochasticHyperopt.this.type

    Permalink
  104. def setMaxNoImproveIters(value: Int): StochasticHyperopt.this.type

    Permalink
  105. def setMetricsBlock(value: String): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  106. def setMetricsExpression(value: String): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  107. def setNanReplacement(value: Double): StochasticHyperopt.this.type

    Permalink
  108. def setNumThreads(value: Int): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  109. def setOverwriteModels(value: Boolean): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  110. def setParamDomains(pairs: ParamDomainPair[_]*): StochasticHyperopt.this.type

    Permalink
  111. def setParamNames(value: (Param[_], String)*): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  112. def setPathForTempModels(value: String): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  113. def setPriorsContextFilter(value: String): StochasticHyperopt.this.type

    Permalink
  114. def setPriorsPath(value: String): StochasticHyperopt.this.type

    Permalink
  115. def setPriorsToSample(value: Int): StochasticHyperopt.this.type

    Permalink
  116. def setPropagatedKeyColumn(value: String): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    ForkedModelParams
  117. def setResultingMetricColumn(value: String): StochasticHyperopt.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  118. def setSearchMode(value: BayesianParamOptimizerFactory): StochasticHyperopt.this.type

    Permalink
  119. def setSeed(value: Long): StochasticHyperopt.this.type

    Permalink
  120. def setTol(value: Double): StochasticHyperopt.this.type

    Permalink
  121. def setTopKForTolerance(value: Int): StochasticHyperopt.this.type

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  124. final val tol: DoubleParam

    Permalink
    Definition Classes
    HasTol
  125. val topKForTolerance: IntParam

    Permalink
  126. def transformSchema(schema: StructType): StructType

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

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

    Permalink
    Definition Classes
    StochasticHyperoptForkedEstimator → Identifiable
  129. final def wait(): Unit

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

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

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

Inherited from HasSeed

Inherited from HasTol

Inherited from HasMaxIter

Inherited from HyperparametersOptimizer[ModelIn]

Inherited from HasConfigurations

Inherited from ForkedEstimator[ModelIn, ConfigNumber, ModelIn]

Inherited from ForkedModelParams

Inherited from SummarizableEstimator[ModelIn]

Inherited from Estimator[ModelIn]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped