Class

org.apache.spark.ml.odkl.hyperopt

GridSearch

Related Doc: package hyperopt

Permalink

class GridSearch[ModelIn <: ModelWithSummary[ModelIn]] extends ForkedEstimator[ModelIn, ConfigHolder, ModelIn] with HyperparametersOptimizer[ModelIn]

Provides ability to search through multiple configurations in parallel mode, collecting all the stat and metrics.

Supports persisting temporary models in order to restore after failures, but only when used with StableOrderParamGridBuilder.

Linear Supertypes
HyperparametersOptimizer[ModelIn], HasConfigurations, MetricsExtractor, ForkedEstimator[ModelIn, ConfigHolder, ModelIn], HasNumThreads, ForkedModelParams, SummarizableEstimator[ModelIn], Estimator[ModelIn], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GridSearch
  2. HyperparametersOptimizer
  3. HasConfigurations
  4. MetricsExtractor
  5. ForkedEstimator
  6. HasNumThreads
  7. ForkedModelParams
  8. SummarizableEstimator
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GridSearch(nested: SummarizableEstimator[ModelIn])

    Permalink
  2. new GridSearch(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[_]): GridSearch.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
    HasConfigurations
  9. val configurations: Block

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. 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
  13. def createForkSource(dataset: Dataset[_]): ForkSource[ModelIn, ConfigHolder, ModelIn]

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedEstimator
  14. def createForks(dataset: Dataset[_]): Seq[(ConfigHolder, DataFrame)]

    Permalink

    Override this method and create forks to train from the data.

    Override this method and create forks to train from the data.

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  16. def diveToReproContext(partialData: (ConfigHolder, DataFrame), estimator: SummarizableEstimator[ModelIn]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    GridSearchForkedEstimator
  17. final val enableDive: BooleanParam

    Permalink
    Definition Classes
    ForkedEstimator
  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
    HasConfigurations
  21. val estimatorParamMaps: Param[Array[ParamMap]]

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

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

    Permalink
    Definition Classes
    Params
  24. final def extract(model: ModelWithSummary[_]): Option[DataFrame]

    Permalink
    Definition Classes
    MetricsExtractor
  25. 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
  26. def extractConfig(row: Row): (Double, ParamMap)

    Permalink

    In order to support correct restoration from the temporary model storage and grouped optimization we need a way to restore model configuration from its summary row of configurations block.

    In order to support correct restoration from the temporary model storage and grouped optimization we need a way to restore model configuration from its summary row of configurations block.

    Attributes
    protected
    Definition Classes
    GridSearchHyperparametersOptimizer
  27. def extractConfig(model: ModelIn): (Double, ParamMap)

    Permalink
    Definition Classes
    HyperparametersOptimizer
  28. val extractExpression: Param[String]

    Permalink
    Definition Classes
    MetricsExtractor
  29. def extractImpl(model: ModelWithSummary[_]): Option[DataFrame]

    Permalink
    Attributes
    protected
    Definition Classes
    HasConfigurationsMetricsExtractor
  30. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  32. 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
  33. def failFast(key: ConfigHolder, triedIn: Try[ModelIn]): Try[ModelIn]

    Permalink
    Attributes
    protected
    Definition Classes
    GridSearchForkedEstimator
  34. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def finilizeReproContext: ReproContext

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedEstimator
  36. def fit(dataset: Dataset[_]): ModelIn

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasConfigurations
  44. def getCurrentContext: Seq[String]

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

    Permalink
    Definition Classes
    Params
  46. def getErrorColumn: String

    Permalink
    Definition Classes
    HasConfigurations
  47. def getEstimatorParamMaps: Array[ParamMap]

    Permalink
  48. def getForkTags(partialData: (ConfigHolder, DataFrame)): Seq[(String, String)]

    Permalink
    Attributes
    protected
    Definition Classes
    GridSearchForkedEstimator
  49. def getMetricsBlock: String

    Permalink
    Definition Classes
    HyperparametersOptimizer
  50. def getMetricsExpression: String

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

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

    Permalink
    Definition Classes
    Params
  53. def getResultingMetricColumn: String

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logMetricsToReproContext(model: ModelIn): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedEstimator
  71. def logName: String

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. def mayBePropagateKey(data: DataFrame, key: Any): DataFrame

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

    Permalink

    Given models trained for each fork create a combined model.

    Given models trained for each fork create a combined model. This model is the result of the estimator.

    Attributes
    protected
    Definition Classes
    GridSearchForkedEstimator
  78. val metricsBlock: Param[String]

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

    Permalink
    Definition Classes
    HyperparametersOptimizer
  80. final def ne(arg0: AnyRef): Boolean

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

    Permalink

    Nested estimator to call for each fork.

    Nested estimator to call for each fork.

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

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

    Permalink
    Definition Classes
    AnyRef
  84. final val numThreads: IntParam

    Permalink
    Definition Classes
    HasNumThreads
  85. final val overwriteModels: BooleanParam

    Permalink
    Definition Classes
    ForkedEstimator
  86. val paramNames: Param[Map[Param[_], String]]

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

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

    Permalink
    Definition Classes
    ForkedEstimator
  89. final val persistingKeyColumns: StringArrayParam

    Permalink
    Definition Classes
    ForkedEstimator
  90. final val propagatedKeyColumn: Param[String]

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

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

    Permalink
    Definition Classes
    HasConfigurations
  93. final def set(paramPair: ParamPair[_]): GridSearch.this.type

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

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

    Permalink
    Definition Classes
    Params
  96. def setConfigurationIndexColumn(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    HasConfigurations
  97. final def setDefault(paramPairs: ParamPair[_]*): GridSearch.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  99. def setEnableDive(value: Boolean): GridSearch.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  100. def setErrorColumn(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    HasConfigurations
  101. def setEstimatorParamMaps(value: Array[ParamMap]): GridSearch.this.type

    Permalink
  102. def setExtractExpression(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    MetricsExtractor
  103. def setMetricsBlock(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  104. def setMetricsExpression(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  105. def setNumThreads(value: Int): GridSearch.this.type

    Permalink
    Definition Classes
    HasNumThreads
  106. def setOverwriteModels(value: Boolean): GridSearch.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  107. def setParamNames(value: (Param[_], String)*): GridSearch.this.type

    Permalink
    Definition Classes
    HyperparametersOptimizer
  108. def setPathForTempModels(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  109. def setPropagatedKeyColumn(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    ForkedModelParams
  110. def setResultingMetricColumn(value: String): GridSearch.this.type

    Permalink
    Definition Classes
    HasConfigurations
  111. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    GridSearchForkedEstimator → Identifiable
  116. final def wait(): Unit

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

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

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

Inherited from HyperparametersOptimizer[ModelIn]

Inherited from HasConfigurations

Inherited from MetricsExtractor

Inherited from ForkedEstimator[ModelIn, ConfigHolder, ModelIn]

Inherited from HasNumThreads

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