Class

com.salesforce.op.stages.impl.selector

SelectedModelCombiner

Related Doc: package selector

Permalink

class SelectedModelCombiner extends Estimator[SelectedCombinerModel] with OpPipelineStage3[RealNN, Prediction, Prediction, Prediction] with SelectedCombinerParams with HasEval

Class used to combine the predictions produced by two model selectors into a single prediction. Does this by either taking the best models prediction or a combination of the two predictions that is either weighted by the accuracy measure or equal. Uses the summary information from the model selectors to determine the accuracy of the predictions and reruns evaluation (both train and test) when the predictions are combined.

Linear Supertypes
HasEval, SelectedCombinerParams, OpPipelineStage3[RealNN, Prediction, Prediction, Prediction], HasOut[Prediction], HasIn3, HasIn2, HasIn1, OpPipelineStage[Prediction], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[SelectedCombinerModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SelectedModelCombiner
  2. HasEval
  3. SelectedCombinerParams
  4. OpPipelineStage3
  5. HasOut
  6. HasIn3
  7. HasIn2
  8. HasIn1
  9. OpPipelineStage
  10. OpPipelineStageBase
  11. MLWritable
  12. OpPipelineStageParams
  13. InputParams
  14. Estimator
  15. PipelineStage
  16. Logging
  17. Params
  18. Serializable
  19. Serializable
  20. Identifiable
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SelectedModelCombiner(operationName: String = "combineModels", uid: String = UID[SelectedModelCombiner])(implicit tto: scala.reflect.api.JavaUniverse.TypeTag[Prediction], ttov: scala.reflect.api.JavaUniverse.TypeTag[Map[String, Double]])

    Permalink

    operationName

    name of operation

    uid

    stage uid

Type Members

  1. final type InputFeatures = (FeatureLike[RealNN], FeatureLike[Prediction], FeatureLike[Prediction])

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage3OpPipelineStageInputParams
  2. final type OutputFeatures = FeatureLike[Prediction]

    Permalink
    Definition Classes
    OpPipelineStageOpPipelineStageBase

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 checkInputLength(features: Array[_]): Boolean

    Permalink

    Checks the input length

    Checks the input length

    features

    input features

    returns

    true is input size as expected, false otherwise

    Definition Classes
    OpPipelineStage3InputParams
  7. def checkSerializable: Try[Unit]

    Permalink

    Check if the stage is serializable

    Check if the stage is serializable

    returns

    Failure if not serializable

    Definition Classes
    OpPipelineStageBase
  8. final def clear(param: Param[_]): SelectedModelCombiner.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final val combinationStrategy: Param[String]

    Permalink
    Definition Classes
    SelectedCombinerParams
  11. final def copy(extra: ParamMap): SelectedModelCombiner.this.type

    Permalink

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    This method is used to make a copy of the instance with new parameters in several methods in spark internals Default will find the constructor and make a copy for any class (AS LONG AS ALL CONSTRUCTOR PARAMS ARE VALS, this is why type tags are written as implicit vals in base classes).

    Note: that the convention in spark is to have the uid be a constructor argument, so that copies will share a uid with the original (developers should follow this convention).

    extra

    new parameters want to add to instance

    returns

    a new instance with the same uid

    Definition Classes
    OpPipelineStageBase → Params
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def evaluate(data: Dataset[_]): EvaluationMetrics

    Permalink

    Function that evaluates the selected model on the test set

    Function that evaluates the selected model on the test set

    data

    data transformed by best model

    returns

    EvaluationMetrics

    Attributes
    protected
    Definition Classes
    HasEval
  17. def evaluators: Seq[OpEvaluatorBase[_ <: EvaluationMetrics]]

    Permalink
    Definition Classes
    SelectedModelCombiner → HasEval
  18. def explainParam(param: Param[_]): String

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

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

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

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

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

    Permalink
    Definition Classes
    SelectedModelCombiner → Estimator
  24. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SelectedCombinerModel]

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  27. def fullPredictionColName: Option[String]

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    HasEval
  28. final def get[T](param: Param[T]): Option[T]

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

    Permalink
    Definition Classes
    AnyRef → Any
  30. def getCombinationStrategy(): CombinationStrategy

    Permalink
    Definition Classes
    SelectedCombinerParams
  31. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  32. final def getInputFeature[T <: FeatureType](i: Int): Option[FeatureLike[T]]

    Permalink

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    Gets an input feature Note: this method IS NOT safe to use outside the driver, please use getTransientFeature method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  33. final def getInputFeatures(): Array[OPFeature]

    Permalink

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    Gets the input features Note: this method IS NOT safe to use outside the driver, please use getTransientFeatures method instead

    returns

    array of features

    Definition Classes
    InputParams
    Exceptions thrown

    NoSuchElementException if the features are not set

    RuntimeException in case one of the features is null

  34. final def getInputSchema(): StructType

    Permalink
    Definition Classes
    OpPipelineStageParams
  35. final def getMetadata(): Metadata

    Permalink
    Definition Classes
    OpPipelineStageParams
  36. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  37. def getOutput(): FeatureLike[Prediction]

    Permalink

    Output features that will be created by this stage

    Output features that will be created by this stage

    returns

    feature of type OutputFeatures

    Definition Classes
    HasOut → OpPipelineStageBase
  38. final def getOutputFeatureName: String

    Permalink

    Name of output feature (i.e.

    Name of output feature (i.e. column created by this stage)

    Definition Classes
    OpPipelineStage
  39. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  40. final def getTransientFeature(i: Int): Option[TransientFeature]

    Permalink

    Gets an input feature at index i

    Gets an input feature at index i

    i

    input index

    returns

    maybe an input feature

    Definition Classes
    InputParams
  41. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

    Definition Classes
    InputParams
  42. final def hasDefault[T](param: Param[T]): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  45. final def in1: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  46. final def in2: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn2
  47. final def in3: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn3
  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 inputAsArray(in: InputFeatures): Array[OPFeature]

    Permalink

    Function to convert InputFeatures to an Array of FeatureLike

    Function to convert InputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStage3InputParams
  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 labelColName: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    SelectedModelCombiner → HasEval
  56. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  71. def onGetMetadata(): Unit

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

    Attributes
    protected
    Definition Classes
    OpPipelineStageParams
  72. def onSetInput(): Unit

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Definition Classes
    SelectedModelCombinerInputParams
  73. val operationName: String

    Permalink

    name of operation

    name of operation

    Definition Classes
    SelectedModelCombinerOpPipelineStageBase
  74. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink

    Function to convert OutputFeatures to an Array of FeatureLike

    Function to convert OutputFeatures to an Array of FeatureLike

    returns

    an Array of FeatureLike

    Definition Classes
    OpPipelineStageOpPipelineStageBase
  75. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage3OpPipelineStage
  76. def outputIsResponse: Boolean

    Permalink

    Should output feature be a response? Yes, if any of the input features are.

    Should output feature be a response? Yes, if any of the input features are.

    returns

    true if the the output feature should be a response

    Definition Classes
    OpPipelineStage
  77. def outputsColNamesMap: Map[String, String]

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    SelectedModelCombiner → HasEval
  78. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  79. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  80. final def set(paramPair: ParamPair[_]): SelectedModelCombiner.this.type

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

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

    Permalink
    Definition Classes
    Params
  83. def setCombinationStrategy(value: CombinationStrategy): SelectedModelCombiner.this.type

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  86. final def setInput(features: InputFeatures): SelectedModelCombiner.this.type

    Permalink

    Input features that will be used by the stage

    Input features that will be used by the stage

    returns

    feature of type InputFeatures

    Definition Classes
    OpPipelineStageBase
  87. final def setInputFeatures[S <: OPFeature](features: Array[S]): SelectedModelCombiner.this.type

    Permalink

    Sets input features

    Sets input features

    S

    feature like type

    features

    array of input features

    returns

    this stage

    Attributes
    protected
    Definition Classes
    InputParams
  88. final def setMetadata(m: Metadata): SelectedModelCombiner.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  89. def setOutputFeatureName(name: String): SelectedModelCombiner.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  90. final def stageName: String

    Permalink

    Stage unique name consisting of the stage operation name and uid

    Stage unique name consisting of the stage operation name and uid

    returns

    stage name

    Definition Classes
    OpPipelineStageBase
  91. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    This function translates the input and output features into spark schema checks and changes that will occur on the underlying data frame

    schema

    schema of the input data frame

    returns

    a new schema with the output features added

    Definition Classes
    OpPipelineStageBase
  94. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  95. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[Prediction]

    Permalink

    Type tag of the output

    Type tag of the output

    Definition Classes
    SelectedModelCombiner → HasOut
  96. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[Map[String, Double]]

    Permalink

    Type tag of the output value

    Type tag of the output value

    Definition Classes
    SelectedModelCombiner → HasOut
  97. val uid: String

    Permalink

    stage uid

    stage uid

    Definition Classes
    SelectedModelCombiner → Identifiable
  98. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. final def write: MLWriter

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from HasEval

Inherited from SelectedCombinerParams

Inherited from HasOut[Prediction]

Inherited from HasIn3

Inherited from HasIn2

Inherited from HasIn1

Inherited from OpPipelineStage[Prediction]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Estimator[SelectedCombinerModel]

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