org.tensorflow.metadata.v0

Class SparseFeature

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.metadata.v0.SparseFeature

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SparseFeatureOrBuilder

public final class SparseFeature
extends com.google.protobuf.GeneratedMessageV3
implements 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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SparseFeature.Builder A sparse feature represents a sparse tensor that is encoded with a combination of raw features, namely index features and a value feature.
static class	SparseFeature.IndexFeature Protobuf type tensorflow.metadata.v0.SparseFeature.IndexFeature
static interface	SparseFeature.IndexFeatureOrBuilder
static class	SparseFeature.ValueFeature Protobuf type tensorflow.metadata.v0.SparseFeature.ValueFeature
static interface	SparseFeature.ValueFeatureOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DENSE_SHAPE_FIELD_NUMBER
static int	DEPRECATED_FIELD_NUMBER
static int	INDEX_FEATURE_FIELD_NUMBER
static int	IS_SORTED_FIELD_NUMBER
static int	LIFECYCLE_STAGE_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static com.google.protobuf.Parser<SparseFeature>	PARSER Deprecated.
static int	PRESENCE_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	VALUE_FEATURE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SparseFeature	getDefaultInstance()
SparseFeature	getDefaultInstanceForType()
FixedShape	getDenseShape() Shape of the sparse tensor that this SparseFeature represents.
FixedShapeOrBuilder	getDenseShapeOrBuilder() Shape of the sparse tensor that this SparseFeature represents.
boolean	getDeprecated() Deprecated.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
SparseFeature.IndexFeature	getIndexFeature(int index) Features that represent indexes.
int	getIndexFeatureCount() Features that represent indexes.
List<SparseFeature.IndexFeature>	getIndexFeatureList() Features that represent indexes.
SparseFeature.IndexFeatureOrBuilder	getIndexFeatureOrBuilder(int index) Features that represent indexes.
List<? extends SparseFeature.IndexFeatureOrBuilder>	getIndexFeatureOrBuilderList() Features that represent indexes.
boolean	getIsSorted() If true then the index values are already sorted lexicographically.
LifecycleStage	getLifecycleStage() The lifecycle_stage determines where a feature is expected to be used, and therefore how important issues with it are.
String	getName() Name for the sparse feature.
com.google.protobuf.ByteString	getNameBytes() Name for the sparse feature.
com.google.protobuf.Parser<SparseFeature>	getParserForType()
FeaturePresence	getPresence() Deprecated.
FeaturePresenceOrBuilder	getPresenceOrBuilder() Deprecated.
int	getSerializedSize()
FeatureType	getType() Deprecated.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
SparseFeature.ValueFeature	getValueFeature() required
SparseFeature.ValueFeatureOrBuilder	getValueFeatureOrBuilder() required
boolean	hasDenseShape() Shape of the sparse tensor that this SparseFeature represents.
boolean	hasDeprecated() Deprecated.
int	hashCode()
boolean	hasIsSorted() If true then the index values are already sorted lexicographically.
boolean	hasLifecycleStage() The lifecycle_stage determines where a feature is expected to be used, and therefore how important issues with it are.
boolean	hasName() Name for the sparse feature.
boolean	hasPresence() Deprecated.
boolean	hasType() Deprecated.
boolean	hasValueFeature() required
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SparseFeature.Builder	newBuilder()
static SparseFeature.Builder	newBuilder(SparseFeature prototype)
SparseFeature.Builder	newBuilderForType()
protected SparseFeature.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SparseFeature	parseDelimitedFrom(InputStream input)
static SparseFeature	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SparseFeature	parseFrom(byte[] data)
static SparseFeature	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SparseFeature	parseFrom(ByteBuffer data)
static SparseFeature	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SparseFeature	parseFrom(com.google.protobuf.ByteString data)
static SparseFeature	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SparseFeature	parseFrom(com.google.protobuf.CodedInputStream input)
static SparseFeature	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SparseFeature	parseFrom(InputStream input)
static SparseFeature	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SparseFeature>	parser()
SparseFeature.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER

See Also:

Constant Field Values

LIFECYCLE_STAGE_FIELD_NUMBER

public static final int LIFECYCLE_STAGE_FIELD_NUMBER

See Also:

Constant Field Values

PRESENCE_FIELD_NUMBER

public static final int PRESENCE_FIELD_NUMBER

See Also:

Constant Field Values

DENSE_SHAPE_FIELD_NUMBER

public static final int DENSE_SHAPE_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_FEATURE_FIELD_NUMBER

public static final int INDEX_FEATURE_FIELD_NUMBER

See Also:

Constant Field Values

IS_SORTED_FIELD_NUMBER

public static final int IS_SORTED_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FEATURE_FIELD_NUMBER

public static final int VALUE_FEATURE_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<SparseFeature> PARSER

Deprecated.

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasName

public boolean hasName()

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

optional string name = 1;

Specified by:

hasName in interface SparseFeatureOrBuilder

Returns:

Whether the name field is set.

getName

public String getName()

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

optional string name = 1;

Specified by:

getName in interface SparseFeatureOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

optional string name = 1;

Specified by:

getNameBytes in interface SparseFeatureOrBuilder

Returns:

The bytes for name.

hasDeprecated

@Deprecated
public boolean hasDeprecated()

Deprecated.

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

optional bool deprecated = 2 [deprecated = true];

Specified by:

hasDeprecated in interface SparseFeatureOrBuilder

Returns:

Whether the deprecated field is set.

getDeprecated

@Deprecated
public boolean getDeprecated()

Deprecated.

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

optional bool deprecated = 2 [deprecated = true];

Specified by:

getDeprecated in interface SparseFeatureOrBuilder

Returns:

The deprecated.

hasLifecycleStage

public boolean hasLifecycleStage()

 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;

Specified by:

hasLifecycleStage in interface SparseFeatureOrBuilder

Returns:

Whether the lifecycleStage field is set.

getLifecycleStage

public LifecycleStage getLifecycleStage()

 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;

Specified by:

getLifecycleStage in interface SparseFeatureOrBuilder

Returns:

The lifecycleStage.

hasPresence

@Deprecated
public boolean hasPresence()

Deprecated.

 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];

Specified by:

hasPresence in interface SparseFeatureOrBuilder

Returns:

Whether the presence field is set.

getPresence

@Deprecated
public FeaturePresence getPresence()

Deprecated.

 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];

Specified by:

getPresence in interface SparseFeatureOrBuilder

Returns:

The presence.

getPresenceOrBuilder

@Deprecated
public FeaturePresenceOrBuilder getPresenceOrBuilder()

Deprecated.

 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];

Specified by:

getPresenceOrBuilder in interface SparseFeatureOrBuilder

hasDenseShape

public boolean hasDenseShape()

 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;

Specified by:

hasDenseShape in interface SparseFeatureOrBuilder

Returns:

Whether the denseShape field is set.

getDenseShape

public FixedShape getDenseShape()

 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;

Specified by:

getDenseShape in interface SparseFeatureOrBuilder

Returns:

The denseShape.

getDenseShapeOrBuilder

public FixedShapeOrBuilder getDenseShapeOrBuilder()

 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;

Specified by:

getDenseShapeOrBuilder in interface SparseFeatureOrBuilder

getIndexFeatureList

public List<SparseFeature.IndexFeature> getIndexFeatureList()

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

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

Specified by:

getIndexFeatureList in interface SparseFeatureOrBuilder

getIndexFeatureOrBuilderList

public List<? extends SparseFeature.IndexFeatureOrBuilder> getIndexFeatureOrBuilderList()

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

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

Specified by:

getIndexFeatureOrBuilderList in interface SparseFeatureOrBuilder

getIndexFeatureCount

public int getIndexFeatureCount()

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

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

Specified by:

getIndexFeatureCount in interface SparseFeatureOrBuilder

getIndexFeature

public SparseFeature.IndexFeature getIndexFeature(int index)

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

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

Specified by:

getIndexFeature in interface SparseFeatureOrBuilder

getIndexFeatureOrBuilder

public SparseFeature.IndexFeatureOrBuilder getIndexFeatureOrBuilder(int index)

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

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

Specified by:

getIndexFeatureOrBuilder in interface SparseFeatureOrBuilder

hasIsSorted

public boolean hasIsSorted()

 If true then the index values are already sorted lexicographically.
 

optional bool is_sorted = 8;

Specified by:

hasIsSorted in interface SparseFeatureOrBuilder

Returns:

Whether the isSorted field is set.

getIsSorted

public boolean getIsSorted()

 If true then the index values are already sorted lexicographically.
 

optional bool is_sorted = 8;

Specified by:

getIsSorted in interface SparseFeatureOrBuilder

Returns:

The isSorted.

hasValueFeature

public boolean hasValueFeature()

 required
 

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

Specified by:

hasValueFeature in interface SparseFeatureOrBuilder

Returns:

Whether the valueFeature field is set.

getValueFeature

public SparseFeature.ValueFeature getValueFeature()

 required
 

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

Specified by:

getValueFeature in interface SparseFeatureOrBuilder

Returns:

The valueFeature.

getValueFeatureOrBuilder

public SparseFeature.ValueFeatureOrBuilder getValueFeatureOrBuilder()

 required
 

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

Specified by:

getValueFeatureOrBuilder in interface SparseFeatureOrBuilder

hasType

@Deprecated
public boolean hasType()

Deprecated.

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

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

Specified by:

hasType in interface SparseFeatureOrBuilder

Returns:

Whether the type field is set.

getType

@Deprecated
public FeatureType getType()

Deprecated.

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

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

Specified by:

getType in interface SparseFeatureOrBuilder

Returns:

The type.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SparseFeature parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SparseFeature parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SparseFeature parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SparseFeature parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SparseFeature parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SparseFeature parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SparseFeature parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static SparseFeature parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static SparseFeature parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static SparseFeature parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static SparseFeature parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static SparseFeature parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public SparseFeature.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SparseFeature.Builder newBuilder()

newBuilder

public static SparseFeature.Builder newBuilder(SparseFeature prototype)

toBuilder

public SparseFeature.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SparseFeature.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SparseFeature getDefaultInstance()

parser

public static com.google.protobuf.Parser<SparseFeature> parser()

getParserForType

public com.google.protobuf.Parser<SparseFeature> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SparseFeature getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder