Package-level declarations
Types
Represents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about /ml-engine/docs/using-gpus and /ml-engine/docs/machine-types-online-prediction#gpus.
Configuration for Automated Early Stopping of Trials. If no implementation_config is set, automated early stopping will not be run.
Options for automatically scaling a model.
Represents output related to a built-in algorithm Job.
Represents a network port in a single container. This message is a subset of the Kubernetes ContainerPort v1 core specification.
Specification of a custom container for serving predictions. This message is a subset of the Kubernetes Container v1 core specification.
Represents the config of disk options.
Represents a custom encryption key configuration that can be applied to a resource.
Represents an environment variable to be made available in a container. This message is a subset of the Kubernetes EnvVar v1 core specification.
Message holding configuration options for explaining model predictions. There are three feature attribution methods supported for TensorFlow models: integrated gradients, sampled Shapley, and XRAI. /ai-platform/prediction/docs/ai-explanations/overview
Represents the result of a single hyperparameter tuning trial from a training job. The TrainingOutput object that is returned on successful completion of a training job with hyperparameter tuning includes a list of HyperparameterOutput objects, one for each successful trial.
Represents a set of hyperparameters to optimize.
Attributes credit by computing the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
Options for manually scaling a model.
A message representing a measurement.
MetricSpec contains the specifications to use to calculate the desired nodes count when autoscaling is enabled.
Represents input parameters for a prediction job.
Represents results of a prediction job.
Represents the configuration for a replica in a cluster.
Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by /bigquery/quotas. If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using /ml-engine/docs/continuous-evaluation/, you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs.
Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read /ai-platform/prediction/docs/custom-container-requirements for details on how to create your container image to meet these requirements.
An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.
All parameters related to scheduling of training jobs.
Represents configuration of a study.
Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to /ai-platform/training/docs/training-jobs.
Represents results of a training job. Output only.
Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list.
Attributes credit by computing the XRAI taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Currently only implemented for models with natural image inputs.
The median automated stopping rule stops a pending trial if the trial's best objective_value is strictly below the median 'performance' of all completed trials reported up to the trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the trial in each measurement.
An observed value of a metric.
A message representing a metric in the measurement.
Represents a metric to optimize.
Represents a single parameter to optimize.
Represents the spec to match categorical values from parent parameter.
Represents the spec to match discrete values from parent parameter.
Represents the spec to match integer values from parent parameter.
A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial.
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices
and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com
from DATA_READ logging, and aliya@example.com
from DATA_WRITE logging.
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Associates members
, or principals, with a role
.
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.