Class ExplanationMetadata.InputMetadata.Visualization
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization
-
- All Implemented Interfaces:
ExplanationMetadata.InputMetadata.VisualizationOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
- Enclosing class:
- ExplanationMetadata.InputMetadata
public static final class ExplanationMetadata.InputMetadata.Visualization extends com.google.protobuf.GeneratedMessageV3 implements ExplanationMetadata.InputMetadata.VisualizationOrBuilder
Visualization configurations for image explanation.
Protobuf typegoogle.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExplanationMetadata.InputMetadata.Visualization.Builder
Visualization configurations for image explanation.static class
ExplanationMetadata.InputMetadata.Visualization.ColorMap
The color scheme used for highlighting areas.static class
ExplanationMetadata.InputMetadata.Visualization.OverlayType
How the original image is displayed in the visualization.static class
ExplanationMetadata.InputMetadata.Visualization.Polarity
Whether to only highlight pixels with positive contributions, negative or both.static class
ExplanationMetadata.InputMetadata.Visualization.Type
Type of the image visualization.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER
static int
CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER
static int
COLOR_MAP_FIELD_NUMBER
static int
OVERLAY_TYPE_FIELD_NUMBER
static int
POLARITY_FIELD_NUMBER
static int
TYPE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
float
getClipPercentLowerbound()
Excludes attributions below the specified percentile, from the highlighted areas.float
getClipPercentUpperbound()
Excludes attributions above the specified percentile from the highlighted areas.ExplanationMetadata.InputMetadata.Visualization.ColorMap
getColorMap()
The color scheme used for the highlighted areas.int
getColorMapValue()
The color scheme used for the highlighted areas.static ExplanationMetadata.InputMetadata.Visualization
getDefaultInstance()
ExplanationMetadata.InputMetadata.Visualization
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
ExplanationMetadata.InputMetadata.Visualization.OverlayType
getOverlayType()
How the original image is displayed in the visualization.int
getOverlayTypeValue()
How the original image is displayed in the visualization.com.google.protobuf.Parser<ExplanationMetadata.InputMetadata.Visualization>
getParserForType()
ExplanationMetadata.InputMetadata.Visualization.Polarity
getPolarity()
Whether to only highlight pixels with positive contributions, negative or both.int
getPolarityValue()
Whether to only highlight pixels with positive contributions, negative or both.int
getSerializedSize()
ExplanationMetadata.InputMetadata.Visualization.Type
getType()
Type of the image visualization.int
getTypeValue()
Type of the image visualization.int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static ExplanationMetadata.InputMetadata.Visualization.Builder
newBuilder()
static ExplanationMetadata.InputMetadata.Visualization.Builder
newBuilder(ExplanationMetadata.InputMetadata.Visualization prototype)
ExplanationMetadata.InputMetadata.Visualization.Builder
newBuilderForType()
protected ExplanationMetadata.InputMetadata.Visualization.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExplanationMetadata.InputMetadata.Visualization
parseDelimitedFrom(InputStream input)
static ExplanationMetadata.InputMetadata.Visualization
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(byte[] data)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(com.google.protobuf.ByteString data)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(com.google.protobuf.CodedInputStream input)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(InputStream input)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(ByteBuffer data)
static ExplanationMetadata.InputMetadata.Visualization
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExplanationMetadata.InputMetadata.Visualization>
parser()
ExplanationMetadata.InputMetadata.Visualization.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, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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
-
-
-
-
Field Detail
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
POLARITY_FIELD_NUMBER
public static final int POLARITY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COLOR_MAP_FIELD_NUMBER
public static final int COLOR_MAP_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER
public static final int CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER
public static final int CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER
- See Also:
- Constant Field Values
-
OVERLAY_TYPE_FIELD_NUMBER
public static final int OVERLAY_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
getTypeValue
public int getTypeValue()
Type of the image visualization. Only applicable to [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.Type type = 1;
- Specified by:
getTypeValue
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The enum numeric value on the wire for type.
-
getType
public ExplanationMetadata.InputMetadata.Visualization.Type getType()
Type of the image visualization. Only applicable to [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution]. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.Type type = 1;
- Specified by:
getType
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The type.
-
getPolarityValue
public int getPolarityValue()
Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.Polarity polarity = 2;
- Specified by:
getPolarityValue
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The enum numeric value on the wire for polarity.
-
getPolarity
public ExplanationMetadata.InputMetadata.Visualization.Polarity getPolarity()
Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.Polarity polarity = 2;
- Specified by:
getPolarity
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The polarity.
-
getColorMapValue
public int getColorMapValue()
The color scheme used for the highlighted areas. Defaults to PINK_GREEN for [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution], which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution], which highlights the most influential regions in yellow and the least influential in blue.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.ColorMap color_map = 3;
- Specified by:
getColorMapValue
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The enum numeric value on the wire for colorMap.
-
getColorMap
public ExplanationMetadata.InputMetadata.Visualization.ColorMap getColorMap()
The color scheme used for the highlighted areas. Defaults to PINK_GREEN for [Integrated Gradients attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.integrated_gradients_attribution], which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for [XRAI attribution][google.cloud.aiplatform.v1beta1.ExplanationParameters.xrai_attribution], which highlights the most influential regions in yellow and the least influential in blue.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.ColorMap color_map = 3;
- Specified by:
getColorMap
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The colorMap.
-
getClipPercentUpperbound
public float getClipPercentUpperbound()
Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
float clip_percent_upperbound = 4;
- Specified by:
getClipPercentUpperbound
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The clipPercentUpperbound.
-
getClipPercentLowerbound
public float getClipPercentLowerbound()
Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
float clip_percent_lowerbound = 5;
- Specified by:
getClipPercentLowerbound
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The clipPercentLowerbound.
-
getOverlayTypeValue
public int getOverlayTypeValue()
How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.OverlayType overlay_type = 6;
- Specified by:
getOverlayTypeValue
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The enum numeric value on the wire for overlayType.
-
getOverlayType
public ExplanationMetadata.InputMetadata.Visualization.OverlayType getOverlayType()
How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.OverlayType overlay_type = 6;
- Specified by:
getOverlayType
in interfaceExplanationMetadata.InputMetadata.VisualizationOrBuilder
- Returns:
- The overlayType.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ExplanationMetadata.InputMetadata.Visualization parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ExplanationMetadata.InputMetadata.Visualization parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ExplanationMetadata.InputMetadata.Visualization parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public ExplanationMetadata.InputMetadata.Visualization.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ExplanationMetadata.InputMetadata.Visualization.Builder newBuilder()
-
newBuilder
public static ExplanationMetadata.InputMetadata.Visualization.Builder newBuilder(ExplanationMetadata.InputMetadata.Visualization prototype)
-
toBuilder
public ExplanationMetadata.InputMetadata.Visualization.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ExplanationMetadata.InputMetadata.Visualization.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static ExplanationMetadata.InputMetadata.Visualization getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ExplanationMetadata.InputMetadata.Visualization> parser()
-
getParserForType
public com.google.protobuf.Parser<ExplanationMetadata.InputMetadata.Visualization> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public ExplanationMetadata.InputMetadata.Visualization getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-