FeatureGeneratorStage

Instance Constructors

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]], inputType: Either[scala.reflect.api.JavaUniverse.WeakTypeTag[I], String])(implicit tto: scala.reflect.api.JavaUniverse.WeakTypeTag[O])

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
inputType
input weak type tag or type name
tto
weak type tag for output feature type

Type Members

type InputFeatures = FeatureLike[_ <: FeatureType]

Input Features type
Input Features type

Definition Classes
FeatureGeneratorStage → OpPipelineStage → InputParams
final type OutputFeatures = FeatureLike[O]

Definition Classes
OpPipelineStage → OpPipelineStageBase

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val aggregateWindow: Option[Duration]

time period during which to include features in aggregation
val aggregator: MonoidAggregator[Event[O], _, O]

type of aggregation to do on feature after extraction
final def asInstanceOf[T0]: T0

Definition Classes
Any
def checkInputLength(features: Array[_]): Boolean

Checks the input length
Checks the input length
features
input features
returns
true is input size as expected, false otherwise

Definition Classes
FeatureGeneratorStage → InputParams
def checkSerializable: Try[Unit]

Check if the stage is serializable
Check if the stage is serializable
returns
Failure if not serializable

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

Definition Classes
Params
def clone(): AnyRef

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

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
def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

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

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
val extractFn: (I) ⇒ O

function to get data from raw input type
final def extractParamMap(): ParamMap

Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap

Definition Classes
Params
val extractSource: String

source code of the extract function
val featureAggregator: FeatureAggregator[I, O, _, O]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[T](param: Param[T]): Option[T]

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

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

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

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
final def getInputFeatures(): Array[OPFeature]

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
final def getInputSchema(): StructType

Definition Classes
OpPipelineStageParams
final def getMetadata(): Metadata

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

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

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
FeatureGeneratorStage → OpPipelineStageBase
final def getOutputFeatureName: String

Name of output feature (i.e.
Name of output feature (i.e. column created by this stage)

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

Definition Classes
Params
final def getTransientFeature(i: Int): Option[TransientFeature]

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
final def getTransientFeatures(): Array[TransientFeature]

Gets the input Features
Gets the input Features
returns
input features

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

Definition Classes
Params
def hasParam(paramName: String): Boolean

Definition Classes
Params
def hashCode(): Int

Definition Classes
AnyRef → Any
final def in1: TransientFeature

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

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

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

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
FeatureGeneratorStage → InputParams
val inputType: Either[scala.reflect.api.JavaUniverse.WeakTypeTag[I], String]

input weak type tag or type name
final def isDefined(param: Param[_]): Boolean

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Params
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def log: Logger

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

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

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

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

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

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

Attributes
protected
Definition Classes
Logging
def logName: String

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

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

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

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onGetMetadata(): Unit

Function to be called on getMetadata
Function to be called on getMetadata

Attributes
protected
Definition Classes
OpPipelineStageParams
def onSetInput(): Unit

Function to be called on setInput
Function to be called on setInput

Attributes
protected
Definition Classes
InputParams
def operationName: String

Short unique name of the operation this stage performs
Short unique name of the operation this stage performs
returns
operation name

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

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
OpPipelineStage → OpPipelineStageBase
def outputFeatureUid: String

Attributes
protected[com.salesforce.op]
Definition Classes
FeatureGeneratorStage → OpPipelineStage
val outputIsResponse: Boolean

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
FeatureGeneratorStage → OpPipelineStage
val outputName: String

name of feature to be returned
lazy val params: Array[Param[_]]

Definition Classes
Params
def save(path: String): Unit

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

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

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

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

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

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

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

Sets input features
Sets input features
S
feature like type
features
array of input features
returns
this stage

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

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

Definition Classes
OpPipelineStage
final def stageName: String

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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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
def transformSchema(schema: StructType, logging: Boolean): StructType

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

weak type tag for output feature type
val uid: String

unique id for stage
unique id for stage

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

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

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

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

Definition Classes
OpPipelineStageBase → MLWritable

Related Doc: package stages

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

Instance Constructors

Type Members

type InputFeatures = FeatureLike[_ <: FeatureType]

final type OutputFeatures = FeatureLike[O]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def $[T](param: Param[T]): T

final def ==(arg0: Any): Boolean

val aggregateWindow: Option[Duration]

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

final def asInstanceOf[T0]: T0

def checkInputLength(features: Array[_]): Boolean

def checkSerializable: Try[Unit]

final def clear(param: Param[_]): FeatureGeneratorStage.this.type

def clone(): AnyRef

final def copy(extra: ParamMap): FeatureGeneratorStage.this.type

def copyValues[T <: Params](to: T, extra: ParamMap): T

final def defaultCopy[T <: Params](extra: ParamMap): T

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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

def explainParams(): String

val extractFn: (I) ⇒ O

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

val extractSource: String

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

def finalize(): Unit

final def get[T](param: Param[T]): Option[T]

final def getClass(): Class[_]

final def getDefault[T](param: Param[T]): Option[T]

final def getInputFeature[T <: FeatureType](i: Int): Option[FeatureLike[T]]

final def getInputFeatures(): Array[OPFeature]

final def getInputSchema(): StructType

final def getMetadata(): Metadata

final def getOrDefault[T](param: Param[T]): T

def getOutput(): FeatureLike[O]

final def getOutputFeatureName: String

def getParam(paramName: String): Param[Any]

final def getTransientFeature(i: Int): Option[TransientFeature]

final def getTransientFeatures(): Array[TransientFeature]

final def hasDefault[T](param: Param[T]): Boolean

def hasParam(paramName: String): Boolean

def hashCode(): Int

final def in1: TransientFeature

def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

def inputAsArray(in: InputFeatures): Array[OPFeature]

val inputType: Either[scala.reflect.api.JavaUniverse.WeakTypeTag[I], String]

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

final def isInstanceOf[T0]: Boolean

final def isSet(param: Param[_]): Boolean

def isTraceEnabled(): Boolean

def log: Logger

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

def logDebug(msg: ⇒ String): Unit

def logError(msg: ⇒ String, throwable: Throwable): Unit

def logError(msg: ⇒ String): Unit

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

def logInfo(msg: ⇒ String): Unit

def logName: String

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

def logTrace(msg: ⇒ String): Unit

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

def logWarning(msg: ⇒ String): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onGetMetadata(): Unit

def onSetInput(): Unit

def operationName: String

final def outputAsArray(out: OutputFeatures): Array[OPFeature]

def outputFeatureUid: String

val outputIsResponse: Boolean

val outputName: String

lazy val params: Array[Param[_]]