Class SampledShapleyAttribution (3.11.0)

public final class SampledShapleyAttribution extends GeneratedMessageV3 implements SampledShapleyAttributionOrBuilder

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.

Protobuf type google.cloud.aiplatform.v1beta1.SampledShapleyAttribution

Static Fields

PATH_COUNT_FIELD_NUMBER

public static final int PATH_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SampledShapleyAttribution getDefaultInstance()
Returns
TypeDescription
SampledShapleyAttribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SampledShapleyAttribution.Builder newBuilder()
Returns
TypeDescription
SampledShapleyAttribution.Builder

newBuilder(SampledShapleyAttribution prototype)

public static SampledShapleyAttribution.Builder newBuilder(SampledShapleyAttribution prototype)
Parameter
NameDescription
prototypeSampledShapleyAttribution
Returns
TypeDescription
SampledShapleyAttribution.Builder

parseDelimitedFrom(InputStream input)

public static SampledShapleyAttribution parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SampledShapleyAttribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SampledShapleyAttribution parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SampledShapleyAttribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SampledShapleyAttribution parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SampledShapleyAttribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SampledShapleyAttribution parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SampledShapleyAttribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SampledShapleyAttribution parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SampledShapleyAttribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SampledShapleyAttribution parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SampledShapleyAttribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SampledShapleyAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SampledShapleyAttribution> parser()
Returns
TypeDescription
Parser<SampledShapleyAttribution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SampledShapleyAttribution getDefaultInstanceForType()
Returns
TypeDescription
SampledShapleyAttribution

getParserForType()

public Parser<SampledShapleyAttribution> getParserForType()
Returns
TypeDescription
Parser<SampledShapleyAttribution>
Overrides

getPathCount()

public int getPathCount()

Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.

int32 path_count = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The pathCount.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SampledShapleyAttribution.Builder newBuilderForType()
Returns
TypeDescription
SampledShapleyAttribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SampledShapleyAttribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SampledShapleyAttribution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SampledShapleyAttribution.Builder toBuilder()
Returns
TypeDescription
SampledShapleyAttribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException