Package com.google.cloud.aiplatform.v1beta1

Enum ExplanationMetadata.InputMetadata.Visualization.Polarity

java.lang.Object

java.lang.Enum<ExplanationMetadata.InputMetadata.Visualization.Polarity>

com.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.Polarity

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ExplanationMetadata.InputMetadata.Visualization.Polarity>

Enclosing class:

ExplanationMetadata.InputMetadata.Visualization

public static enum ExplanationMetadata.InputMetadata.Visualization.Polarity
extends Enum<ExplanationMetadata.InputMetadata.Visualization.Polarity>
implements com.google.protobuf.ProtocolMessageEnum

 Whether to only highlight pixels with positive contributions, negative
 or both. Defaults to POSITIVE.
 

Protobuf enum google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Visualization.Polarity

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Shows both positive and negative attributions.
NEGATIVE	Setting polarity to negative highlights areas that does not lead to the models's current prediction.
POLARITY_UNSPECIFIED	Default value.
POSITIVE	Highlights the pixels/outlines that were most influential to the model's prediction.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	BOTH_VALUE	Shows both positive and negative attributions.
static int	NEGATIVE_VALUE	Setting polarity to negative highlights areas that does not lead to the models's current prediction.
static int	POLARITY_UNSPECIFIED_VALUE	Default value.
static int	POSITIVE_VALUE	Highlights the pixels/outlines that were most influential to the model's prediction.

Method Summary

Modifier and Type	Method	Description
static ExplanationMetadata.InputMetadata.Visualization.Polarity	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<ExplanationMetadata.InputMetadata.Visualization.Polarity>	internalGetValueMap()
static ExplanationMetadata.InputMetadata.Visualization.Polarity	valueOf(int value)	Deprecated.
static ExplanationMetadata.InputMetadata.Visualization.Polarity	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static ExplanationMetadata.InputMetadata.Visualization.Polarity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ExplanationMetadata.InputMetadata.Visualization.Polarity[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POLARITY_UNSPECIFIED

public static final ExplanationMetadata.InputMetadata.Visualization.Polarity POLARITY_UNSPECIFIED

 Default value. This is the same as POSITIVE.
 

POLARITY_UNSPECIFIED = 0;

POSITIVE

public static final ExplanationMetadata.InputMetadata.Visualization.Polarity POSITIVE

 Highlights the pixels/outlines that were most influential to the
 model's prediction.
 

POSITIVE = 1;

NEGATIVE

public static final ExplanationMetadata.InputMetadata.Visualization.Polarity NEGATIVE

 Setting polarity to negative highlights areas that does not lead to
 the models's current prediction.
 

NEGATIVE = 2;

BOTH

public static final ExplanationMetadata.InputMetadata.Visualization.Polarity BOTH

 Shows both positive and negative attributions.
 

BOTH = 3;

UNRECOGNIZED

public static final ExplanationMetadata.InputMetadata.Visualization.Polarity UNRECOGNIZED

Field Detail

POLARITY_UNSPECIFIED_VALUE

public static final int POLARITY_UNSPECIFIED_VALUE

 Default value. This is the same as POSITIVE.
 

POLARITY_UNSPECIFIED = 0;

See Also:

Constant Field Values

POSITIVE_VALUE

public static final int POSITIVE_VALUE

 Highlights the pixels/outlines that were most influential to the
 model's prediction.
 

POSITIVE = 1;

See Also:

Constant Field Values

NEGATIVE_VALUE

public static final int NEGATIVE_VALUE

 Setting polarity to negative highlights areas that does not lead to
 the models's current prediction.
 

NEGATIVE = 2;

See Also:

Constant Field Values

BOTH_VALUE

public static final int BOTH_VALUE

 Shows both positive and negative attributions.
 

BOTH = 3;

See Also:

Constant Field Values

Method Detail

values

public static ExplanationMetadata.InputMetadata.Visualization.Polarity[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExplanationMetadata.InputMetadata.Visualization.Polarity c : ExplanationMetadata.InputMetadata.Visualization.Polarity.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExplanationMetadata.InputMetadata.Visualization.Polarity valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static ExplanationMetadata.InputMetadata.Visualization.Polarity valueOf(int value)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

value - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forNumber

public static ExplanationMetadata.InputMetadata.Visualization.Polarity forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<ExplanationMetadata.InputMetadata.Visualization.Polarity> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

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

valueOf

public static ExplanationMetadata.InputMetadata.Visualization.Polarity valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

desc - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null