Represents a TuningJob.
Package
@google-cloud/aiplatformConstructors
(constructor)(properties)
constructor(properties?: google.cloud.aiplatform.v1.ITuningJob);Constructs a new TuningJob.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITuningJob
Properties to set |
Properties
baseModel
public baseModel?: (string|null);TuningJob baseModel.
createTime
public createTime?: (google.protobuf.ITimestamp|null);TuningJob createTime.
description
public description: string;TuningJob description.
encryptionSpec
public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);TuningJob encryptionSpec.
endTime
public endTime?: (google.protobuf.ITimestamp|null);TuningJob endTime.
error
public error?: (google.rpc.IStatus|null);TuningJob error.
evaluateDatasetRuns
public evaluateDatasetRuns: google.cloud.aiplatform.v1.IEvaluateDatasetRun[];TuningJob evaluateDatasetRuns.
experiment
public experiment: string;TuningJob experiment.
labels
public labels: { [k: string]: string };TuningJob labels.
name
public name: string;TuningJob name.
preTunedModel
public preTunedModel?: (google.cloud.aiplatform.v1.IPreTunedModel|null);TuningJob preTunedModel.
serviceAccount
public serviceAccount: string;TuningJob serviceAccount.
sourceModel
public sourceModel?: ("baseModel"|"preTunedModel");TuningJob sourceModel.
startTime
public startTime?: (google.protobuf.ITimestamp|null);TuningJob startTime.
state
public state: (google.cloud.aiplatform.v1.JobState|keyof typeof google.cloud.aiplatform.v1.JobState);TuningJob state.
supervisedTuningSpec
public supervisedTuningSpec?: (google.cloud.aiplatform.v1.ISupervisedTuningSpec|null);TuningJob supervisedTuningSpec.
tunedModel
public tunedModel?: (google.cloud.aiplatform.v1.ITunedModel|null);TuningJob tunedModel.
tunedModelDisplayName
public tunedModelDisplayName: string;TuningJob tunedModelDisplayName.
tuningDataStats
public tuningDataStats?: (google.cloud.aiplatform.v1.ITuningDataStats|null);TuningJob tuningDataStats.
tuningSpec
public tuningSpec?: "supervisedTuningSpec";TuningJob tuningSpec.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);TuningJob updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.aiplatform.v1.ITuningJob): google.cloud.aiplatform.v1.TuningJob;Creates a new TuningJob instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITuningJob
Properties to set |
| Returns | |
|---|---|
| Type | Description |
TuningJob |
TuningJob instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.TuningJob;Decodes a TuningJob message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
TuningJob |
TuningJob |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.TuningJob;Decodes a TuningJob message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
TuningJob |
TuningJob |
encode(message, writer)
public static encode(message: google.cloud.aiplatform.v1.ITuningJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TuningJob message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITuningJob
TuningJob message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.aiplatform.v1.ITuningJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified TuningJob message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITuningJob
TuningJob message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.TuningJob;Creates a TuningJob message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
TuningJob |
TuningJob |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for TuningJob
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this TuningJob to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.aiplatform.v1.TuningJob, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a TuningJob message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
TuningJob
TuningJob |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a TuningJob message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|