chore: update docs/dyn , add static discovery files to discovery_cache/documents (#1111)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/78f53313-0c78-4a29-8841-f031665a4c6a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/ml_v1.projects.locations.studies.trials.html b/docs/dyn/ml_v1.projects.locations.studies.trials.html
index 764514b..faf15e0 100644
--- a/docs/dyn/ml_v1.projects.locations.studies.trials.html
+++ b/docs/dyn/ml_v1.projects.locations.studies.trials.html
@@ -121,8 +121,8 @@
"measurement": { # A message representing a measurement. # Required. The measurement to be added to a trial.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
@@ -139,43 +139,43 @@
An object of the form:
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
}</pre>
</div>
@@ -200,23 +200,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>
@@ -235,18 +235,18 @@
The object takes the form of:
{ # The request message for the CompleteTrial service method.
- "infeasibleReason": "A String", # Optional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true.
- "trialInfeasible": True or False, # Optional. True if the trial cannot be run with the given Parameter, and final_measurement will be ignored.
"finalMeasurement": { # A message representing a measurement. # Optional. If provided, it will be used as the completed trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
+ "trialInfeasible": True or False, # Optional. True if the trial cannot be run with the given Parameter, and final_measurement will be ignored.
+ "infeasibleReason": "A String", # Optional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true.
}
x__xgafv: string, V1 error format.
@@ -258,43 +258,43 @@
An object of the form:
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
}</pre>
</div>
@@ -308,43 +308,43 @@
The object takes the form of:
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
}
x__xgafv: string, V1 error format.
@@ -356,43 +356,43 @@
An object of the form:
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
}</pre>
</div>
@@ -429,43 +429,43 @@
An object of the form:
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
}</pre>
</div>
@@ -486,43 +486,43 @@
{ # The response message for the ListTrials method.
"trials": [ # The trials associated with the study.
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
},
],
}</pre>
@@ -551,43 +551,43 @@
{ # The response message for the ListOptimalTrials method.
"trials": [ # The pareto-optimal trials for multiple objective study or the optimal trial for single objective study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
},
],
}</pre>
@@ -614,43 +614,43 @@
An object of the form:
{ # A message representing a trial.
- "state": "A String", # The detailed state of a trial.
- "startTime": "A String", # Output only. Time at which the trial was started.
- "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
- "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
- "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
- { # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
- "value": 3.14, # Required. The value for this metric.
- },
- ],
- "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
- "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
- },
- "parameters": [ # The parameters of the trial.
- { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
- "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
- "parameter": "A String", # The name of the parameter.
- "intValue": "A String", # Must be set if ParameterType is INTEGER
- "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
- },
- ],
+ "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
"measurements": [ # A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_time). These are used for early stopping computations.
{ # A message representing a measurement.
"metrics": [ # Provides a list of metrics that act as inputs into the objective function.
{ # A message representing a metric in the measurement.
- "metric": "A String", # Required. Metric name.
"value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
},
],
"stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
"elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
},
],
- "name": "A String", # Output only. Name of the trial assigned by the service.
"infeasibleReason": "A String", # Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true.
+ "parameters": [ # The parameters of the trial.
+ { # A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
+ "parameter": "A String", # The name of the parameter.
+ "intValue": "A String", # Must be set if ParameterType is INTEGER
+ "stringValue": "A String", # Must be set if ParameterTypeis CATEGORICAL
+ "floatValue": 3.14, # Must be set if ParameterType is DOUBLE or DISCRETE.
+ },
+ ],
+ "name": "A String", # Output only. Name of the trial assigned by the service.
+ "finalMeasurement": { # A message representing a measurement. # The final measurement containing the objective value.
+ "metrics": [ # Provides a list of metrics that act as inputs into the objective function.
+ { # A message representing a metric in the measurement.
+ "value": 3.14, # Required. The value for this metric.
+ "metric": "A String", # Required. Metric name.
+ },
+ ],
+ "stepCount": "A String", # The number of steps a machine learning model has been trained for. Must be non-negative.
+ "elapsedTime": "A String", # Output only. Time that the trial has been running at the point of this measurement.
+ },
"trialInfeasible": True or False, # Output only. If true, the parameters in this trial are not attempted again.
- "endTime": "A String", # Output only. Time at which the trial's status changed to COMPLETED.
+ "clientId": "A String", # Output only. The identifier of the client that originally requested this trial.
+ "state": "A String", # The detailed state of a trial.
+ "startTime": "A String", # Output only. Time at which the trial was started.
}</pre>
</div>
@@ -664,8 +664,8 @@
The object takes the form of:
{ # The request message for the SuggestTrial service method.
- "clientId": "A String", # Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same `client_id`, the service will return the identical suggested trial if the trial is pending, and provide a new trial if the last suggested trial was completed.
"suggestionCount": 42, # Required. The number of suggestions requested.
+ "clientId": "A String", # Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same `client_id`, the service will return the identical suggested trial if the trial is pending, and provide a new trial if the last suggested trial was completed.
}
x__xgafv: string, V1 error format.
@@ -677,23 +677,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
}</pre>
</div>