Class ExplanationMetadata.InputMetadata.FeatureValueDomain (1.13.0) 

public static final class ExplanationMetadata.InputMetadata.FeatureValueDomain extends GeneratedMessageV3 implements ExplanationMetadata.InputMetadata.FeatureValueDomainOrBuilder

Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained.

Protobuf type google.cloud.vertexai.v1.ExplanationMetadata.InputMetadata.FeatureValueDomain

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExplanationMetadata.InputMetadata.FeatureValueDomain

Static Fields

MAX_VALUE_FIELD_NUMBER

public static final int MAX_VALUE_FIELD_NUMBER
Field Value
Type Description
int

MIN_VALUE_FIELD_NUMBER

public static final int MIN_VALUE_FIELD_NUMBER
Field Value
Type Description
int

ORIGINAL_MEAN_FIELD_NUMBER

public static final int ORIGINAL_MEAN_FIELD_NUMBER
Field Value
Type Description
int

ORIGINAL_STDDEV_FIELD_NUMBER

public static final int ORIGINAL_STDDEV_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplanationMetadata.InputMetadata.FeatureValueDomain getDefaultInstance()
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder newBuilder()
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder

newBuilder(ExplanationMetadata.InputMetadata.FeatureValueDomain prototype)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder newBuilder(ExplanationMetadata.InputMetadata.FeatureValueDomain prototype)
Parameter
Name Description
prototype ExplanationMetadata.InputMetadata.FeatureValueDomain
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder

parseDelimitedFrom(InputStream input)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplanationMetadata.InputMetadata.FeatureValueDomain parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExplanationMetadata.InputMetadata.FeatureValueDomain> parser()
Returns
Type Description
Parser<FeatureValueDomain>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExplanationMetadata.InputMetadata.FeatureValueDomain getDefaultInstanceForType()
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain

getMaxValue()

public float getMaxValue()

The maximum permissible value for this feature.

float max_value = 2;

Returns
Type Description
float

The maxValue.

getMinValue()

public float getMinValue()

The minimum permissible value for this feature.

float min_value = 1;

Returns
Type Description
float

The minValue.

getOriginalMean()

public float getOriginalMean()

If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.

float original_mean = 3;

Returns
Type Description
float

The originalMean.

getOriginalStddev()

public float getOriginalStddev()

If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.

float original_stddev = 4;

Returns
Type Description
float

The originalStddev.

getParserForType()

public Parser<ExplanationMetadata.InputMetadata.FeatureValueDomain> getParserForType()
Returns
Type Description
Parser<FeatureValueDomain>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder newBuilderForType()
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder toBuilder()
Returns
Type Description
ExplanationMetadata.InputMetadata.FeatureValueDomain.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException