Package com.google.cloud.aiplatform.v1

Class ExplanationMetadata.InputMetadata.Visualization

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.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.GeneratedMessage implements ExplanationMetadata.InputMetadata.VisualizationOrBuilder
 Visualization configurations for image explanation.
Protobuf type google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization
See Also:

  • Field Details

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • POLARITY_FIELD_NUMBER

      public static final int POLARITY_FIELD_NUMBER
      See Also:

    • COLOR_MAP_FIELD_NUMBER

      public static final int COLOR_MAP_FIELD_NUMBER
      See Also:

    • CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER

      public static final int CLIP_PERCENT_UPPERBOUND_FIELD_NUMBER
      See Also:

    • CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER

      public static final int CLIP_PERCENT_LOWERBOUND_FIELD_NUMBER
      See Also:

    • OVERLAY_TYPE_FIELD_NUMBER

      public static final int OVERLAY_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getTypeValue

      public int getTypeValue()
       Type of the image visualization. Only applicable to
 [Integrated Gradients
 attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution].
 OUTLINES shows regions of attribution, while PIXELS shows per-pixel
 attribution. Defaults to OUTLINES.
      .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization.Type type = 1;
      Specified by:
      getTypeValue in interface ExplanationMetadata.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.v1.ExplanationParameters.integrated_gradients_attribution].
 OUTLINES shows regions of attribution, while PIXELS shows per-pixel
 attribution. Defaults to OUTLINES.
      .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization.Type type = 1;
      Specified by:
      getType in interface ExplanationMetadata.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.v1.ExplanationMetadata.InputMetadata.Visualization.Polarity polarity = 2;
      Specified by:
      getPolarityValue in interface ExplanationMetadata.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.v1.ExplanationMetadata.InputMetadata.Visualization.Polarity polarity = 2;
      Specified by:
      getPolarity in interface ExplanationMetadata.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.v1.ExplanationParameters.integrated_gradients_attribution],
 which shows positive attributions in green and negative in pink.

 Defaults to VIRIDIS for
 [XRAI
 attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
 which highlights the most influential regions in yellow and the least
 influential in blue.
      .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization.ColorMap color_map = 3;
      Specified by:
      getColorMapValue in interface ExplanationMetadata.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.v1.ExplanationParameters.integrated_gradients_attribution],
 which shows positive attributions in green and negative in pink.

 Defaults to VIRIDIS for
 [XRAI
 attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution],
 which highlights the most influential regions in yellow and the least
 influential in blue.
      .google.cloud.aiplatform.v1.ExplanationMetadata.InputMetadata.Visualization.ColorMap color_map = 3;
      Specified by:
      getColorMap in interface ExplanationMetadata.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 interface ExplanationMetadata.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 interface ExplanationMetadata.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.v1.ExplanationMetadata.InputMetadata.Visualization.OverlayType overlay_type = 6;
      Specified by:
      getOverlayTypeValue in interface ExplanationMetadata.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.v1.ExplanationMetadata.InputMetadata.Visualization.OverlayType overlay_type = 6;
      Specified by:
      getOverlayType in interface ExplanationMetadata.InputMetadata.VisualizationOrBuilder
      Returns:
      The overlayType.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 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 interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.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 interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExplanationMetadata.InputMetadata.Visualization.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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 interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ExplanationMetadata.InputMetadata.Visualization getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder