Class protos.google.cloud.aiplatform.v1.ModelEvaluation (3.4.0)

Represents a ModelEvaluation.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IModelEvaluation);

Constructs a new ModelEvaluation.

Parameter
NameDescription
properties IModelEvaluation

Properties to set

Properties

annotationSchemaUri

public annotationSchemaUri: string;

ModelEvaluation annotationSchemaUri.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

ModelEvaluation createTime.

dataItemSchemaUri

public dataItemSchemaUri: string;

ModelEvaluation dataItemSchemaUri.

displayName

public displayName: string;

ModelEvaluation displayName.

explanationSpecs

public explanationSpecs: google.cloud.aiplatform.v1.ModelEvaluation.IModelEvaluationExplanationSpec[];

ModelEvaluation explanationSpecs.

metadata

public metadata?: (google.protobuf.IValue|null);

ModelEvaluation metadata.

metrics

public metrics?: (google.protobuf.IValue|null);

ModelEvaluation metrics.

metricsSchemaUri

public metricsSchemaUri: string;

ModelEvaluation metricsSchemaUri.

modelExplanation

public modelExplanation?: (google.cloud.aiplatform.v1.IModelExplanation|null);

ModelEvaluation modelExplanation.

name

public name: string;

ModelEvaluation name.

sliceDimensions

public sliceDimensions: string[];

ModelEvaluation sliceDimensions.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IModelEvaluation): google.cloud.aiplatform.v1.ModelEvaluation;

Creates a new ModelEvaluation instance using the specified properties.

Parameter
NameDescription
properties IModelEvaluation

Properties to set

Returns
TypeDescription
ModelEvaluation

ModelEvaluation instance

decode(reader, length)

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

Decodes a ModelEvaluation 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
ModelEvaluation

ModelEvaluation

decodeDelimited(reader)

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

Decodes a ModelEvaluation message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ModelEvaluation

ModelEvaluation

encode(message, writer)

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

Encodes the specified ModelEvaluation message. Does not implicitly messages.

Parameters
NameDescription
message IModelEvaluation

ModelEvaluation 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.v1.IModelEvaluation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IModelEvaluation

ModelEvaluation 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.v1.ModelEvaluation;

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

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

Plain object

Returns
TypeDescription
ModelEvaluation

ModelEvaluation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ModelEvaluation

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 ModelEvaluation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ModelEvaluation

ModelEvaluation

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a ModelEvaluation 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