Vertex AI API . projects . locations . nasJobs . nasTrialDetails

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets a NasTrialDetail.

Args:
  name: string, Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a NasTrial details along with its parameters. If there is a corresponding train NasTrial, the train NasTrial is also returned.
  "name": "A String", # Output only. Resource name of the NasTrialDetail.
  "parameters": "A String", # The parameters for the NasJob NasTrial.
  "searchTrial": { # Represents a uCAIP NasJob trial. # The requested search NasTrial.
    "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
    "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
      "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
      "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
        { # A message representing a metric in the measurement.
          "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
          "value": 3.14, # Output only. The value for this metric.
        },
      ],
      "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
    },
    "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
    "startTime": "A String", # Output only. Time when the NasTrial was started.
    "state": "A String", # Output only. The detailed state of the NasTrial.
  },
  "trainTrial": { # Represents a uCAIP NasJob trial. # The train NasTrial corresponding to search_trial. Only populated if search_trial is used for training.
    "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
    "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
      "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
      "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
        { # A message representing a metric in the measurement.
          "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
          "value": 3.14, # Output only. The value for this metric.
        },
      ],
      "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
    },
    "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
    "startTime": "A String", # Output only. Time when the NasTrial was started.
    "state": "A String", # Output only. The detailed state of the NasTrial.
  },
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

List top NasTrialDetails of a NasJob.

Args:
  parent: string, Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}` (required)
  pageSize: integer, The standard list page size.
  pageToken: string, The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for JobService.ListNasTrialDetails
  "nasTrialDetails": [ # List of top NasTrials in the requested page.
    { # Represents a NasTrial details along with its parameters. If there is a corresponding train NasTrial, the train NasTrial is also returned.
      "name": "A String", # Output only. Resource name of the NasTrialDetail.
      "parameters": "A String", # The parameters for the NasJob NasTrial.
      "searchTrial": { # Represents a uCAIP NasJob trial. # The requested search NasTrial.
        "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
        "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
          "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
          "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
            { # A message representing a metric in the measurement.
              "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
              "value": 3.14, # Output only. The value for this metric.
            },
          ],
          "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
        },
        "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
        "startTime": "A String", # Output only. Time when the NasTrial was started.
        "state": "A String", # Output only. The detailed state of the NasTrial.
      },
      "trainTrial": { # Represents a uCAIP NasJob trial. # The train NasTrial corresponding to search_trial. Only populated if search_trial is used for training.
        "endTime": "A String", # Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.
        "finalMeasurement": { # A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. # Output only. The final measurement containing the objective value.
          "elapsedDuration": "A String", # Output only. Time that the Trial has been running at the point of this Measurement.
          "metrics": [ # Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.
            { # A message representing a metric in the measurement.
              "metricId": "A String", # Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.
              "value": 3.14, # Output only. The value for this metric.
            },
          ],
          "stepCount": "A String", # Output only. The number of steps the machine learning model has been trained for. Must be non-negative.
        },
        "id": "A String", # Output only. The identifier of the NasTrial assigned by the service.
        "startTime": "A String", # Output only. Time when the NasTrial was started.
        "state": "A String", # Output only. The detailed state of the NasTrial.
      },
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListNasTrialDetailsRequest.page_token to obtain that page.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.