org.tensorflow.metadata.v0

Interface SparseFeatureOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SparseFeature, SparseFeature.Builder

public interface SparseFeatureOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
FeaturePresence	getPresence() Deprecated.
FeaturePresenceOrBuilder	getPresenceOrBuilder() Deprecated.
FeatureType	getType() Deprecated.
SparseFeature.ValueFeature	getValueFeature() required
SparseFeature.ValueFeatureOrBuilder	getValueFeatureOrBuilder() required
boolean	hasDenseShape() Shape of the sparse tensor that this SparseFeature represents.
boolean	hasDeprecated() Deprecated.
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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasName

boolean hasName()

 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.

getName

String getName()

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

optional string name = 1;

Returns:

The name.

getNameBytes

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;

Returns:

The bytes for name.

hasDeprecated

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

Returns:

Whether the deprecated field is set.

getDeprecated

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

Returns:

The deprecated.

hasLifecycleStage

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;

Returns:

Whether the lifecycleStage field is set.

getLifecycleStage

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;

Returns:

The lifecycleStage.

hasPresence

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

Returns:

Whether the presence field is set.

getPresence

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

Returns:

The presence.

getPresenceOrBuilder

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

hasDenseShape

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;

Returns:

Whether the denseShape field is set.

getDenseShape

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;

Returns:

The denseShape.

getDenseShapeOrBuilder

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;

getIndexFeatureList

List<SparseFeature.IndexFeature> getIndexFeatureList()

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

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

getIndexFeature

SparseFeature.IndexFeature getIndexFeature(int index)

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

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

getIndexFeatureCount

int getIndexFeatureCount()

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

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

getIndexFeatureOrBuilderList

List<? extends SparseFeature.IndexFeatureOrBuilder> getIndexFeatureOrBuilderList()

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

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

getIndexFeatureOrBuilder

SparseFeature.IndexFeatureOrBuilder getIndexFeatureOrBuilder(int index)

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

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

hasIsSorted

boolean hasIsSorted()

 If true then the index values are already sorted lexicographically.
 

optional bool is_sorted = 8;

Returns:

Whether the isSorted field is set.

getIsSorted

boolean getIsSorted()

 If true then the index values are already sorted lexicographically.
 

optional bool is_sorted = 8;

Returns:

The isSorted.

hasValueFeature

boolean hasValueFeature()

 required
 

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

Returns:

Whether the valueFeature field is set.

getValueFeature

SparseFeature.ValueFeature getValueFeature()

 required
 

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

Returns:

The valueFeature.

getValueFeatureOrBuilder

SparseFeature.ValueFeatureOrBuilder getValueFeatureOrBuilder()

 required
 

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

hasType

@Deprecated
boolean hasType()

Deprecated.

 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.

getType

@Deprecated
FeatureType getType()

Deprecated.

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

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

Returns:

The type.