REST Resource: projects.locations.nasJobs

Resource: NasJob

Represents a Neural Architecture Search (NAS) job.

Fields
name string

Output only. Resource name of the NasJob.

displayName string

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

nasJobSpec object (NasJobSpec)

Required. The specification of a NasJob.

nasJobOutput object (NasJobOutput)

Output only. Output of the NasJob.

state enum (JobState)

Output only. The detailed state of the job.

createTime string (Timestamp format)

Output only. time when the NasJob was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

startTime string (Timestamp format)

Output only. time when the NasJob for the first time entered the JOB_STATE_RUNNING state.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime string (Timestamp format)

Output only. time when the NasJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Output only. time when the NasJob was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

error object (Status)

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

labels map (key: string, value: string)

The labels with user-defined metadata to organize NasJobs.

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.

encryptionSpec object (EncryptionSpec)

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

enableRestrictedImageTraining
(deprecated) boolean

Optional. Enable a separation of Custom model training and restricted image training for tenant project.

satisfiesPzs boolean

Output only. reserved for future use.

satisfiesPzi boolean

Output only. reserved for future use.

JSON representation 
{
  "name": string,
  "displayName": string,
  "nasJobSpec": {
    object (NasJobSpec)
  },
  "nasJobOutput": {
    object (NasJobOutput)
  },
  "state": enum (JobState),
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "error": {
    object (Status)
  },
  "labels": {
    string: string,
    ...
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  },
  "enableRestrictedImageTraining": boolean,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}

NasJobSpec

Represents the spec of a NasJob.

Fields
resumeNasJobId string

The id of the existing NasJob in the same Project and Location which will be used to resume search. searchSpaceSpec and nas_algorithm_spec are obtained from previous NasJob hence should not provide them again for this NasJob.

searchSpaceSpec string

It defines the search space for Neural Architecture Search (NAS).

Union field nas_algorithm_spec. The Neural Architecture Search (NAS) algorithm specification. nas_algorithm_spec can be only one of the following:
multiTrialAlgorithmSpec object (MultiTrialAlgorithmSpec)

The spec of multi-trial algorithms.

JSON representation 
{
  "resumeNasJobId": string,
  "searchSpaceSpec": string,

  // Union field nas_algorithm_spec can be only one of the following:
  "multiTrialAlgorithmSpec": {
    object (MultiTrialAlgorithmSpec)
  }
  // End of list of possible types for union field nas_algorithm_spec.
}

MultiTrialAlgorithmSpec

The spec of multi-trial Neural Architecture Search (NAS).

Fields
multiTrialAlgorithm enum (MultiTrialAlgorithm)

The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to REINFORCEMENT_LEARNING.

metric object (MetricSpec)

Metric specs for the NAS job. Validation for this field is done at multiTrialAlgorithmSpec field.

searchTrialSpec object (SearchTrialSpec)

Required. Spec for search trials.

trainTrialSpec object (TrainTrialSpec)

Spec for train trials. top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.

JSON representation 
{
  "multiTrialAlgorithm": enum (MultiTrialAlgorithm),
  "metric": {
    object (MetricSpec)
  },
  "searchTrialSpec": {
    object (SearchTrialSpec)
  },
  "trainTrialSpec": {
    object (TrainTrialSpec)
  }
}

MultiTrialAlgorithm

The available types of multi-trial algorithms.

Enums
MULTI_TRIAL_ALGORITHM_UNSPECIFIED Defaults to REINFORCEMENT_LEARNING.
REINFORCEMENT_LEARNING The Reinforcement Learning algorithm for Multi-trial Neural Architecture Search (NAS).

MetricSpec

Represents a metric to optimize.

Fields
metricId string

Required. The id of the metric. Must not contain whitespaces.

goal enum (GoalType)

Required. The optimization goal of the metric.

JSON representation 
{
  "metricId": string,
  "goal": enum (GoalType)
}

GoalType

The available types of optimization goals.

Enums
GOAL_TYPE_UNSPECIFIED Goal type will default to maximize.
MAXIMIZE Maximize the goal metric.
MINIMIZE Minimize the goal metric.

SearchTrialSpec

Represent spec for search trials.

Fields
searchTrialJobSpec object (CustomJobSpec)

Required. The spec of a search trial job. The same spec applies to all search trials.

maxTrialCount integer

Required. The maximum number of Neural Architecture Search (NAS) trials to run.

maxParallelTrialCount integer

Required. The maximum number of trials to run in parallel.

maxFailedTrialCount integer

The number of failed trials that need to be seen before failing the NasJob.

If set to 0, Vertex AI decides how many trials must fail before the whole job fails.

JSON representation 
{
  "searchTrialJobSpec": {
    object (CustomJobSpec)
  },
  "maxTrialCount": integer,
  "maxParallelTrialCount": integer,
  "maxFailedTrialCount": integer
}

TrainTrialSpec

Represent spec for train trials.

Fields
trainTrialJobSpec object (CustomJobSpec)

Required. The spec of a train trial job. The same spec applies to all train trials.

maxParallelTrialCount integer

Required. The maximum number of trials to run in parallel.

frequency integer

Required. Frequency of search trials to start train stage. top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.

JSON representation 
{
  "trainTrialJobSpec": {
    object (CustomJobSpec)
  },
  "maxParallelTrialCount": integer,
  "frequency": integer
}

NasJobOutput

Represents a uCAIP NasJob output.

Fields
Union field output. The output of this Neural Architecture Search (NAS) job. output can be only one of the following:
multiTrialJobOutput object (MultiTrialJobOutput)

Output only. The output of this multi-trial Neural Architecture Search (NAS) job.

JSON representation 
{

  // Union field output can be only one of the following:
  "multiTrialJobOutput": {
    object (MultiTrialJobOutput)
  }
  // End of list of possible types for union field output.
}

MultiTrialJobOutput

The output of a multi-trial Neural Architecture Search (NAS) jobs.

Fields
searchTrials[] object (NasTrial)

Output only. List of NasTrials that were started as part of search stage.

trainTrials[] object (NasTrial)

Output only. List of NasTrials that were started as part of train stage.

JSON representation 
{
  "searchTrials": [
    {
      object (NasTrial)
    }
  ],
  "trainTrials": [
    {
      object (NasTrial)
    }
  ]
}

Methods

cancel

 Cancels a NasJob.

create

 Creates a NasJob

delete

 Deletes a NasJob.

get

 Gets a NasJob

list

 Lists NasJobs in a Location.