Class

com.salesforce.op.stages.sparkwrappers.generic

SwQuaternaryEstimator

Related Doc: package generic

Permalink

class SwQuaternaryEstimator[I1 <: FeatureType, I2 <: FeatureType, I3 <: FeatureType, I4 <: FeatureType, O <: FeatureType, M <: Model[M], E <: Estimator[M] with Params] extends Estimator[SwQuaternaryModel[I1, I2, I3, I4, O, M]] with OpPipelineStage4[I1, I2, I3, I4, O] with SparkWrapperParams[E]

Generic wrapper for any spark estimator that has four inputs and one output

I1

first input feature type

I2

second input feature type

I3

third input feature type

I4

fourth input feature type

O

output feature type

M

spark model type returned by spark estimator wrapped

E

spark estimator to wrap

Linear Supertypes
SparkWrapperParams[E], OpPipelineStage4[I1, I2, I3, I4, O], HasOut[O], HasIn4, HasIn3, HasIn2, HasIn1, OpPipelineStage[O], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[SwQuaternaryModel[I1, I2, I3, I4, O, M]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwQuaternaryEstimator
  2. SparkWrapperParams
  3. OpPipelineStage4
  4. HasOut
  5. HasIn4
  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 SwQuaternaryEstimator(inputParam1Name: String, inputParam2Name: String, inputParam3Name: String, inputParam4Name: String, outputParamName: String, operationName: String, sparkMlStageIn: Option[E], uid: String = ...)(implicit tti1: scala.reflect.api.JavaUniverse.TypeTag[I1], tti2: scala.reflect.api.JavaUniverse.TypeTag[I2], tti3: scala.reflect.api.JavaUniverse.TypeTag[I3], tti4: scala.reflect.api.JavaUniverse.TypeTag[I4], tto: scala.reflect.api.JavaUniverse.TypeTag[O], ttov: scala.reflect.api.JavaUniverse.TypeTag[O.Value])

    Permalink

    inputParam1Name

    name of spark parameter that sets the first input column

    inputParam2Name

    name of spark parameter that sets the second input column

    inputParam3Name

    name of spark parameter that sets the third input column

    inputParam4Name

    name of spark parameter that sets the fourth input column

    outputParamName

    name of spark parameter that sets the first output column

    operationName

    unique name of the operation this stage performs

    sparkMlStageIn

    spark estimator to wrap

    uid

    stage uid

    tti1

    type tag for first input

    tti2

    type tag for second input

    tti3

    type tag for third input

    tti4

    type tag for fourth input

    tto

    type tag for output

    ttov

    type tag for output value

Type Members

  1. final type InputFeatures = (FeatureLike[I1], FeatureLike[I2], FeatureLike[I3], FeatureLike[I4])

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage4OpPipelineStageInputParams
  2. final type OutputFeatures = FeatureLike[O]

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def copy(extra: ParamMap): SwQuaternaryEstimator.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
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  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. 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 finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def fit(dataset: Dataset[_]): SwQuaternaryModel[I1, I2, I3, I4, O, M]

    Permalink
    Definition Classes
    SwQuaternaryEstimator → Estimator
  21. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SwQuaternaryModel[I1, I2, I3, I4, O, M]]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  22. def fit(dataset: Dataset[_], paramMap: ParamMap): SwQuaternaryModel[I1, I2, I3, I4, O, M]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SwQuaternaryModel[I1, I2, I3, I4, O, M]

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

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

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

    Permalink
    Definition Classes
    Params
  27. def getInputColParamNames(): Array[String]

    Permalink

    Gets names of parameters that control input columns for Spark stage

    Gets names of parameters that control input columns for Spark stage

    Definition Classes
    SparkWrapperParams
  28. 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

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

  30. final def getInputSchema(): StructType

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

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

    Permalink
    Definition Classes
    Params
  33. def getOutput(): FeatureLike[O]

    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
  34. def getOutputColParamNames(): Array[String]

    Permalink

    Gets names of parameters that control output columns for Spark stage

    Gets names of parameters that control output columns for Spark stage

    Definition Classes
    SparkWrapperParams
  35. 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
  36. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  37. def getSparkMlStage(): Option[E]

    Permalink

    Method to access the spark stage being wrapped

    Method to access the spark stage being wrapped

    returns

    Option of spark ml stage

    Definition Classes
    SparkWrapperParams
  38. def getStageSavePath(): Option[String]

    Permalink

    Gets a save path for wrapped spark stage

    Gets a save path for wrapped spark stage

    Definition Classes
    SparkWrapperParams
  39. 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
  40. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn3
  47. final def in4: TransientFeature

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn4
  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
    OpPipelineStage4InputParams
  51. val inputParam1Name: String

    Permalink

    name of spark parameter that sets the first input column

  52. val inputParam2Name: String

    Permalink

    name of spark parameter that sets the second input column

  53. val inputParam3Name: String

    Permalink

    name of spark parameter that sets the third input column

  54. val inputParam4Name: String

    Permalink

    name of spark parameter that sets the fourth input column

  55. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    InputParams
  76. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    SwQuaternaryEstimatorOpPipelineStageBase
  77. 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
  78. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage4OpPipelineStage
  79. 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
  80. val outputParamName: String

    Permalink

    name of spark parameter that sets the first output column

  81. lazy val params: Array[Param[_]]

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  88. final def setInput(features: InputFeatures): SwQuaternaryEstimator.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
  89. final def setInputFeatures[S <: OPFeature](features: Array[S]): SwQuaternaryEstimator.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
  90. final def setMetadata(m: Metadata): SwQuaternaryEstimator.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  91. def setOutputFeatureName(name: String): SwQuaternaryEstimator.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  92. def setSparkMlStage(stage: Option[E]): SwQuaternaryEstimator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    SparkWrapperParams
  93. def setStageSavePath(path: String): SwQuaternaryEstimator.this.type

    Permalink

    Sets a save path for wrapped spark stage

    Sets a save path for wrapped spark stage

    Definition Classes
    SparkWrapperParams
  94. final val sparkInputColParamNames: StringArrayParam

    Permalink
    Definition Classes
    SparkWrapperParams
  95. final val sparkMlStage: SparkStageParam[E]

    Permalink
    Definition Classes
    SparkWrapperParams
  96. final val sparkOutputColParamNames: StringArrayParam

    Permalink
    Definition Classes
    SparkWrapperParams
  97. 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
  98. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  100. 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
  101. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  102. implicit val tti1: scala.reflect.api.JavaUniverse.TypeTag[I1]

    Permalink

    type tag for first input

  103. implicit val tti2: scala.reflect.api.JavaUniverse.TypeTag[I2]

    Permalink

    type tag for second input

  104. implicit val tti3: scala.reflect.api.JavaUniverse.TypeTag[I3]

    Permalink

    type tag for third input

  105. implicit val tti4: scala.reflect.api.JavaUniverse.TypeTag[I4]

    Permalink

    type tag for fourth input

  106. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[O]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    SwQuaternaryEstimator → HasOut
  107. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[O.Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    SwQuaternaryEstimator → HasOut
  108. val uid: String

    Permalink

    stage uid

    stage uid

    Definition Classes
    SwQuaternaryEstimator → Identifiable
  109. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from SparkWrapperParams[E]

Inherited from OpPipelineStage4[I1, I2, I3, I4, O]

Inherited from HasOut[O]

Inherited from HasIn4

Inherited from HasIn3

Inherited from HasIn2

Inherited from HasIn1

Inherited from OpPipelineStage[O]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Estimator[SwQuaternaryModel[I1, I2, I3, I4, O, 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