Class ImageObjectDetectionModelMetadata

public final class ImageObjectDetectionModelMetadata extends GeneratedMessageV3 implements ImageObjectDetectionModelMetadataOrBuilder

Model metadata specific to image object detection.

Protobuf type google.cloud.automl.v1.ImageObjectDetectionModelMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ImageObjectDetectionModelMetadata

Static Fields

MODEL_TYPE_FIELD_NUMBER

public static final int MODEL_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_COUNT_FIELD_NUMBER

public static final int NODE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_QPS_FIELD_NUMBER

public static final int NODE_QPS_FIELD_NUMBER
Field Value
TypeDescription
int

STOP_REASON_FIELD_NUMBER

public static final int STOP_REASON_FIELD_NUMBER
Field Value
TypeDescription
int

TRAIN_BUDGET_MILLI_NODE_HOURS_FIELD_NUMBER

public static final int TRAIN_BUDGET_MILLI_NODE_HOURS_FIELD_NUMBER
Field Value
TypeDescription
int

TRAIN_COST_MILLI_NODE_HOURS_FIELD_NUMBER

public static final int TRAIN_COST_MILLI_NODE_HOURS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImageObjectDetectionModelMetadata getDefaultInstance()
Returns
TypeDescription
ImageObjectDetectionModelMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImageObjectDetectionModelMetadata.Builder newBuilder()
Returns
TypeDescription
ImageObjectDetectionModelMetadata.Builder

newBuilder(ImageObjectDetectionModelMetadata prototype)

public static ImageObjectDetectionModelMetadata.Builder newBuilder(ImageObjectDetectionModelMetadata prototype)
Parameter
NameDescription
prototypeImageObjectDetectionModelMetadata
Returns
TypeDescription
ImageObjectDetectionModelMetadata.Builder

parseDelimitedFrom(InputStream input)

public static ImageObjectDetectionModelMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImageObjectDetectionModelMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImageObjectDetectionModelMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImageObjectDetectionModelMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImageObjectDetectionModelMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImageObjectDetectionModelMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImageObjectDetectionModelMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImageObjectDetectionModelMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImageObjectDetectionModelMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImageObjectDetectionModelMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImageObjectDetectionModelMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImageObjectDetectionModelMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImageObjectDetectionModelMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImageObjectDetectionModelMetadata> parser()
Returns
TypeDescription
Parser<ImageObjectDetectionModelMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ImageObjectDetectionModelMetadata getDefaultInstanceForType()
Returns
TypeDescription
ImageObjectDetectionModelMetadata

getModelType()

public String getModelType()

Optional. Type of the model. The available values are:

  • cloud-high-accuracy-1 - (default) A model to be used via prediction calls to AutoML API. Expected to have a higher latency, but should also have a higher prediction quality than other models.
  • cloud-low-latency-1 - A model to be used via prediction calls to AutoML API. Expected to have low latency, but may have lower prediction quality than other models.
  • mobile-low-latency-1 - A model that, in addition to providing prediction via AutoML API, can also be exported (see AutoMl.ExportModel) and used on a mobile or edge device with TensorFlow afterwards. Expected to have low latency, but may have lower prediction quality than other models.
  • mobile-versatile-1 - A model that, in addition to providing prediction via AutoML API, can also be exported (see AutoMl.ExportModel) and used on a mobile or edge device with TensorFlow afterwards.
  • mobile-high-accuracy-1 - A model that, in addition to providing prediction via AutoML API, can also be exported (see AutoMl.ExportModel) and used on a mobile or edge device with TensorFlow afterwards. Expected to have a higher latency, but should also have a higher prediction quality than other models.

string model_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The modelType.

getModelTypeBytes()

public ByteString getModelTypeBytes()

Optional. Type of the model. The available values are:

  • cloud-high-accuracy-1 - (default) A model to be used via prediction calls to AutoML API. Expected to have a higher latency, but should also have a higher prediction quality than other models.
  • cloud-low-latency-1 - A model to be used via prediction calls to AutoML API. Expected to have low latency, but may have lower prediction quality than other models.
  • mobile-low-latency-1 - A model that, in addition to providing prediction via AutoML API, can also be exported (see AutoMl.ExportModel) and used on a mobile or edge device with TensorFlow afterwards. Expected to have low latency, but may have lower prediction quality than other models.
  • mobile-versatile-1 - A model that, in addition to providing prediction via AutoML API, can also be exported (see AutoMl.ExportModel) and used on a mobile or edge device with TensorFlow afterwards.
  • mobile-high-accuracy-1 - A model that, in addition to providing prediction via AutoML API, can also be exported (see AutoMl.ExportModel) and used on a mobile or edge device with TensorFlow afterwards. Expected to have a higher latency, but should also have a higher prediction quality than other models.

string model_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for modelType.

getNodeCount()

public long getNodeCount()

Output only. The number of nodes this model is deployed on. A node is an abstraction of a machine resource, which can handle online prediction QPS as given in the qps_per_node field.

int64 node_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
long

The nodeCount.

getNodeQps()

public double getNodeQps()

Output only. An approximate number of online prediction QPS that can be supported by this model per each node on which it is deployed.

double node_qps = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
double

The nodeQps.

getParserForType()

public Parser<ImageObjectDetectionModelMetadata> getParserForType()
Returns
TypeDescription
Parser<ImageObjectDetectionModelMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStopReason()

public String getStopReason()

Output only. The reason that this create model operation stopped, e.g. BUDGET_REACHED, MODEL_CONVERGED.

string stop_reason = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The stopReason.

getStopReasonBytes()

public ByteString getStopReasonBytes()

Output only. The reason that this create model operation stopped, e.g. BUDGET_REACHED, MODEL_CONVERGED.

string stop_reason = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for stopReason.

getTrainBudgetMilliNodeHours()

public long getTrainBudgetMilliNodeHours()

Optional. The train budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual train_cost will be equal or less than this value. If further model training ceases to provide any improvements, it will stop without using full budget and the stop_reason will be MODEL_CONVERGED. Note, node_hour = actual_hour * number_of_nodes_invovled. For model type cloud-high-accuracy-1(default) and cloud-low-latency-1, the train budget must be between 20,000 and 900,000 milli node hours, inclusive. The default value is 216, 000 which represents one day in wall time. For model type mobile-low-latency-1, mobile-versatile-1, mobile-high-accuracy-1, mobile-core-ml-low-latency-1, mobile-core-ml-versatile-1, mobile-core-ml-high-accuracy-1, the train budget must be between 1,000 and 100,000 milli node hours, inclusive. The default value is 24, 000 which represents one day in wall time.

int64 train_budget_milli_node_hours = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
long

The trainBudgetMilliNodeHours.

getTrainCostMilliNodeHours()

public long getTrainCostMilliNodeHours()

Output only. The actual train cost of creating this model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget.

int64 train_cost_milli_node_hours = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
long

The trainCostMilliNodeHours.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ImageObjectDetectionModelMetadata.Builder newBuilderForType()
Returns
TypeDescription
ImageObjectDetectionModelMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImageObjectDetectionModelMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImageObjectDetectionModelMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ImageObjectDetectionModelMetadata.Builder toBuilder()
Returns
TypeDescription
ImageObjectDetectionModelMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException