org.tensorflow.metadata.v0

Class WeightedFeature

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.metadata.v0.WeightedFeature

All Implemented Interfaces:

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

public final class WeightedFeature
extends com.google.protobuf.GeneratedMessageV3
implements WeightedFeatureOrBuilder

 Represents a weighted feature that is encoded as a combination of raw base
 features. The `weight_feature` should be a float feature with identical
 shape as the `feature`. This is useful for representing weights associated
 with categorical tokens (e.g. a TFIDF weight associated with each token).
 TODO(b/142122960): Handle WeightedCategorical end to end in TFX (validation,
 TFX Unit Testing, etc)
 

Protobuf type tensorflow.metadata.v0.WeightedFeature

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WeightedFeature.Builder Represents a weighted feature that is encoded as a combination of raw base features.

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	FEATURE_FIELD_NUMBER
static int	LIFECYCLE_STAGE_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static com.google.protobuf.Parser<WeightedFeature>	PARSER Deprecated.
static int	WEIGHT_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 WeightedFeature	getDefaultInstance()
WeightedFeature	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Path	getFeature() Path of a base feature to be weighted.
PathOrBuilder	getFeatureOrBuilder() Path of a base feature to be weighted.
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 weighted feature.
com.google.protobuf.ByteString	getNameBytes() Name for the weighted feature.
com.google.protobuf.Parser<WeightedFeature>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
Path	getWeightFeature() Path of weight feature to associate with the base feature.
PathOrBuilder	getWeightFeatureOrBuilder() Path of weight feature to associate with the base feature.
boolean	hasFeature() Path of a base feature to be weighted.
int	hashCode()
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 weighted feature.
boolean	hasWeightFeature() Path of weight feature to associate with the base feature.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static WeightedFeature.Builder	newBuilder()
static WeightedFeature.Builder	newBuilder(WeightedFeature prototype)
WeightedFeature.Builder	newBuilderForType()
protected WeightedFeature.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static WeightedFeature	parseDelimitedFrom(InputStream input)
static WeightedFeature	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedFeature	parseFrom(byte[] data)
static WeightedFeature	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedFeature	parseFrom(ByteBuffer data)
static WeightedFeature	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedFeature	parseFrom(com.google.protobuf.ByteString data)
static WeightedFeature	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedFeature	parseFrom(com.google.protobuf.CodedInputStream input)
static WeightedFeature	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static WeightedFeature	parseFrom(InputStream input)
static WeightedFeature	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<WeightedFeature>	parser()
WeightedFeature.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

FEATURE_FIELD_NUMBER

public static final int FEATURE_FIELD_NUMBER

See Also:

Constant Field Values

WEIGHT_FEATURE_FIELD_NUMBER

public static final int WEIGHT_FEATURE_FIELD_NUMBER

See Also:

Constant Field Values

LIFECYCLE_STAGE_FIELD_NUMBER

public static final int LIFECYCLE_STAGE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<WeightedFeature> 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 weighted feature. This should not clash with other features in
 the same schema.
 

optional string name = 1;

Specified by:

hasName in interface WeightedFeatureOrBuilder

Returns:

Whether the name field is set.

getName

public String getName()

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

optional string name = 1;

Specified by:

getName in interface WeightedFeatureOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

optional string name = 1;

Specified by:

getNameBytes in interface WeightedFeatureOrBuilder

Returns:

The bytes for name.

hasFeature

public boolean hasFeature()

 Path of a base feature to be weighted. Required.
 

optional .tensorflow.metadata.v0.Path feature = 2;

Specified by:

hasFeature in interface WeightedFeatureOrBuilder

Returns:

Whether the feature field is set.

getFeature

public Path getFeature()

 Path of a base feature to be weighted. Required.
 

optional .tensorflow.metadata.v0.Path feature = 2;

Specified by:

getFeature in interface WeightedFeatureOrBuilder

Returns:

The feature.

getFeatureOrBuilder

public PathOrBuilder getFeatureOrBuilder()

 Path of a base feature to be weighted. Required.
 

optional .tensorflow.metadata.v0.Path feature = 2;

Specified by:

getFeatureOrBuilder in interface WeightedFeatureOrBuilder

hasWeightFeature

public boolean hasWeightFeature()

 Path of weight feature to associate with the base feature. Must be same
 shape as feature. Required.
 

optional .tensorflow.metadata.v0.Path weight_feature = 3;

Specified by:

hasWeightFeature in interface WeightedFeatureOrBuilder

Returns:

Whether the weightFeature field is set.

getWeightFeature

public Path getWeightFeature()

 Path of weight feature to associate with the base feature. Must be same
 shape as feature. Required.
 

optional .tensorflow.metadata.v0.Path weight_feature = 3;

Specified by:

getWeightFeature in interface WeightedFeatureOrBuilder

Returns:

The weightFeature.

getWeightFeatureOrBuilder

public PathOrBuilder getWeightFeatureOrBuilder()

 Path of weight feature to associate with the base feature. Must be same
 shape as feature. Required.
 

optional .tensorflow.metadata.v0.Path weight_feature = 3;

Specified by:

getWeightFeatureOrBuilder in interface WeightedFeatureOrBuilder

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 = 4;

Specified by:

hasLifecycleStage in interface WeightedFeatureOrBuilder

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 = 4;

Specified by:

getLifecycleStage in interface WeightedFeatureOrBuilder

Returns:

The lifecycleStage.

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 WeightedFeature parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static WeightedFeature parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static WeightedFeature parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public WeightedFeature.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static WeightedFeature.Builder newBuilder()

newBuilder

public static WeightedFeature.Builder newBuilder(WeightedFeature prototype)

toBuilder

public WeightedFeature.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static WeightedFeature getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<WeightedFeature> 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 WeightedFeature getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder