Trait

com.salesforce.op.stages

OpPipelineStage1to3

Related Doc: package stages

Permalink

trait OpPipelineStage1to3[I <: FeatureType, O1 <: FeatureType, O2 <: FeatureType, O3 <: FeatureType] extends OpPipelineStageBase with HasIn1

Pipeline stage of Feature type I to Features O1, O2 and O3

I

input feature type

O1

first output feature type

O2

second output feature type

O3

third output feature type

Self Type
OpPipelineStage1to3[I, O1, O2, O3] with PipelineStage
Linear Supertypes
HasIn1, OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpPipelineStage1to3
  2. HasIn1
  3. OpPipelineStageBase
  4. MLWritable
  5. OpPipelineStageParams
  6. InputParams
  7. Params
  8. Serializable
  9. Serializable
  10. Identifiable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final type InputFeatures = FeatureLike[I]

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    OpPipelineStage1to3InputParams
  2. final type OutputFeatures = (FeatureLike[O1], FeatureLike[O2], FeatureLike[O3])

    Permalink

Abstract Value Members

  1. abstract def getOutput(): (OpPipelineStage1to3.this)#OutputFeatures

    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
    OpPipelineStageBase
  2. abstract def stage1OperationName: String

    Permalink
  3. abstract def stage2OperationName: String

    Permalink
  4. abstract def stage3OperationName: String

    Permalink
  5. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

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 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
    OpPipelineStage1to3InputParams
  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[_]): OpPipelineStage1to3.this

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def copy(extra: ParamMap): OpPipelineStage1to3.this

    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. final def get[T](param: Param[T]): Option[T]

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

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

    Permalink
    Definition Classes
    Params
  23. 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

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

  25. final def getInputSchema(): StructType

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

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

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

    Permalink
    Definition Classes
    Params
  29. 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
  30. final def getTransientFeatures(): Array[TransientFeature]

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  35. final def inputAsArray(in: (OpPipelineStage1to3.this)#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
    OpPipelineStage1to3InputParams
  36. final def isDefined(param: Param[_]): Boolean

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

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

    Permalink
    Definition Classes
    Params
  39. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  44. def 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
    OpPipelineStage1to3OpPipelineStageBase
  45. final def outputAsArray(out: (OpPipelineStage1to3.this)#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
    OpPipelineStage1to3OpPipelineStageBase
  46. lazy val params: Array[Param[_]]

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  49. final def set(param: String, value: Any): OpPipelineStage1to3.this

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

    Permalink
    Definition Classes
    Params
  51. final def setDefault(paramPairs: ParamPair[_]*): OpPipelineStage1to3.this

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  53. final def setInput(features: (OpPipelineStage1to3.this)#InputFeatures): OpPipelineStage1to3.this

    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
  54. final def setInputFeatures[S <: OPFeature](features: Array[S]): OpPipelineStage1to3.this

    Permalink

    Sets input features

    Sets input features

    S

    feature like type

    features

    array of input features

    returns

    this stage

    Attributes
    protected
    Definition Classes
    InputParams
  55. final def setMetadata(m: Metadata): OpPipelineStage1to3.this

    Permalink
    Definition Classes
    OpPipelineStageParams
  56. 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
  57. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  59. 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
  60. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from HasIn1

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped