Class

org.apache.spark.ml.odkl.hyperopt

GroupedSearch

Related Doc: package hyperopt

Permalink

class GroupedSearch[ModelIn <: ModelWithSummary[ModelIn]] extends ForkedEstimator[ModelIn, OptimizerStage, ModelIn] with HasConfigurations

Utility used to perform stepwise search for hyper-parameters. Usefull in case if there are certain groups of parameters which do not influence each other and can be optimized separatelly. Pass sequence of optimizers to the grouped search to apply sequential optimization.

NB: Grouped search must itself be configured to use single thread, but nested optimizers allowed to use as many threads as they need.

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

Instance Constructors

  1. new GroupedSearch(nested: Seq[(String, HyperparametersOptimizer[ModelIn])])

    Permalink
  2. new GroupedSearch(nested: Seq[(String, HyperparametersOptimizer[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[_]): GroupedSearch.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): GroupedSearch[ModelIn]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. def createForkSource(dataset: Dataset[_]): ForkSource[ModelIn, OptimizerStage, ModelIn]

    Permalink
    Attributes
    protected
    Definition Classes
    GroupedSearchForkedEstimator
  13. def createForks(dataset: Dataset[_]): Seq[(OptimizerStage, 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
    GroupedSearchForkedEstimator
  14. final def defaultCopy[T <: Params](extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedEstimator
  16. final val enableDive: BooleanParam

    Permalink
    Definition Classes
    ForkedEstimator
  17. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    MetricsExtractor
  23. val extractExpression: Param[String]

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

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

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

    Permalink
    Definition Classes
    Params
  27. def failFast(key: OptimizerStage, triedIn: Try[ModelIn]): Try[ModelIn]

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedEstimator
  28. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    GroupedSearchForkedEstimator → 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: (OptimizerStage, DataFrame)): (OptimizerStage, Try[ModelIn])

    Permalink
    Definition Classes
    GroupedSearchForkedEstimator
  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
    HasConfigurations
  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 getErrorColumn: String

    Permalink
    Definition Classes
    HasConfigurations
  41. def getForkTags(partialData: (OptimizerStage, DataFrame)): Seq[(String, String)]

    Permalink
    Attributes
    protected
    Definition Classes
    GroupedSearchForkedEstimator
  42. final def getOrDefault[T](param: Param[T]): T

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

    Permalink
    Definition Classes
    Params
  44. def getResultingMetricColumn: String

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedEstimator
  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[(OptimizerStage, 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
    GroupedSearchForkedEstimator
  69. final def ne(arg0: AnyRef): Boolean

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

    Permalink

    Nested estimator to call for each fork.

    Nested estimator to call for each fork.

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

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

    Permalink
    Definition Classes
    AnyRef
  73. final val numThreads: IntParam

    Permalink
    Definition Classes
    HasNumThreads
  74. final val overwriteModels: BooleanParam

    Permalink
    Definition Classes
    ForkedEstimator
  75. lazy val params: Array[Param[_]]

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

    Permalink
    Definition Classes
    ForkedEstimator
  77. final val persistingKeyColumns: StringArrayParam

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

    Permalink
    Definition Classes
    ForkedModelParams
  79. val resultingMetricColumn: Param[String]

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

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

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

    Permalink
    Definition Classes
    Params
  83. def setConfigurationIndexColumn(value: String): GroupedSearch.this.type

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

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

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

    Permalink
    Definition Classes
    ForkedEstimator
  87. def setErrorColumn(value: String): GroupedSearch.this.type

    Permalink
    Definition Classes
    HasConfigurations
  88. def setExtractExpression(value: String): GroupedSearch.this.type

    Permalink
    Definition Classes
    MetricsExtractor
  89. def setNumThreads(value: Int): GroupedSearch.this.type

    Permalink
    Definition Classes
    HasNumThreads
  90. def setOverwriteModels(value: Boolean): GroupedSearch.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  91. def setPathForTempModels(value: String): GroupedSearch.this.type

    Permalink
    Definition Classes
    ForkedEstimator
  92. def setPropagatedKeyColumn(value: String): GroupedSearch.this.type

    Permalink
    Definition Classes
    ForkedModelParams
  93. def setResultingMetricColumn(value: String): GroupedSearch.this.type

    Permalink
    Definition Classes
    HasConfigurations
  94. val stageNameColumnName: Param[String]

    Permalink
  95. val stageReversedIndexColumnName: Param[String]

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

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

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

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

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

    Permalink
    Definition Classes
    GroupedSearchForkedEstimator → Identifiable
  101. final def wait(): Unit

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

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

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

Inherited from HasConfigurations

Inherited from MetricsExtractor

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