Class

com.salesforce.op.stages

FeatureGeneratorStage

Related Doc: package stages

Permalink

final class FeatureGeneratorStage[I, O <: FeatureType] extends PipelineStage with OpPipelineStage[O] with HasIn1

Origin stage for first features in workflow

I

input data type

O

output feature type

Linear Supertypes
HasIn1, OpPipelineStage[O], OpPipelineStageBase, MLWritable, OpPipelineStageParams, InputParams, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FeatureGeneratorStage
  2. HasIn1
  3. OpPipelineStage
  4. OpPipelineStageBase
  5. MLWritable
  6. OpPipelineStageParams
  7. InputParams
  8. PipelineStage
  9. Logging
  10. Params
  11. Serializable
  12. Serializable
  13. Identifiable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FeatureGeneratorStage(extractFn: (I) ⇒ O, extractSource: String, aggregator: MonoidAggregator[Event[O], _, O], outputName: String, outputIsResponse: Boolean, aggregateWindow: Option[Duration] = None, uid: String = UID[FeatureGeneratorStage[I, O]])(implicit tti: scala.reflect.api.JavaUniverse.WeakTypeTag[I], tto: scala.reflect.api.JavaUniverse.WeakTypeTag[O])

    Permalink

    extractFn

    function to get data from raw input type

    extractSource

    source code of the extract function

    aggregator

    type of aggregation to do on feature after extraction

    outputName

    name of feature to be returned

    outputIsResponse

    boolean value of whether response is predictor or response (used to determine aggregation window)

    aggregateWindow

    time period during which to include features in aggregation

    uid

    unique id for stage

    tti

    weak type tag for input feature type

    tto

    weak type tag for output feature type

Type Members

  1. type InputFeatures = FeatureLike[_ <: FeatureType]

    Permalink

    Input Features type

    Input Features type

    Definition Classes
    FeatureGeneratorStageOpPipelineStageInputParams
  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. val aggregateWindow: Option[Duration]

    Permalink

    time period during which to include features in aggregation

  6. val aggregator: MonoidAggregator[Event[O], _, O]

    Permalink

    type of aggregation to do on feature after extraction

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. 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
    FeatureGeneratorStageInputParams
  9. def checkSerializable: Try[Unit]

    Permalink

    Check if the stage is serializable

    Check if the stage is serializable

    returns

    Failure if not serializable

    Definition Classes
    FeatureGeneratorStageOpPipelineStageBase
  10. final def clear(param: Param[_]): FeatureGeneratorStage.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def explainParam(param: Param[_]): String

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

    Permalink
    Definition Classes
    Params
  19. val extractFn: (I) ⇒ O

    Permalink

    function to get data from raw input type

  20. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  22. val extractSource: String

    Permalink

    source code of the extract function

  23. val featureAggregator: FeatureAggregator[I, O, _, O]

    Permalink
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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

    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
    FeatureGeneratorStageOpPipelineStageBase
  34. 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
  35. def getParam(paramName: String): Param[Any]

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

    Permalink

    Gets the input Features

    Gets the input Features

    returns

    input features

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasIn1
  42. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. 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
    FeatureGeneratorStageInputParams
  45. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Function to be called on getMetadata

    Function to be called on getMetadata

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

    Permalink

    Function to be called on setInput

    Function to be called on setInput

    Attributes
    protected
    Definition Classes
    OpPipelineStageBase
  66. 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
    FeatureGeneratorStageOpPipelineStageBase
  67. 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
  68. def outputFeatureUid: String

    Permalink
    Attributes
    protected[com.salesforce.op]
    Definition Classes
    FeatureGeneratorStageOpPipelineStage
  69. val outputIsResponse: Boolean

    Permalink

    boolean value of whether response is predictor or response (used to determine aggregation window)

    boolean value of whether response is predictor or response (used to determine aggregation window)

    Definition Classes
    FeatureGeneratorStageOpPipelineStage
  70. lazy val params: Array[Param[_]]

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageParams
  80. def setOutputFeatureName(name: String): FeatureGeneratorStage.this.type

    Permalink
    Definition Classes
    OpPipelineStage
  81. 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
  82. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

    Permalink

    weak type tag for input feature type

  87. implicit val tto: scala.reflect.api.JavaUniverse.WeakTypeTag[O]

    Permalink

    weak type tag for output feature type

  88. val uid: String

    Permalink

    unique id for stage

    unique id for stage

    Definition Classes
    FeatureGeneratorStage → Identifiable
  89. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    OpPipelineStageBase → MLWritable

Inherited from HasIn1

Inherited from OpPipelineStage[O]

Inherited from OpPipelineStageBase

Inherited from MLWritable

Inherited from OpPipelineStageParams

Inherited from InputParams

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