Packages

c

org.tensorflow.metadata.v0

WeightedFeature

final class WeightedFeature extends GeneratedMessageV3 with WeightedFeatureOrBuilder

Represents a weighted feature that is encoded as a combination of raw base
features. The `weight_feature` should be a float feature with identical
shape as the `feature`. This is useful for representing weights associated
with categorical tokens (e.g. a TFIDF weight associated with each token).
TODO(b/142122960): Handle WeightedCategorical end to end in TFX (validation,
TFX Unit Testing, etc)

Protobuf type tensorflow.metadata.v0.WeightedFeature

Source
WeightedFeature.java
Linear Supertypes
WeightedFeatureOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WeightedFeature
  2. WeightedFeatureOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def equals(obj: AnyRef): Boolean
    Definition Classes
    WeightedFeature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  2. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  3. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  4. def getDefaultInstanceForType(): WeightedFeature
    Definition Classes
    WeightedFeature → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  5. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  6. def getFeature(): Path

    Path of a base feature to be weighted. Required.


    Path of a base feature to be weighted. Required.

    optional .tensorflow.metadata.v0.Path feature = 2;

    returns

    The feature.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  7. def getFeatureOrBuilder(): PathOrBuilder

    Path of a base feature to be weighted. Required.


    Path of a base feature to be weighted. Required.

    optional .tensorflow.metadata.v0.Path feature = 2;

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  8. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  9. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getLifecycleStage(): LifecycleStage

    The lifecycle_stage determines where a feature is expected to be used,
and therefore how important issues with it are.


    The lifecycle_stage determines where a feature is expected to be used,
and therefore how important issues with it are.

    optional .tensorflow.metadata.v0.LifecycleStage lifecycle_stage = 4;

    returns

    The lifecycleStage.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  11. def getName(): String

    Name for the weighted feature. This should not clash with other features in
the same schema.


    Name for the weighted feature. This should not clash with other features in
the same schema.

    optional string name = 1;

    returns

    The name.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  12. def getNameBytes(): ByteString

    Name for the weighted feature. This should not clash with other features in
the same schema.


    Name for the weighted feature. This should not clash with other features in
the same schema.

    optional string name = 1;

    returns

    The bytes for name.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  13. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  14. def getParserForType(): Parser[WeightedFeature]
    Definition Classes
    WeightedFeature → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  15. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  17. def getSerializedSize(): Int
    Definition Classes
    WeightedFeature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  18. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  19. def getWeightFeature(): Path

    Path of weight feature to associate with the base feature. Must be same
shape as feature. Required.


    Path of weight feature to associate with the base feature. Must be same
shape as feature. Required.

    optional .tensorflow.metadata.v0.Path weight_feature = 3;

    returns

    The weightFeature.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  20. def getWeightFeatureOrBuilder(): PathOrBuilder

    Path of weight feature to associate with the base feature. Must be same
shape as feature. Required.


    Path of weight feature to associate with the base feature. Must be same
shape as feature. Required.

    optional .tensorflow.metadata.v0.Path weight_feature = 3;

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  21. def hasFeature(): Boolean

    Path of a base feature to be weighted. Required.


    Path of a base feature to be weighted. Required.

    optional .tensorflow.metadata.v0.Path feature = 2;

    returns

    Whether the feature field is set.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  22. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  23. def hasLifecycleStage(): Boolean

    The lifecycle_stage determines where a feature is expected to be used,
and therefore how important issues with it are.


    The lifecycle_stage determines where a feature is expected to be used,
and therefore how important issues with it are.

    optional .tensorflow.metadata.v0.LifecycleStage lifecycle_stage = 4;

    returns

    Whether the lifecycleStage field is set.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  24. def hasName(): Boolean

    Name for the weighted feature. This should not clash with other features in
the same schema.


    Name for the weighted feature. This should not clash with other features in
the same schema.

    optional string name = 1;

    returns

    Whether the name field is set.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  25. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  26. def hasWeightFeature(): Boolean

    Path of weight feature to associate with the base feature. Must be same
shape as feature. Required.


    Path of weight feature to associate with the base feature. Must be same
shape as feature. Required.

    optional .tensorflow.metadata.v0.Path weight_feature = 3;

    returns

    Whether the weightFeature field is set.

    Definition Classes
    WeightedFeature → WeightedFeatureOrBuilder
    Annotations
    @Override()
  27. def hashCode(): Int
    Definition Classes
    WeightedFeature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  28. final def isInitialized(): Boolean
    Definition Classes
    WeightedFeature → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  29. def newBuilderForType(): Builder
    Definition Classes
    WeightedFeature → Message → MessageLite
    Annotations
    @Override()
  30. def toBuilder(): Builder
    Definition Classes
    WeightedFeature → Message → MessageLite
    Annotations
    @Override()
  31. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  32. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  33. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  34. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  35. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    WeightedFeature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  36. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])