Packages

final class SparseFeature extends GeneratedMessageV3 with SparseFeatureOrBuilder

A sparse feature represents a sparse tensor that is encoded with a
combination of raw features, namely index features and a value feature. Each
index feature defines a list of indices in a different dimension.

Protobuf type tensorflow.metadata.v0.SparseFeature

Source
SparseFeature.java
Linear Supertypes
SparseFeatureOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparseFeature
  2. SparseFeatureOrBuilder
  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
    SparseFeature → 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(): SparseFeature
    Definition Classes
    SparseFeature → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  5. def getDenseShape(): FixedShape

    Shape of the sparse tensor that this SparseFeature represents.
Currently not supported.
TODO(b/109669962): Consider deriving this from the referred features.


    Shape of the sparse tensor that this SparseFeature represents.
Currently not supported.
TODO(b/109669962): Consider deriving this from the referred features.

    optional .tensorflow.metadata.v0.FixedShape dense_shape = 5;

    returns

    The denseShape.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  6. def getDenseShapeOrBuilder(): FixedShapeOrBuilder

    Shape of the sparse tensor that this SparseFeature represents.
Currently not supported.
TODO(b/109669962): Consider deriving this from the referred features.


    Shape of the sparse tensor that this SparseFeature represents.
Currently not supported.
TODO(b/109669962): Consider deriving this from the referred features.

    optional .tensorflow.metadata.v0.FixedShape dense_shape = 5;

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  7. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  8. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  9. def getIndexFeature(index: Int): IndexFeature

    Features that represent indexes. Should be integers >= 0.


    Features that represent indexes. Should be integers >= 0.

    repeated .tensorflow.metadata.v0.SparseFeature.IndexFeature index_feature = 6;

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  10. def getIndexFeatureCount(): Int

    Features that represent indexes. Should be integers >= 0.


    Features that represent indexes. Should be integers >= 0.

    repeated .tensorflow.metadata.v0.SparseFeature.IndexFeature index_feature = 6;

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  11. def getIndexFeatureList(): List[IndexFeature]

    Features that represent indexes. Should be integers >= 0.


    Features that represent indexes. Should be integers >= 0.

    repeated .tensorflow.metadata.v0.SparseFeature.IndexFeature index_feature = 6;

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  12. def getIndexFeatureOrBuilder(index: Int): IndexFeatureOrBuilder

    Features that represent indexes. Should be integers >= 0.


    Features that represent indexes. Should be integers >= 0.

    repeated .tensorflow.metadata.v0.SparseFeature.IndexFeature index_feature = 6;

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  13. def getIndexFeatureOrBuilderList(): List[_ <: IndexFeatureOrBuilder]

    Features that represent indexes. Should be integers >= 0.


    Features that represent indexes. Should be integers >= 0.

    repeated .tensorflow.metadata.v0.SparseFeature.IndexFeature index_feature = 6;

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  14. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  15. def getIsSorted(): Boolean

    If true then the index values are already sorted lexicographically.


    If true then the index values are already sorted lexicographically.

    optional bool is_sorted = 8;

    returns

    The isSorted.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  16. 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 = 7;

    returns

    The lifecycleStage.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  17. def getName(): String

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


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

    optional string name = 1;

    returns

    The name.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  18. def getNameBytes(): ByteString

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


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

    optional string name = 1;

    returns

    The bytes for name.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  19. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  20. def getParserForType(): Parser[SparseFeature]
    Definition Classes
    SparseFeature → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  21. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  22. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  23. def getSerializedSize(): Int
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  24. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  25. def getValueFeature(): ValueFeature

    required


    required

    optional .tensorflow.metadata.v0.SparseFeature.ValueFeature value_feature = 9;

    returns

    The valueFeature.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  26. def getValueFeatureOrBuilder(): ValueFeatureOrBuilder

    required


    required

    optional .tensorflow.metadata.v0.SparseFeature.ValueFeature value_feature = 9;

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  27. def hasDenseShape(): Boolean

    Shape of the sparse tensor that this SparseFeature represents.
Currently not supported.
TODO(b/109669962): Consider deriving this from the referred features.


    Shape of the sparse tensor that this SparseFeature represents.
Currently not supported.
TODO(b/109669962): Consider deriving this from the referred features.

    optional .tensorflow.metadata.v0.FixedShape dense_shape = 5;

    returns

    Whether the denseShape field is set.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  28. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  29. def hasIsSorted(): Boolean

    If true then the index values are already sorted lexicographically.


    If true then the index values are already sorted lexicographically.

    optional bool is_sorted = 8;

    returns

    Whether the isSorted field is set.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  30. 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 = 7;

    returns

    Whether the lifecycleStage field is set.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  31. def hasName(): Boolean

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


    Name for the sparse 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
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  32. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  33. def hasValueFeature(): Boolean

    required


    required

    optional .tensorflow.metadata.v0.SparseFeature.ValueFeature value_feature = 9;

    returns

    Whether the valueFeature field is set.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  34. def hashCode(): Int
    Definition Classes
    SparseFeature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  35. final def isInitialized(): Boolean
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  36. def newBuilderForType(): Builder
    Definition Classes
    SparseFeature → Message → MessageLite
    Annotations
    @Override()
  37. def toBuilder(): Builder
    Definition Classes
    SparseFeature → Message → MessageLite
    Annotations
    @Override()
  38. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  39. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  40. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  41. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  42. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  43. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getDeprecated(): Boolean

    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.


    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.

    optional bool deprecated = 2 [deprecated = true];

    returns

    The deprecated.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def getPresence(): FeaturePresence

    Constraints on the presence of this feature in examples.
Deprecated, this is inferred by the referred features.


    Constraints on the presence of this feature in examples.
Deprecated, this is inferred by the referred features.

    optional .tensorflow.metadata.v0.FeaturePresence presence = 4 [deprecated = true];

    returns

    The presence.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  3. def getPresenceOrBuilder(): FeaturePresenceOrBuilder

    Constraints on the presence of this feature in examples.
Deprecated, this is inferred by the referred features.


    Constraints on the presence of this feature in examples.
Deprecated, this is inferred by the referred features.

    optional .tensorflow.metadata.v0.FeaturePresence presence = 4 [deprecated = true];

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  4. def getType(): FeatureType

    Type of value feature.
Deprecated, this is inferred by the referred features.


    Type of value feature.
Deprecated, this is inferred by the referred features.

    optional .tensorflow.metadata.v0.FeatureType type = 10 [deprecated = true];

    returns

    The type.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  5. def hasDeprecated(): Boolean

    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.


    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.

    optional bool deprecated = 2 [deprecated = true];

    returns

    Whether the deprecated field is set.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  6. def hasPresence(): Boolean

    Constraints on the presence of this feature in examples.
Deprecated, this is inferred by the referred features.


    Constraints on the presence of this feature in examples.
Deprecated, this is inferred by the referred features.

    optional .tensorflow.metadata.v0.FeaturePresence presence = 4 [deprecated = true];

    returns

    Whether the presence field is set.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  7. def hasType(): Boolean

    Type of value feature.
Deprecated, this is inferred by the referred features.


    Type of value feature.
Deprecated, this is inferred by the referred features.

    optional .tensorflow.metadata.v0.FeatureType type = 10 [deprecated = true];

    returns

    Whether the type field is set.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated