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

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
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. ForkedModelParams
  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

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: DataFrame): 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(models: Seq[(ForeKeyType, 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 val cacheForks: Param[Boolean]

    Permalink
  7. final def clear(param: Param[_]): ForkedEstimator.this.type

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def fit(dataset: DataFrame): ModelOut

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

    Permalink
    Definition Classes
    Estimator
  20. def fit(dataset: DataFrame, paramMap: ParamMap): ModelOut

    Permalink
    Definition Classes
    Estimator
  21. def fit(dataset: DataFrame, firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ModelOut

    Permalink
    Definition Classes
    Estimator
    Annotations
    @varargs()
  22. def fitFork(wholeData: DataFrame, partialData: (ForeKeyType, DataFrame)): (ForeKeyType, ModelIn)

    Permalink
  23. final def get[T](param: Param[T]): Option[T]

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

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  26. final def getOrDefault[T](param: Param[T]): T

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Nested estimator to call for each fork.

  50. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  52. lazy val params: Array[Param[_]]

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

    Permalink
  54. final val propagatedKeyColumn: Param[String]

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

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

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

    Permalink
    Definition Classes
    Params
  58. def setCacheForks(value: Boolean): ForkedEstimator.this.type

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  61. def setPathForTempModels(value: String): ForkedEstimator.this.type

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

    Permalink
    Definition Classes
    ForkedModelParams
  63. def setTrainParallel(value: Boolean): ForkedEstimator.this.type

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  66. final val trainParallel: Param[Boolean]

    Permalink
  67. def transformSchema(schema: StructType): StructType

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

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

    Permalink
    Definition Classes
    ForkedEstimator → Identifiable
  70. def validateParams(): Unit

    Permalink
    Definition Classes
    Params
  71. final def wait(): Unit

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

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

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

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