| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="aiplatform_v1.html">Vertex AI API</a> . <a href="aiplatform_v1.projects.html">projects</a> . <a href="aiplatform_v1.projects.locations.html">locations</a> . <a href="aiplatform_v1.projects.locations.nasJobs.html">nasJobs</a> . <a href="aiplatform_v1.projects.locations.nasJobs.nasTrialDetails.html">nasTrialDetails</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets a NasTrialDetail.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">List top NasTrialDetails of a NasJob.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>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. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>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. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next()</code> | |
| <pre>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. | |
| </pre> | |
| </div> | |
| </body></html> |