Trait

org.apache.spark.ml.odkl.hyperopt

HyperparametersOptimizer

Related Doc: package hyperopt

Permalink

trait HyperparametersOptimizer[M <: ModelWithSummary[M]] extends Estimator[M] with SummarizableEstimator[M] with HasConfigurations

Common trait to all the hyper-parameter optimizers.

Linear Supertypes
HasConfigurations, SummarizableEstimator[M], Estimator[M], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HyperparametersOptimizer
  2. HasConfigurations
  3. SummarizableEstimator
  4. Estimator
  5. PipelineStage
  6. Logging
  7. Params
  8. Serializable
  9. Serializable
  10. Identifiable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): HyperparametersOptimizer[M]

    Permalink
    Definition Classes
    HyperparametersOptimizerSummarizableEstimator → Estimator → PipelineStage → Params
  2. abstract 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
  3. abstract def fit(dataset: Dataset[_]): M

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  4. abstract def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  5. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

Concrete 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[_]): HyperparametersOptimizer.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
  9. val configurations: Block

    Permalink
    Definition Classes
    HasConfigurations
  10. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  11. def createConfigurationsBlock(sqlContext: SQLContext, failedModels: Seq[(ParamMap, Try[M])], rankedModels: Seq[(ParamMap, M, Double)]): DataFrame

    Permalink

    Create summary block with investigated configurations.

    Create summary block with investigated configurations.

    Attributes
    protected
  12. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    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
  19. def extractConfig(model: M): (Double, ParamMap)

    Permalink
  20. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  22. def extractParamsAndQuality(params: ParamMap, model: M): (ParamMap, M, Double)

    Permalink

    Extracts information of the resulting metrics from the trained model.

    Extracts information of the resulting metrics from the trained model.

    Attributes
    protected
  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[M]

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  27. final def get[T](param: Param[T]): Option[T]

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

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

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

    Permalink
    Definition Classes
    Params
  31. def getMetricsBlock: String

    Permalink
  32. def getMetricsExpression: String

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

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

    Permalink
    Definition Classes
    Params
  35. def getResultingMetricColumn: String

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. val metricsBlock: Param[String]

    Permalink
  58. val metricsExpression: Param[String]

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

    Permalink
    Definition Classes
    AnyRef
  60. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  62. val paramNames: Param[Map[Param[_], String]]

    Permalink
  63. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  64. def resolveParamName(param: Param[_]): String

    Permalink
  65. val resultingMetricColumn: Param[String]

    Permalink
  66. final def set(paramPair: ParamPair[_]): HyperparametersOptimizer.this.type

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

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

    Permalink
    Definition Classes
    Params
  69. def setConfigurationIndexColumn(value: String): HyperparametersOptimizer.this.type

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  72. def setMetricsBlock(value: String): HyperparametersOptimizer.this.type

    Permalink
  73. def setMetricsExpression(value: String): HyperparametersOptimizer.this.type

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

    Permalink
  75. def setResultingMetricColumn(value: String): HyperparametersOptimizer.this.type

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  78. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  79. final def wait(): Unit

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

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

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

Inherited from HasConfigurations

Inherited from SummarizableEstimator[M]

Inherited from Estimator[M]

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