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, ForkedEstimator[ModelIn, ConfigHolder, ModelIn], 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. ForkedEstimator
  5. ForkedModelParams
  6. SummarizableEstimator
  7. Estimator
  8. PipelineStage
  9. Logging
  10. Params
  11. Serializable
  12. Serializable
  13. Identifiable
  14. AnyRef
  15. 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
    HyperparametersOptimizer
  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. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    HyperparametersOptimizer
  19. val estimatorParamMaps: Param[Array[ParamMap]]

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

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

    Permalink
    Definition Classes
    Params
  22. 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
  23. 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
  24. def extractConfig(model: ModelIn): (Double, ParamMap)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  40. def getEstimatorParamMaps: Array[ParamMap]

    Permalink
  41. def getMetricsBlock: String

    Permalink
    Definition Classes
    HyperparametersOptimizer
  42. def getMetricsExpression: String

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

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

    Permalink
    Definition Classes
    Params
  45. def getResultingMetricColumn: String

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedModelParams
  68. 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
  69. val metricsBlock: Param[String]

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

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

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

    Permalink

    Nested estimator to call for each fork.

    Nested estimator to call for each fork.

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

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

    Permalink
    Definition Classes
    AnyRef
  75. final val numThreads: IntParam

    Permalink
    Definition Classes
    ForkedEstimator
  76. final val overwriteModels: BooleanParam

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

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

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

    Permalink
    Definition Classes
    ForkedEstimator
  80. final val persistingKeyColumns: StringArrayParam

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  90. def setEstimatorParamMaps(value: Array[ParamMap]): GridSearch.this.type

    Permalink
  91. def setMetricsBlock(value: String): GridSearch.this.type

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

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

    Permalink
    Definition Classes
    ForkedEstimator
  94. def setOverwriteModels(value: Boolean): GridSearch.this.type

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

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

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

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

    Permalink
    Definition Classes
    HyperparametersOptimizer
  99. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

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

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

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

Inherited from HyperparametersOptimizer[ModelIn]

Inherited from HasConfigurations

Inherited from ForkedEstimator[ModelIn, ConfigHolder, 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