Feature

Instance Constructors

new Feature(name: String, isResponse: Boolean, originStage: OpPipelineStage[O], parents: Seq[OPFeature])(implicit wtt: scala.reflect.api.JavaUniverse.WeakTypeTag[O])

Value Members

final def !=(arg0: Any): Boolean

Definition Classes

AnyRef → Any
final def ##(): Int

Definition Classes

AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes

AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes

Any
final def asRaw(isResponse: Boolean = isResponse): FeatureLike[O]

Construct a raw feature instance from this feature which can be applied on a Dataframe.

Construct a raw feature instance from this feature which can be applied on a Dataframe. Use this functionality when stacking workflows, e.g. when some features of a workflow are used as raw or input features of another workflow.

isResponse

should make response or a predictor feature

returns

new raw feature of the same type

Definition Classes

FeatureLike
def clone(): AnyRef

Attributes

protected[java.lang]

Definition Classes

AnyRef

Annotations

@throws( ... )
val distributions: Seq[FeatureDistributionLike]

distributions associated with raw feature from raw feature filter

distributions associated with raw feature from raw feature filter

Definition Classes

Feature → FeatureLike
final def eq(arg0: AnyRef): Boolean

Definition Classes

AnyRef
final def equals(in: Any): Boolean

Tests the equality of the FeatureLike objects

Tests the equality of the FeatureLike objects

Origin Stage is tested by uid

Parents are test by uid and order dependent. This is because they are used as inputs to the origin stage and input parameters may not be commutative

Definition Classes

FeatureLike → AnyRef → Any
def finalize(): Unit

Attributes

protected[java.lang]

Definition Classes

AnyRef

Annotations

@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes

AnyRef → Any
final def hashCode(): Int

Returns the hash code of this feature

Returns the hash code of this feature

returns

hash code

Definition Classes

FeatureLike → AnyRef → Any
final def history(): FeatureHistory

History of all stages and origin features used to create a given feature

History of all stages and origin features used to create a given feature

returns

FeatureHistory containing all feature history information

Definition Classes

FeatureLike
final def isInstanceOf[T0]: Boolean

Definition Classes

Any
final def isRaw: Boolean

Is this feature is raw or not (i.e.

Is this feature is raw or not (i.e. has no parent features)

returns

true if the feature is raw, false otherwise

Definition Classes

FeatureLike
val isResponse: Boolean

whether or not this feature is a response feature, ie dependent variable

whether or not this feature is a response feature, ie dependent variable

Definition Classes

Feature → FeatureLike
final def isSubtypeOf[T <: FeatureType](implicit arg0: scala.reflect.api.JavaUniverse.WeakTypeTag[T]): Boolean

Check whether this feature's type O is a subtype of the given feature type T

Check whether this feature's type O is a subtype of the given feature type T

T

the feature type to check

returns

true if O conforms to T, false otherwise

Definition Classes

FeatureLike
lazy val log: Logger

A handy logger instance

A handy logger instance

Attributes

protected

Definition Classes

FeatureLike
val metadata: Option[Metadata]

metadata to attach to feature in dataframe

metadata to attach to feature in dataframe

Definition Classes

Feature → FeatureLike
val name: String

name of feature, represents the name of the column in the dataframe.

name of feature, represents the name of the column in the dataframe.

Definition Classes

Feature → FeatureLike
final def ne(arg0: AnyRef): Boolean

Definition Classes

AnyRef
final def notify(): Unit

Definition Classes

AnyRef
final def notifyAll(): Unit

Definition Classes

AnyRef
val originStage: OpPipelineStage[O]

reference to OpPipelineStage responsible for generating the feature.

reference to OpPipelineStage responsible for generating the feature.

Definition Classes

Feature → FeatureLike
val parents: Seq[OPFeature]

references to the features that are transformed by the originStage that produces this feature

references to the features that are transformed by the originStage that produces this feature

Definition Classes

Feature → FeatureLike
final def prettyParentStages: String

Pretty print feature's parent stages tree

Pretty print feature's parent stages tree

returns

feature's parent stages tree with indentation

Definition Classes

FeatureLike
final def sameOrigin(in: Any): Boolean

Tests the equality of the FeatureLike objects

Tests the equality of the FeatureLike objects

Origin Stage is tested by uid

Parents are test by uid and order dependent. This is because they are used as inputs to the origin stage and input parameters may not be commutative

Definition Classes

FeatureLike
final def scoringDistributions: Seq[FeatureDistributionLike]

The distribution information of the feature computed during scoring (is a sequence because map features have distribution for each key)

The distribution information of the feature computed during scoring (is a sequence because map features have distribution for each key)

Definition Classes

FeatureLike
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes

AnyRef
final def toJson(pretty: Boolean = true): String

Convert this feature to json string

Convert this feature to json string

pretty

should pretty print

returns

json string for feature

Definition Classes

FeatureLike
final def toString(): String

Definition Classes

FeatureLike → AnyRef → Any
final def trainingDistributions: Seq[FeatureDistributionLike]

The distribution information of the feature computed during training (is a sequence because map features have distribution for each key)

The distribution information of the feature computed during training (is a sequence because map features have distribution for each key)

Definition Classes

FeatureLike
final def transformWith[U <: FeatureType](stage: OpPipelineStageN[O, U], fs: Array[FeatureLike[O]]): FeatureLike[U]

Transform the feature with a given transformation stage and input features

Transform the feature with a given transformation stage and input features

U

output type

stage

transformer/estimator

fs

other features

returns

transformed feature

Definition Classes

FeatureLike
final def transformWith[I1 <: FeatureType, I2 <: FeatureType, I3 <: FeatureType, U <: FeatureType](stage: OpPipelineStage4[O, I1, I2, I3, U], f1: FeatureLike[I1], f2: FeatureLike[I2], f3: FeatureLike[I3]): FeatureLike[U]

Transform the feature with a given transformation stage and input features

Transform the feature with a given transformation stage and input features

I1

f1 input type

I2

f2 input type

I3

f3 input type

U

output type

stage

transformer/estimator

f1

other feature1

f2

other feature2

f3

other feature2

returns

transformed feature

Definition Classes

FeatureLike
final def transformWith[I1 <: FeatureType, I2 <: FeatureType, U <: FeatureType](stage: OpPipelineStage3[O, I1, I2, U], f1: FeatureLike[I1], f2: FeatureLike[I2]): FeatureLike[U]

Transform the feature with a given transformation stage and input features

Transform the feature with a given transformation stage and input features

I1

f1 input type

I2

f2 input type

U

output type

stage

transformer/estimator

f1

other feature1

f2

other feature2

returns

transformed feature

Definition Classes

FeatureLike
final def transformWith[I <: FeatureType, U <: FeatureType](stage: OpPipelineStage2[O, I, U], f: FeatureLike[I]): FeatureLike[U]

Transform the feature with a given transformation stage and input features

Transform the feature with a given transformation stage and input features

I

other feature input type

U

output type

stage

transformer/estimator

f

other feature

returns

transformed feature

Definition Classes

FeatureLike
final def transformWith[U <: FeatureType](stage: OpPipelineStage1[O, U]): FeatureLike[U]

Transform the feature with a given transformation stage and an input feature

Transform the feature with a given transformation stage and an input feature

U

output type

stage

transformer/estimator

returns

transformed feature

Definition Classes

FeatureLike
final def typeName: String

Feature type name

Feature type name

returns

feature type name

Definition Classes

FeatureLike
val uid: String

unique identifier of the feature instance

unique identifier of the feature instance

Definition Classes

Feature → FeatureLike
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( ... )
def withMetadata(metadataIn: Metadata): FeatureLike[O]

Adds metadata to feature so can override metadata on created feature

Adds metadata to feature so can override metadata on created feature

metadataIn

dataframe metadata to include in the output column

returns

A feature with the metadata associated

Definition Classes

Feature → FeatureLike
implicit val wtt: scala.reflect.api.JavaUniverse.WeakTypeTag[O]

feature's value type tag

feature's value type tag

Definition Classes

Feature → FeatureLike

Related Doc: package features

case class Feature[O <: FeatureType] extends FeatureLike[O] with Product with Serializable

Instance Constructors

new Feature(name: String, isResponse: Boolean, originStage: OpPipelineStage[O], parents: Seq[OPFeature])(implicit wtt: scala.reflect.api.JavaUniverse.WeakTypeTag[O])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def asRaw(isResponse: Boolean = isResponse): FeatureLike[O]

def clone(): AnyRef

val distributions: Seq[FeatureDistributionLike]

final def eq(arg0: AnyRef): Boolean

final def equals(in: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def hashCode(): Int

final def history(): FeatureHistory

final def isInstanceOf[T0]: Boolean

final def isRaw: Boolean

val isResponse: Boolean

final def isSubtypeOf[T <: FeatureType](implicit arg0: scala.reflect.api.JavaUniverse.WeakTypeTag[T]): Boolean

lazy val log: Logger

val metadata: Option[Metadata]

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val originStage: OpPipelineStage[O]

val parents: Seq[OPFeature]

final def prettyParentStages: String

final def sameOrigin(in: Any): Boolean

final def scoringDistributions: Seq[FeatureDistributionLike]

final def synchronized[T0](arg0: ⇒ T0): T0

final def toJson(pretty: Boolean = true): String

final def toString(): String

final def trainingDistributions: Seq[FeatureDistributionLike]

final def transformWith[U <: FeatureType](stage: OpPipelineStageN[O, U], fs: Array[FeatureLike[O]]): FeatureLike[U]

final def transformWith[I1 <: FeatureType, I2 <: FeatureType, I3 <: FeatureType, U <: FeatureType](stage: OpPipelineStage4[O, I1, I2, I3, U], f1: FeatureLike[I1], f2: FeatureLike[I2], f3: FeatureLike[I3]): FeatureLike[U]

final def transformWith[I1 <: FeatureType, I2 <: FeatureType, U <: FeatureType](stage: OpPipelineStage3[O, I1, I2, U], f1: FeatureLike[I1], f2: FeatureLike[I2]): FeatureLike[U]

final def transformWith[I <: FeatureType, U <: FeatureType](stage: OpPipelineStage2[O, I, U], f: FeatureLike[I]): FeatureLike[U]

final def transformWith[U <: FeatureType](stage: OpPipelineStage1[O, U]): FeatureLike[U]

final def typeName: String

val uid: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withMetadata(metadataIn: Metadata): FeatureLike[O]

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FeatureLike[O]

Inherited from AnyRef

Inherited from Any

Ungrouped