Class protos.google.cloud.aiplatform.v1beta1.ExplanationParameters (3.11.0)

Represents an ExplanationParameters.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.IExplanationParameters);

Constructs a new ExplanationParameters.

Parameter
NameDescription
properties IExplanationParameters

Properties to set

Properties

examples

public examples?: (google.cloud.aiplatform.v1beta1.IExamples|null);

ExplanationParameters examples.

integratedGradientsAttribution

public integratedGradientsAttribution?: (google.cloud.aiplatform.v1beta1.IIntegratedGradientsAttribution|null);

ExplanationParameters integratedGradientsAttribution.

method

public method?: ("sampledShapleyAttribution"|"integratedGradientsAttribution"|"xraiAttribution"|"examples");

ExplanationParameters method.

outputIndices

public outputIndices?: (google.protobuf.IListValue|null);

ExplanationParameters outputIndices.

sampledShapleyAttribution

public sampledShapleyAttribution?: (google.cloud.aiplatform.v1beta1.ISampledShapleyAttribution|null);

ExplanationParameters sampledShapleyAttribution.

topK

public topK: number;

ExplanationParameters topK.

xraiAttribution

public xraiAttribution?: (google.cloud.aiplatform.v1beta1.IXraiAttribution|null);

ExplanationParameters xraiAttribution.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.IExplanationParameters): google.cloud.aiplatform.v1beta1.ExplanationParameters;

Creates a new ExplanationParameters instance using the specified properties.

Parameter
NameDescription
properties IExplanationParameters

Properties to set

Returns
TypeDescription
ExplanationParameters

ExplanationParameters instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1beta1.ExplanationParameters;

Decodes an ExplanationParameters message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
ExplanationParameters

ExplanationParameters

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.ExplanationParameters;

Decodes an ExplanationParameters message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ExplanationParameters

ExplanationParameters

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1beta1.IExplanationParameters, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ExplanationParameters message. Does not implicitly messages.

Parameters
NameDescription
message IExplanationParameters

ExplanationParameters message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1beta1.IExplanationParameters, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ExplanationParameters message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IExplanationParameters

ExplanationParameters message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1beta1.ExplanationParameters;

Creates an ExplanationParameters message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
ExplanationParameters

ExplanationParameters

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ExplanationParameters

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this ExplanationParameters to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1beta1.ExplanationParameters, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an ExplanationParameters message. Also converts values to other types if specified.

Parameters
NameDescription
message ExplanationParameters

ExplanationParameters

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an ExplanationParameters message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not