Class

com.salesforce.op.stages.sparkwrappers.specific

OpEstimatorWrapper

Related Doc: package specific

Permalink

class OpEstimatorWrapper[I <: FeatureType, O <: FeatureType, E <: Estimator[M], M <: Model[M]] extends SwUnaryEstimator[I, O, M, E]

Wraps a spark ML estimator. This wrapper is meant for Estimators not already covered by more specific wrappers such as: OpPredictorWrapper. Examples of estimators meant to be wrapped with OpEstimatorWrapper include MinMaxScaler, IDF, VectorIndexer, CountVectorizer, QuantileDiscretizer, StandardScaler, PCA, MaxAbsScaler, Word2Vec, etc. Their defining characteristic is that they output a Model which takes in one column as input and output one column as a result.

I

the type of the transformation input feature

O

the type of the transformation output feature

E

spark estimator to wrap

M

spark model type returned by spark estimator wrapped

Linear Supertypes
SwUnaryEstimator[I, O, M, E], SparkWrapperParams[E], OpPipelineStage1[I, O], HasIn1, OpPipelineStage[O], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Estimator[SwUnaryModel[I, O, M]], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpEstimatorWrapper
  2. SwUnaryEstimator
  3. SparkWrapperParams
  4. OpPipelineStage1
  5. HasIn1
  6. OpPipelineStage
  7. OpPipelineStageBase
  8. MLWritable
  9. OpPipelineStageParams
  10. InputParams
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpEstimatorWrapper(estimator: E, uid: String = UID[OpEstimatorWrapper[I, O, E, M]])(implicit tti: scala.reflect.api.JavaUniverse.TypeTag[I], tto: scala.reflect.api.JavaUniverse.TypeTag[O], ttov: scala.reflect.api.JavaUniverse.TypeTag[O.Value])

    Permalink

    estimator

    the estimator to wrap

    uid

    stage uid

Type Members

  1. final type InputFeatures = FeatureLike[I]

    Permalink
    Definition Classes
    OpPipelineStage1 → OpPipelineStage → InputParams
  2. final type OutputFeatures = FeatureLike[O]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase

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
    Definition Classes
    OpPipelineStage1 → InputParams
  7. def checkSerializable: Try[Unit]

    Permalink
    Definition Classes
    OpPipelineStageBase
  8. final def clear(param: Param[_]): OpEstimatorWrapper.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): OpEstimatorWrapper.this.type

    Permalink
    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. val estimator: E

    Permalink

    the estimator to wrap

  16. def explainParam(param: Param[_]): String

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def fit(dataset: Dataset[_]): SwUnaryModel[I, O, M]

    Permalink
    Definition Classes
    SwUnaryEstimator → Estimator
  22. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SwUnaryModel[I, O, M]]

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SwUnaryModel[I, O, M]

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

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

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

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

    Permalink
    Definition Classes
    InputParams
  29. final def getInputFeatures(): Array[OPFeature]

    Permalink
    Definition Classes
    InputParams
  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
    Definition Classes
    OpPipelineStage1 → OpPipelineStageBase
  34. final def getOutputFeatureName: String

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  44. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. final def inputAsArray(in: InputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStage1 → InputParams
  46. val inputParamName: String

    Permalink

    name of spark parameter that sets the second input column

    name of spark parameter that sets the second input column

    Definition Classes
    SwUnaryEstimator
  47. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  68. val operationName: String

    Permalink

    unique name of the operation this stage performs

    unique name of the operation this stage performs

    Definition Classes
    SwUnaryEstimator → OpPipelineStageBase
  69. final def outputAsArray(out: OutputFeatures): Array[OPFeature]

    Permalink
    Definition Classes
    OpPipelineStage → OpPipelineStageBase
  70. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    OpPipelineStage1 → OpPipelineStage
  71. def outputIsResponse: Boolean

    Permalink
    Definition Classes
    OpPipelineStage
  72. val outputParamName: String

    Permalink

    name of spark parameter that sets the first output column

    name of spark parameter that sets the first output column

    Definition Classes
    SwUnaryEstimator
  73. lazy val params: Array[Param[_]]

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase
  81. final def setInputFeatures[S <: OPFeature](features: Array[S]): OpEstimatorWrapper.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    InputParams
  82. final def setMetadata(m: Metadata): OpEstimatorWrapper.this.type

    Permalink
    Definition Classes
    OpPipelineStageParams
  83. def setOutputFeatureName(name: String): OpEstimatorWrapper.this.type

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

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

    Permalink
    Definition Classes
    SparkWrapperParams
  86. final val sparkInputColParamNames: StringArrayParam

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

    Permalink
    Definition Classes
    SparkWrapperParams
  88. final val sparkOutputColParamNames: StringArrayParam

    Permalink
    Definition Classes
    SparkWrapperParams
  89. final def stageName: String

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  94. implicit val tti: scala.reflect.api.JavaUniverse.TypeTag[I]

    Permalink

    type tag for input

    type tag for input

    Definition Classes
    SwUnaryEstimator
  95. implicit val tto: scala.reflect.api.JavaUniverse.TypeTag[O]

    Permalink

    type tag for output

    type tag for output

    Definition Classes
    SwUnaryEstimator → OpPipelineStage1
  96. implicit val ttov: scala.reflect.api.JavaUniverse.TypeTag[O.Value]

    Permalink

    type tag for output value

    type tag for output value

    Definition Classes
    SwUnaryEstimator → OpPipelineStage1
  97. val uid: String

    Permalink

    stage uid

    stage uid

    Definition Classes
    SwUnaryEstimator → 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 SwUnaryEstimator[I, O, M, E]

Inherited from SparkWrapperParams[E]

Inherited from OpPipelineStage1[I, O]

Inherited from HasIn1

Inherited from OpPipelineStage[O]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Estimator[SwUnaryModel[I, 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