Class

com.salesforce.op.features

Feature

Related Doc: package features

Permalink

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

Feature instance

Note: can only be created using FeatureBuilder.

O

feature value type

Linear Supertypes
Serializable, Serializable, Product, Equals, FeatureLike[O], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Feature
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. FeatureLike
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

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 ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. final def asRaw(isResponse: Boolean = isResponse): FeatureLike[O]

    Permalink

    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
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val distributions: Seq[FeatureDistributionLike]

    Permalink

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

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

    Definition Classes
    FeatureFeatureLike
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. final def equals(in: Any): Boolean

    Permalink

    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
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def hashCode(): Int

    Permalink

    Returns the hash code of this feature

    Returns the hash code of this feature

    returns

    hash code

    Definition Classes
    FeatureLike → AnyRef → Any
  13. final def history(): FeatureHistory

    Permalink

    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
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def isRaw: Boolean

    Permalink

    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
  16. val isResponse: Boolean

    Permalink

    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
    FeatureFeatureLike
  17. final def isSubtypeOf[T <: FeatureType](implicit arg0: scala.reflect.api.JavaUniverse.WeakTypeTag[T]): Boolean

    Permalink

    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
  18. lazy val log: Logger

    Permalink

    A handy logger instance

    A handy logger instance

    Attributes
    protected
    Definition Classes
    FeatureLike
  19. val name: String

    Permalink

    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
    FeatureFeatureLike
  20. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  23. val originStage: OpPipelineStage[O]

    Permalink

    reference to OpPipelineStage responsible for generating the feature.

    reference to OpPipelineStage responsible for generating the feature.

    Definition Classes
    FeatureFeatureLike
  24. val parents: Seq[OPFeature]

    Permalink

    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
    FeatureFeatureLike
  25. final def prettyParentStages: String

    Permalink

    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
  26. final def sameOrigin(in: Any): Boolean

    Permalink

    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
  27. final def scoringDistributions: Seq[FeatureDistributionLike]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  29. final def toJson(pretty: Boolean = true): String

    Permalink

    Convert this feature to json string

    Convert this feature to json string

    pretty

    should pretty print

    returns

    json string for feature

    Definition Classes
    FeatureLike
  30. final def toString(): String

    Permalink
    Definition Classes
    FeatureLike → AnyRef → Any
  31. final def trainingDistributions: Seq[FeatureDistributionLike]

    Permalink

    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
  32. final def transformWith[U <: FeatureType](stage: OpPipelineStageN[O, U], fs: Array[FeatureLike[O]]): FeatureLike[U]

    Permalink

    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
  33. 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]

    Permalink

    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
  34. final def transformWith[I1 <: FeatureType, I2 <: FeatureType, U <: FeatureType](stage: OpPipelineStage3[O, I1, I2, U], f1: FeatureLike[I1], f2: FeatureLike[I2]): FeatureLike[U]

    Permalink

    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
  35. final def transformWith[I <: FeatureType, U <: FeatureType](stage: OpPipelineStage2[O, I, U], f: FeatureLike[I]): FeatureLike[U]

    Permalink

    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
  36. final def transformWith[U <: FeatureType](stage: OpPipelineStage1[O, U]): FeatureLike[U]

    Permalink

    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
  37. final def typeName: String

    Permalink

    Feature type name

    Feature type name

    returns

    feature type name

    Definition Classes
    FeatureLike
  38. val uid: String

    Permalink

    unique identifier of the feature instance

    unique identifier of the feature instance

    Definition Classes
    FeatureFeatureLike
  39. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. implicit val wtt: scala.reflect.api.JavaUniverse.WeakTypeTag[O]

    Permalink

    feature's value type tag

    feature's value type tag

    Definition Classes
    FeatureFeatureLike

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FeatureLike[O]

Inherited from AnyRef

Inherited from Any

Ungrouped