Class

com.salesforce.op.stages.sparkwrappers.specific

OpPredictorWrapper

Related Doc: package specific

Permalink

class OpPredictorWrapper[E <: Predictor[Vector, E, M], M <: PredictionModel[Vector, M]] extends Estimator[OpPredictorWrapperModel[M]] with OpPipelineStage2[RealNN, OPVector, Prediction] with SparkWrapperParams[E]

Wraps a spark ML predictor. Predictors represent supervised learning algorithms (regression and classification) in spark ML that inherit from Predictor, supported models are: org.apache.spark.ml.classification.LogisticRegression org.apache.spark.ml.regression.LinearRegression, org.apache.spark.ml.classification.RandomForestClassifier, org.apache.spark.ml.regression.RandomForestRegressor, org.apache.spark.ml.classification.NaiveBayesModel, org.apache.spark.ml.classification.GBTClassifier, org.apache.spark.ml.regression.GBTRegressor, org.apache.spark.ml.classification.DecisionTreeClassifier org.apache.spark.ml.regression.DecisionTreeRegressor, org.apache.spark.ml.classification.LinearSVC org.apache.spark.ml.classification.MultilayerPerceptronClassifier, org.apache.spark.ml.regression.GeneralizedLinearRegression. Their defining characteristic is that they output a model which takes in 2 columns as input (labels and features) and output one to three column as result.

E

spark estimator to wrap

M

spark model returned

Linear Supertypes
SparkWrapperParams[E], OpPipelineStage2[RealNN, OPVector, Prediction], HasOut[Prediction], HasIn2, HasIn1, OpPipelineStage[Prediction], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[OpPredictorWrapperModel[M]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpPredictorWrapper
  2. SparkWrapperParams
  3. OpPipelineStage2
  4. HasOut
  5. HasIn2
  6. HasIn1
  7. OpPipelineStage
  8. OpPipelineStageBase
  9. MLWritable
  10. OpPipelineStageParams
  11. InputParams
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpPredictorWrapper(predictor: E, uid: String = UID[OpPredictorWrapper[_, _]])(implicit tti1: scala.reflect.api.JavaUniverse.TypeTag[RealNN], tti2: scala.reflect.api.JavaUniverse.TypeTag[OPVector], tto: scala.reflect.api.JavaUniverse.TypeTag[Prediction], ttov: scala.reflect.api.JavaUniverse.TypeTag[Map[String, Double]])

    Permalink

    predictor

    the predictor to wrap

    uid

    stage uid

Type Members

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

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage2OpPipelineStageInputParams
  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
    OpPipelineStage2InputParams
  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[_]): OpPredictorWrapper.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): OpPredictorWrapper.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[_]): OpPredictorWrapperModel[M]

    Permalink

    Function that fits the binary model

    Function that fits the binary model

    Definition Classes
    OpPredictorWrapper → Estimator
  21. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[OpPredictorWrapperModel[M]]

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): OpPredictorWrapperModel[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[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
  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. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. 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
    OpPipelineStage2InputParams
  49. val inputParam1Name: String

    Permalink
  50. val inputParam2Name: String

    Permalink
  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 log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    InputParams
  72. val operationName: String

    Permalink

    Short unique name of the operation this stage performs

    Short unique name of the operation this stage performs

    returns

    operation name

    Definition Classes
    OpPredictorWrapperOpPipelineStageBase
  73. 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
  74. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage2OpPipelineStage
  75. 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
  76. val outputParamName: String

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

    Permalink
    Definition Classes
    Params
  78. val predictor: E

    Permalink

    the predictor to wrap

  79. def save(path: String): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageParams
  88. def setOutputFeatureName(name: String): OpPredictorWrapper.this.type

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

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

    Permalink

    Sets a save path for wrapped spark stage

    Sets a save path for wrapped spark stage

    Definition Classes
    SparkWrapperParams
  91. final val sparkInputColParamNames: StringArrayParam

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

    Permalink
    Definition Classes
    SparkWrapperParams
  93. final val sparkOutputColParamNames: StringArrayParam

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

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

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

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

    Permalink
  100. implicit val tti2: scala.reflect.api.JavaUniverse.TypeTag[OPVector]

    Permalink
  101. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[Prediction]

    Permalink

    Type tag of the output

    Type tag of the output

    Definition Classes
    OpPredictorWrapper → HasOut
  102. 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
    OpPredictorWrapper → HasOut
  103. val uid: String

    Permalink

    stage uid

    stage uid

    Definition Classes
    OpPredictorWrapper → Identifiable
  104. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from SparkWrapperParams[E]

Inherited from HasOut[Prediction]

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[OpPredictorWrapperModel[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