com.google.cloud.automl.v1beta1.ModelExportOutputConfigOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-automl-v1beta1 Show documentation
Show all versions of proto-google-cloud-automl-v1beta1 Show documentation
PROTO library for proto-google-cloud-automl-v1beta1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/automl/v1beta1/io.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.automl.v1beta1;
public interface ModelExportOutputConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.automl.v1beta1.ModelExportOutputConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The Google Cloud Storage location where the model is to be written to.
* This location may only be set for the following model formats:
* "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml".
*
* Under the directory given as the destination a new one with name
* "model-export-<model-display-name>-<timestamp-of-export-call>",
* where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format,
* will be created. Inside the model and any of its supporting files
* will be written.
*
*
* .google.cloud.automl.v1beta1.GcsDestination gcs_destination = 1;
*
* @return Whether the gcsDestination field is set.
*/
boolean hasGcsDestination();
/**
*
*
*
* The Google Cloud Storage location where the model is to be written to.
* This location may only be set for the following model formats:
* "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml".
*
* Under the directory given as the destination a new one with name
* "model-export-<model-display-name>-<timestamp-of-export-call>",
* where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format,
* will be created. Inside the model and any of its supporting files
* will be written.
*
*
* .google.cloud.automl.v1beta1.GcsDestination gcs_destination = 1;
*
* @return The gcsDestination.
*/
com.google.cloud.automl.v1beta1.GcsDestination getGcsDestination();
/**
*
*
*
* The Google Cloud Storage location where the model is to be written to.
* This location may only be set for the following model formats:
* "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml".
*
* Under the directory given as the destination a new one with name
* "model-export-<model-display-name>-<timestamp-of-export-call>",
* where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format,
* will be created. Inside the model and any of its supporting files
* will be written.
*
*
* .google.cloud.automl.v1beta1.GcsDestination gcs_destination = 1;
*/
com.google.cloud.automl.v1beta1.GcsDestinationOrBuilder getGcsDestinationOrBuilder();
/**
*
*
*
* The GCR location where model image is to be pushed to. This location
* may only be set for the following model formats:
* "docker".
*
* The model image will be created under the given URI.
*
*
* .google.cloud.automl.v1beta1.GcrDestination gcr_destination = 3;
*
* @return Whether the gcrDestination field is set.
*/
boolean hasGcrDestination();
/**
*
*
*
* The GCR location where model image is to be pushed to. This location
* may only be set for the following model formats:
* "docker".
*
* The model image will be created under the given URI.
*
*
* .google.cloud.automl.v1beta1.GcrDestination gcr_destination = 3;
*
* @return The gcrDestination.
*/
com.google.cloud.automl.v1beta1.GcrDestination getGcrDestination();
/**
*
*
*
* The GCR location where model image is to be pushed to. This location
* may only be set for the following model formats:
* "docker".
*
* The model image will be created under the given URI.
*
*
* .google.cloud.automl.v1beta1.GcrDestination gcr_destination = 3;
*/
com.google.cloud.automl.v1beta1.GcrDestinationOrBuilder getGcrDestinationOrBuilder();
/**
*
*
*
* The format in which the model must be exported. The available, and default,
* formats depend on the problem and model type (if given problem and type
* combination doesn't have a format listed, it means its models are not
* exportable):
*
* * For Image Classification mobile-low-latency-1, mobile-versatile-1,
* mobile-high-accuracy-1:
* "tflite" (default), "edgetpu_tflite", "tf_saved_model", "tf_js",
* "docker".
*
* * For Image Classification mobile-core-ml-low-latency-1,
* mobile-core-ml-versatile-1, mobile-core-ml-high-accuracy-1:
* "core_ml" (default).
*
* * For Image Object Detection mobile-low-latency-1, mobile-versatile-1,
* mobile-high-accuracy-1:
* "tflite", "tf_saved_model", "tf_js".
*
* * For Video Classification cloud,
* "tf_saved_model".
*
* * For Video Object Tracking cloud,
* "tf_saved_model".
*
* * For Video Object Tracking mobile-versatile-1:
* "tflite", "edgetpu_tflite", "tf_saved_model", "docker".
*
* * For Video Object Tracking mobile-coral-versatile-1:
* "tflite", "edgetpu_tflite", "docker".
*
* * For Video Object Tracking mobile-coral-low-latency-1:
* "tflite", "edgetpu_tflite", "docker".
*
* * For Video Object Tracking mobile-jetson-versatile-1:
* "tf_saved_model", "docker".
*
* * For Tables:
* "docker".
*
* Formats description:
*
* * tflite - Used for Android mobile devices.
* * edgetpu_tflite - Used for [Edge TPU](https://cloud.google.com/edge-tpu/)
* devices.
* * tf_saved_model - A tensorflow model in SavedModel format.
* * tf_js - A [TensorFlow.js](https://www.tensorflow.org/js) model that can
* be used in the browser and in Node.js using JavaScript.
* * docker - Used for Docker containers. Use the params field to customize
* the container. The container is verified to work correctly on
* ubuntu 16.04 operating system. See more at
* [containers
*
* quickstart](https:
* //cloud.google.com/vision/automl/docs/containers-gcs-quickstart)
* * core_ml - Used for iOS mobile devices.
*
*
* string model_format = 4;
*
* @return The modelFormat.
*/
java.lang.String getModelFormat();
/**
*
*
*
* The format in which the model must be exported. The available, and default,
* formats depend on the problem and model type (if given problem and type
* combination doesn't have a format listed, it means its models are not
* exportable):
*
* * For Image Classification mobile-low-latency-1, mobile-versatile-1,
* mobile-high-accuracy-1:
* "tflite" (default), "edgetpu_tflite", "tf_saved_model", "tf_js",
* "docker".
*
* * For Image Classification mobile-core-ml-low-latency-1,
* mobile-core-ml-versatile-1, mobile-core-ml-high-accuracy-1:
* "core_ml" (default).
*
* * For Image Object Detection mobile-low-latency-1, mobile-versatile-1,
* mobile-high-accuracy-1:
* "tflite", "tf_saved_model", "tf_js".
*
* * For Video Classification cloud,
* "tf_saved_model".
*
* * For Video Object Tracking cloud,
* "tf_saved_model".
*
* * For Video Object Tracking mobile-versatile-1:
* "tflite", "edgetpu_tflite", "tf_saved_model", "docker".
*
* * For Video Object Tracking mobile-coral-versatile-1:
* "tflite", "edgetpu_tflite", "docker".
*
* * For Video Object Tracking mobile-coral-low-latency-1:
* "tflite", "edgetpu_tflite", "docker".
*
* * For Video Object Tracking mobile-jetson-versatile-1:
* "tf_saved_model", "docker".
*
* * For Tables:
* "docker".
*
* Formats description:
*
* * tflite - Used for Android mobile devices.
* * edgetpu_tflite - Used for [Edge TPU](https://cloud.google.com/edge-tpu/)
* devices.
* * tf_saved_model - A tensorflow model in SavedModel format.
* * tf_js - A [TensorFlow.js](https://www.tensorflow.org/js) model that can
* be used in the browser and in Node.js using JavaScript.
* * docker - Used for Docker containers. Use the params field to customize
* the container. The container is verified to work correctly on
* ubuntu 16.04 operating system. See more at
* [containers
*
* quickstart](https:
* //cloud.google.com/vision/automl/docs/containers-gcs-quickstart)
* * core_ml - Used for iOS mobile devices.
*
*
* string model_format = 4;
*
* @return The bytes for modelFormat.
*/
com.google.protobuf.ByteString getModelFormatBytes();
/**
*
*
*
* Additional model-type and format specific parameters describing the
* requirements for the to be exported model files, any string must be up to
* 25000 characters long.
*
* * For `docker` format:
* `cpu_architecture` - (string) "x86_64" (default).
* `gpu_architecture` - (string) "none" (default), "nvidia".
*
*
* map<string, string> params = 2;
*/
int getParamsCount();
/**
*
*
*
* Additional model-type and format specific parameters describing the
* requirements for the to be exported model files, any string must be up to
* 25000 characters long.
*
* * For `docker` format:
* `cpu_architecture` - (string) "x86_64" (default).
* `gpu_architecture` - (string) "none" (default), "nvidia".
*
*
* map<string, string> params = 2;
*/
boolean containsParams(java.lang.String key);
/** Use {@link #getParamsMap()} instead. */
@java.lang.Deprecated
java.util.Map getParams();
/**
*
*
*
* Additional model-type and format specific parameters describing the
* requirements for the to be exported model files, any string must be up to
* 25000 characters long.
*
* * For `docker` format:
* `cpu_architecture` - (string) "x86_64" (default).
* `gpu_architecture` - (string) "none" (default), "nvidia".
*
*
* map<string, string> params = 2;
*/
java.util.Map getParamsMap();
/**
*
*
*
* Additional model-type and format specific parameters describing the
* requirements for the to be exported model files, any string must be up to
* 25000 characters long.
*
* * For `docker` format:
* `cpu_architecture` - (string) "x86_64" (default).
* `gpu_architecture` - (string) "none" (default), "nvidia".
*
*
* map<string, string> params = 2;
*/
/* nullable */
java.lang.String getParamsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Additional model-type and format specific parameters describing the
* requirements for the to be exported model files, any string must be up to
* 25000 characters long.
*
* * For `docker` format:
* `cpu_architecture` - (string) "x86_64" (default).
* `gpu_architecture` - (string) "none" (default), "nvidia".
*
*
* map<string, string> params = 2;
*/
java.lang.String getParamsOrThrow(java.lang.String key);
com.google.cloud.automl.v1beta1.ModelExportOutputConfig.DestinationCase getDestinationCase();
}