public final class ExplanationParameters extends com.google.protobuf.GeneratedMessageV3 implements ExplanationParametersOrBuilder
Parameters to configure explaining for Model's predictions.Protobuf type
google.cloud.aiplatform.v1beta1.ExplanationParameters| Modifier and Type | Class and Description |
|---|---|
static class |
ExplanationParameters.Builder
Parameters to configure explaining for Model's predictions.
|
static class |
ExplanationParameters.MethodCase |
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| Modifier and Type | Field and 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 |
| Modifier and Type | Method and 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.v1beta1.Attribution.output_index]
contained in output_indices.
|
com.google.protobuf.ListValueOrBuilder |
getOutputIndicesOrBuilder()
If populated, only returns attributions that have
[output_index][google.cloud.aiplatform.v1beta1.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.v1beta1.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(ByteBuffer data) |
static ExplanationParameters |
parseFrom(ByteBuffer 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 com.google.protobuf.Parser<ExplanationParameters> |
parser() |
ExplanationParameters.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int SAMPLED_SHAPLEY_ATTRIBUTION_FIELD_NUMBER
public static final int INTEGRATED_GRADIENTS_ATTRIBUTION_FIELD_NUMBER
public static final int XRAI_ATTRIBUTION_FIELD_NUMBER
public static final int EXAMPLES_FIELD_NUMBER
public static final int TOP_K_FIELD_NUMBER
public static final int OUTPUT_INDICES_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public ExplanationParameters.MethodCase getMethodCase()
getMethodCase in interface ExplanationParametersOrBuilderpublic 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.v1beta1.SampledShapleyAttribution sampled_shapley_attribution = 1;
hasSampledShapleyAttribution in interface ExplanationParametersOrBuilderpublic 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.v1beta1.SampledShapleyAttribution sampled_shapley_attribution = 1;
getSampledShapleyAttribution in interface ExplanationParametersOrBuilderpublic 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.v1beta1.SampledShapleyAttribution sampled_shapley_attribution = 1;
getSampledShapleyAttributionOrBuilder in interface ExplanationParametersOrBuilderpublic 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.v1beta1.IntegratedGradientsAttribution integrated_gradients_attribution = 2;
hasIntegratedGradientsAttribution in interface ExplanationParametersOrBuilderpublic 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.v1beta1.IntegratedGradientsAttribution integrated_gradients_attribution = 2;
getIntegratedGradientsAttribution in interface ExplanationParametersOrBuilderpublic 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.v1beta1.IntegratedGradientsAttribution integrated_gradients_attribution = 2;
getIntegratedGradientsAttributionOrBuilder in interface ExplanationParametersOrBuilderpublic 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.v1beta1.XraiAttribution xrai_attribution = 3;hasXraiAttribution in interface ExplanationParametersOrBuilderpublic 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.v1beta1.XraiAttribution xrai_attribution = 3;getXraiAttribution in interface ExplanationParametersOrBuilderpublic 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.v1beta1.XraiAttribution xrai_attribution = 3;getXraiAttributionOrBuilder in interface ExplanationParametersOrBuilderpublic boolean hasExamples()
Example-based explanations that returns the nearest neighbors from the provided dataset.
.google.cloud.aiplatform.v1beta1.Examples examples = 7;hasExamples in interface ExplanationParametersOrBuilderpublic Examples getExamples()
Example-based explanations that returns the nearest neighbors from the provided dataset.
.google.cloud.aiplatform.v1beta1.Examples examples = 7;getExamples in interface ExplanationParametersOrBuilderpublic ExamplesOrBuilder getExamplesOrBuilder()
Example-based explanations that returns the nearest neighbors from the provided dataset.
.google.cloud.aiplatform.v1beta1.Examples examples = 7;getExamplesOrBuilder in interface ExplanationParametersOrBuilderpublic 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;getTopK in interface ExplanationParametersOrBuilderpublic boolean hasOutputIndices()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1beta1.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.v1beta1.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;hasOutputIndices in interface ExplanationParametersOrBuilderpublic com.google.protobuf.ListValue getOutputIndices()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1beta1.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.v1beta1.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;getOutputIndices in interface ExplanationParametersOrBuilderpublic com.google.protobuf.ListValueOrBuilder getOutputIndicesOrBuilder()
If populated, only returns attributions that have [output_index][google.cloud.aiplatform.v1beta1.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.v1beta1.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;getOutputIndicesOrBuilder in interface ExplanationParametersOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ExplanationParameters parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationParameters parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationParameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationParameters parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationParameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationParameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExplanationParameters parseFrom(InputStream input) throws IOException
IOExceptionpublic static ExplanationParameters parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExplanationParameters parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ExplanationParameters parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExplanationParameters parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ExplanationParameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ExplanationParameters.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ExplanationParameters.Builder newBuilder()
public static ExplanationParameters.Builder newBuilder(ExplanationParameters prototype)
public ExplanationParameters.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ExplanationParameters.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ExplanationParameters getDefaultInstance()
public static com.google.protobuf.Parser<ExplanationParameters> parser()
public com.google.protobuf.Parser<ExplanationParameters> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ExplanationParameters getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.