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

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() @HotSpotIntrinsicCandidate()
  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 findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  9. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def getDefaultInstanceForType(): SparseFeature
    Definition Classes
    SparseFeature → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  12. 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
  13. 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
  14. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  15. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. 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
  17. 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
  18. 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
  19. 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
  20. 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
  21. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  22. 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
  23. 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
  24. 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
  25. 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
  26. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  27. def getParserForType(): Parser[SparseFeature]
    Definition Classes
    SparseFeature → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  28. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  29. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  30. def getSerializedSize(): Int
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  31. final def getUnknownFields(): UnknownFieldSet
    Definition Classes
    SparseFeature → GeneratedMessageV3 → MessageOrBuilder
    Annotations
    @Override()
  32. def getValueFeature(): ValueFeature

    required


    required

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

    returns

    The valueFeature.

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
  33. def getValueFeatureOrBuilder(): ValueFeatureOrBuilder

    required


    required

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

    Definition Classes
    SparseFeature → SparseFeatureOrBuilder
  34. 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
  35. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  36. 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
  37. 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
  38. 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
  39. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  40. 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
  41. def hashCode(): Int
    Definition Classes
    SparseFeature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  42. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v0]
    Definition Classes
    SparseFeature → GeneratedMessageV3
    Annotations
    @Override()
  43. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  44. final def isInitialized(): Boolean
    Definition Classes
    SparseFeature → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  47. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException])
  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(arg0: 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() @HotSpotIntrinsicCandidate()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  56. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: 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(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. def writeDelimitedTo(arg0: 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(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. 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
    @Deprecated
    Deprecated
  3. 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
    @Deprecated
    Deprecated
  4. 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
    @Deprecated
    Deprecated
  5. 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
    @Deprecated
    Deprecated
  6. 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
    @Deprecated
    Deprecated
  7. 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
    @Deprecated
    Deprecated
  8. 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
    @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