Package com.google.cloud.aiplatform.v1
Class ExplanationParameters
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.aiplatform.v1.ExplanationParameters
-
- All Implemented Interfaces:
ExplanationParametersOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class ExplanationParameters extends com.google.protobuf.GeneratedMessageV3 implements ExplanationParametersOrBuilder
Parameters to configure explaining for Model's predictions.
Protobuf typegoogle.cloud.aiplatform.v1.ExplanationParameters
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExplanationParameters.Builder
Parameters to configure explaining for Model's predictions.static class
ExplanationParameters.MethodCase
-
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
EXAMPLES_FIELD_NUMBER
static int
INTEGRATED_GRADIENTS_ATTRIBUTION_FIELD_NUMBER
static int
OUTPUT_INDICES_FIELD_NUMBER
static int
SAMPLED_SHAPLEY_ATTRIBUTION_FIELD_NUMBER
static int
TOP_K_FIELD_NUMBER
static int
XRAI_ATTRIBUTION_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
static ExplanationParameters
getDefaultInstance()
ExplanationParameters
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
Examples
getExamples()
Example-based explanations that returns the nearest neighbors from the provided dataset.ExamplesOrBuilder
getExamplesOrBuilder()
Example-based explanations that returns the nearest neighbors from the provided dataset.IntegratedGradientsAttribution
getIntegratedGradientsAttribution()
An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure.IntegratedGradientsAttributionOrBuilder
getIntegratedGradientsAttributionOrBuilder()
An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure.ExplanationParameters.MethodCase
getMethodCase()
com.google.protobuf.ListValue
getOutputIndices()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices.com.google.protobuf.ListValueOrBuilder
getOutputIndicesOrBuilder()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices.com.google.protobuf.Parser<ExplanationParameters>
getParserForType()
SampledShapleyAttribution
getSampledShapleyAttribution()
An attribution method that approximates Shapley values for features that contribute to the label being predicted.SampledShapleyAttributionOrBuilder
getSampledShapleyAttributionOrBuilder()
An attribution method that approximates Shapley values for features that contribute to the label being predicted.int
getSerializedSize()
int
getTopK()
If populated, returns attributions for top K indices of outputs (defaults to 1).XraiAttribution
getXraiAttribution()
An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure.XraiAttributionOrBuilder
getXraiAttributionOrBuilder()
An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure.boolean
hasExamples()
Example-based explanations that returns the nearest neighbors from the provided dataset.int
hashCode()
boolean
hasIntegratedGradientsAttribution()
An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure.boolean
hasOutputIndices()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices.boolean
hasSampledShapleyAttribution()
An attribution method that approximates Shapley values for features that contribute to the label being predicted.boolean
hasXraiAttribution()
An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static ExplanationParameters.Builder
newBuilder()
static ExplanationParameters.Builder
newBuilder(ExplanationParameters prototype)
ExplanationParameters.Builder
newBuilderForType()
protected ExplanationParameters.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExplanationParameters
parseDelimitedFrom(InputStream input)
static ExplanationParameters
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationParameters
parseFrom(byte[] data)
static ExplanationParameters
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationParameters
parseFrom(com.google.protobuf.ByteString data)
static ExplanationParameters
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationParameters
parseFrom(com.google.protobuf.CodedInputStream input)
static ExplanationParameters
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationParameters
parseFrom(InputStream input)
static ExplanationParameters
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExplanationParameters
parseFrom(ByteBuffer data)
static ExplanationParameters
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExplanationParameters>
parser()
ExplanationParameters.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
-
SAMPLED_SHAPLEY_ATTRIBUTION_FIELD_NUMBER
public static final int SAMPLED_SHAPLEY_ATTRIBUTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INTEGRATED_GRADIENTS_ATTRIBUTION_FIELD_NUMBER
public static final int INTEGRATED_GRADIENTS_ATTRIBUTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
XRAI_ATTRIBUTION_FIELD_NUMBER
public static final int XRAI_ATTRIBUTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
EXAMPLES_FIELD_NUMBER
public static final int EXAMPLES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TOP_K_FIELD_NUMBER
public static final int TOP_K_FIELD_NUMBER
- See Also:
- Constant Field Values
-
OUTPUT_INDICES_FIELD_NUMBER
public static final int OUTPUT_INDICES_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
-
getMethodCase
public ExplanationParameters.MethodCase getMethodCase()
- Specified by:
getMethodCase
in interfaceExplanationParametersOrBuilder
-
hasSampledShapleyAttribution
public boolean hasSampledShapleyAttribution()
An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
.google.cloud.aiplatform.v1.SampledShapleyAttribution sampled_shapley_attribution = 1;
- Specified by:
hasSampledShapleyAttribution
in interfaceExplanationParametersOrBuilder
- Returns:
- Whether the sampledShapleyAttribution field is set.
-
getSampledShapleyAttribution
public SampledShapleyAttribution getSampledShapleyAttribution()
An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
.google.cloud.aiplatform.v1.SampledShapleyAttribution sampled_shapley_attribution = 1;
- Specified by:
getSampledShapleyAttribution
in interfaceExplanationParametersOrBuilder
- Returns:
- The sampledShapleyAttribution.
-
getSampledShapleyAttributionOrBuilder
public SampledShapleyAttributionOrBuilder getSampledShapleyAttributionOrBuilder()
An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
.google.cloud.aiplatform.v1.SampledShapleyAttribution sampled_shapley_attribution = 1;
- Specified by:
getSampledShapleyAttributionOrBuilder
in interfaceExplanationParametersOrBuilder
-
hasIntegratedGradientsAttribution
public boolean hasIntegratedGradientsAttribution()
An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
.google.cloud.aiplatform.v1.IntegratedGradientsAttribution integrated_gradients_attribution = 2;
- Specified by:
hasIntegratedGradientsAttribution
in interfaceExplanationParametersOrBuilder
- Returns:
- Whether the integratedGradientsAttribution field is set.
-
getIntegratedGradientsAttribution
public IntegratedGradientsAttribution getIntegratedGradientsAttribution()
An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
.google.cloud.aiplatform.v1.IntegratedGradientsAttribution integrated_gradients_attribution = 2;
- Specified by:
getIntegratedGradientsAttribution
in interfaceExplanationParametersOrBuilder
- Returns:
- The integratedGradientsAttribution.
-
getIntegratedGradientsAttributionOrBuilder
public IntegratedGradientsAttributionOrBuilder getIntegratedGradientsAttributionOrBuilder()
An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
.google.cloud.aiplatform.v1.IntegratedGradientsAttribution integrated_gradients_attribution = 2;
- Specified by:
getIntegratedGradientsAttributionOrBuilder
in interfaceExplanationParametersOrBuilder
-
hasXraiAttribution
public boolean hasXraiAttribution()
An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
.google.cloud.aiplatform.v1.XraiAttribution xrai_attribution = 3;
- Specified by:
hasXraiAttribution
in interfaceExplanationParametersOrBuilder
- Returns:
- Whether the xraiAttribution field is set.
-
getXraiAttribution
public XraiAttribution getXraiAttribution()
An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
.google.cloud.aiplatform.v1.XraiAttribution xrai_attribution = 3;
- Specified by:
getXraiAttribution
in interfaceExplanationParametersOrBuilder
- Returns:
- The xraiAttribution.
-
getXraiAttributionOrBuilder
public XraiAttributionOrBuilder getXraiAttributionOrBuilder()
An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
.google.cloud.aiplatform.v1.XraiAttribution xrai_attribution = 3;
- Specified by:
getXraiAttributionOrBuilder
in interfaceExplanationParametersOrBuilder
-
hasExamples
public boolean hasExamples()
Example-based explanations that returns the nearest neighbors from the provided dataset.
.google.cloud.aiplatform.v1.Examples examples = 7;
- Specified by:
hasExamples
in interfaceExplanationParametersOrBuilder
- Returns:
- Whether the examples field is set.
-
getExamples
public Examples getExamples()
Example-based explanations that returns the nearest neighbors from the provided dataset.
.google.cloud.aiplatform.v1.Examples examples = 7;
- Specified by:
getExamples
in interfaceExplanationParametersOrBuilder
- Returns:
- The examples.
-
getExamplesOrBuilder
public ExamplesOrBuilder getExamplesOrBuilder()
Example-based explanations that returns the nearest neighbors from the provided dataset.
.google.cloud.aiplatform.v1.Examples examples = 7;
- Specified by:
getExamplesOrBuilder
in interfaceExplanationParametersOrBuilder
-
getTopK
public int getTopK()
If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
int32 top_k = 4;
- Specified by:
getTopK
in interfaceExplanationParametersOrBuilder
- Returns:
- The topK.
-
hasOutputIndices
public boolean hasOutputIndices()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
.google.protobuf.ListValue output_indices = 5;
- Specified by:
hasOutputIndices
in interfaceExplanationParametersOrBuilder
- Returns:
- Whether the outputIndices field is set.
-
getOutputIndices
public com.google.protobuf.ListValue getOutputIndices()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
.google.protobuf.ListValue output_indices = 5;
- Specified by:
getOutputIndices
in interfaceExplanationParametersOrBuilder
- Returns:
- The outputIndices.
-
getOutputIndicesOrBuilder
public com.google.protobuf.ListValueOrBuilder getOutputIndicesOrBuilder()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1.Attribution.output_index] contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for [top_k][google.cloud.aiplatform.v1.ExplanationParameters.top_k] indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
.google.protobuf.ListValue output_indices = 5;
- Specified by:
getOutputIndicesOrBuilder
in interfaceExplanationParametersOrBuilder
-
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 ExplanationParameters parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationParameters parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationParameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationParameters parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationParameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationParameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ExplanationParameters parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ExplanationParameters parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ExplanationParameters parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static ExplanationParameters parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static ExplanationParameters parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static ExplanationParameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public ExplanationParameters.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ExplanationParameters.Builder newBuilder()
-
newBuilder
public static ExplanationParameters.Builder newBuilder(ExplanationParameters prototype)
-
toBuilder
public ExplanationParameters.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ExplanationParameters.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static ExplanationParameters getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ExplanationParameters> parser()
-
getParserForType
public com.google.protobuf.Parser<ExplanationParameters> 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 ExplanationParameters getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-