GoogleCloudAiplatformV1HyperparameterTuningJob

import type { GoogleCloudAiplatformV1HyperparameterTuningJob } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

interface GoogleCloudAiplatformV1HyperparameterTuningJob {

readonly createTime?: Date;

displayName?: string;

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;

readonly endTime?: Date;

readonly error?: GoogleRpcStatus;

labels?: {

[key: string]: string;

};

maxFailedTrialCount?: number;

maxTrialCount?: number;

readonly name?: string;

parallelTrialCount?: number;

readonly startTime?: Date;

readonly state?:

| "JOB_STATE_UNSPECIFIED"

| "JOB_STATE_QUEUED"

| "JOB_STATE_PENDING"

| "JOB_STATE_RUNNING"

| "JOB_STATE_SUCCEEDED"

| "JOB_STATE_FAILED"

| "JOB_STATE_CANCELLING"

| "JOB_STATE_CANCELLED"

| "JOB_STATE_PAUSED"

| "JOB_STATE_EXPIRED"

| "JOB_STATE_UPDATING"

| "JOB_STATE_PARTIALLY_SUCCEEDED";

studySpec?: GoogleCloudAiplatformV1StudySpec;

trialJobSpec?: GoogleCloudAiplatformV1CustomJobSpec;

readonly trials?: GoogleCloudAiplatformV1Trial[];

readonly updateTime?: Date;

}

§Properties

readonly createTime?: Date

[src]

Output only. Time when the HyperparameterTuningJob was created.

displayName?: string

[src]

Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec

[src]

Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.

readonly endTime?: Date

[src]

Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

readonly error?: GoogleRpcStatus

[src]

Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

labels?: {

[key: string]: string;

}

[src]

The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

maxFailedTrialCount?: number

[src]

The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.

maxTrialCount?: number

[src]

Required. The desired total number of Trials.

readonly name?: string

[src]

Output only. Resource name of the HyperparameterTuningJob.

parallelTrialCount?: number

[src]

Required. The desired number of Trials to run in parallel.

readonly startTime?: Date

[src]

Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.