Class/Object

org.apache.spark.ml.odkl

ForkedEstimator

Related Docs: object ForkedEstimator | package odkl

Permalink

abstract class ForkedEstimator[ModelIn <: ModelWithSummary[ModelIn], ForeKeyType, ModelOut <: ModelWithSummary[ModelOut]] extends Estimator[ModelOut] with SummarizableEstimator[ModelOut] with ForkedModelParams with HasNumThreads

Utility used to split training into forks (per type, per class, per fold).

ModelIn

Type of model produced by the nested estimator.

ModelOut

Type of the resulting model. Does not have to be the same as ModelIn.

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

Instance Constructors

  1. new ForkedEstimator(nested: SummarizableEstimator[ModelIn], uid: String)

    Permalink

    nested

    Nested estimator to call for each fork.

Abstract Value Members

  1. abstract def copy(extra: ParamMap): SummarizableEstimator[ModelOut]

    Permalink
    Definition Classes
    SummarizableEstimator → Estimator → PipelineStage → Params
  2. abstract def createForks(dataset: Dataset[_]): Seq[(ForeKeyType, 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
  3. abstract def mergeModels(sqlContext: SQLContext, models: Seq[(ForeKeyType, Try[ModelIn])]): ModelOut

    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

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[_]): ForkedEstimator.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

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

    Permalink
    Attributes
    protected
  12. final val enableDive: BooleanParam

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String

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

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

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

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

    Permalink
    Attributes
    protected
  20. def finalize(): Unit

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

    Permalink
    Attributes
    protected
  22. def fit(dataset: Dataset[_]): ModelOut

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

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

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

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

    Permalink
  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 getCurrentContext: Seq[String]

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

    Permalink
    Definition Classes
    Params
  31. def getForkTags(partialData: (ForeKeyType, DataFrame)): Seq[(String, String)]

    Permalink
    Attributes
    protected
  32. final def getOrDefault[T](param: Param[T]): T

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
  51. def logName: String

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ForkedModelParams
  57. final def ne(arg0: AnyRef): Boolean

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

    Permalink

    Nested estimator to call for each fork.

  59. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  61. final val numThreads: IntParam

    Permalink
    Definition Classes
    HasNumThreads
  62. final val overwriteModels: BooleanParam

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

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

    Permalink
  65. final val persistingKeyColumns: StringArrayParam

    Permalink
  66. final val propagatedKeyColumn: Param[String]

    Permalink
    Definition Classes
    ForkedModelParams
  67. final def set(paramPair: ParamPair[_]): ForkedEstimator.this.type

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

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

    Permalink
    Definition Classes
    Params
  70. final def setDefault(paramPairs: ParamPair[_]*): ForkedEstimator.this.type

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

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

    Permalink
  73. def setNumThreads(value: Int): ForkedEstimator.this.type

    Permalink
    Definition Classes
    HasNumThreads
  74. def setOverwriteModels(value: Boolean): ForkedEstimator.this.type

    Permalink
  75. def setPathForTempModels(value: String): ForkedEstimator.this.type

    Permalink
  76. def setPropagatedKeyColumn(value: String): ForkedEstimator.this.type

    Permalink
    Definition Classes
    ForkedModelParams
  77. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    ForkedEstimator → Identifiable
  82. final def wait(): Unit

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

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

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

Inherited from HasNumThreads

Inherited from ForkedModelParams

Inherited from SummarizableEstimator[ModelOut]

Inherited from Estimator[ModelOut]

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