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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    SparseFeature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getDefaultInstanceForType(): SparseFeature
    Definition Classes
    SparseFeature → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  13. 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()
  14. 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()
  15. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  17. 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()
  18. 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()
  19. 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()
  20. 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()
  21. 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()
  22. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  23. 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()
  24. 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()
  25. 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()
  26. 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()
  27. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  28. def getParserForType(): Parser[SparseFeature]
    Definition Classes
    SparseFeature → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  29. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  30. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  31. def getSerializedSize(): Int
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  32. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  33. def getValueFeature(): ValueFeature

    required


    required

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

    returns

    The valueFeature.

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

    required


    required

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

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
    Annotations
    @Override()
  35. 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()
  36. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  37. 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()
  38. 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()
  39. 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()
  40. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  41. 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()
  42. def hashCode(): Int
    Definition Classes
    SparseFeature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  43. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v0]
    Definition Classes
    SparseFeature → GeneratedMessageV3
    Annotations
    @Override()
  44. def internalGetMapFieldReflection(fieldNumber: Int): MapFieldReflectionAccessor
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  45. final def isInitialized(): Boolean
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v0]
    Definition Classes
    SparseFeature → GeneratedMessageV3
    Annotations
    @Override()
  50. def newBuilderForType(): Builder
    Definition Classes
    SparseFeature → Message → MessageLite
    Annotations
    @Override()
  51. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  52. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v0]
    Definition Classes
    SparseFeature → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  56. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. def toBuilder(): Builder
    Definition Classes
    SparseFeature → Message → MessageLite
    Annotations
    @Override()
  59. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  60. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  61. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  65. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  66. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  67. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  68. 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
  8. def internalGetMapField(fieldNumber: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @Deprecated
    Deprecated
  9. def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from SparseFeatureOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped