google-cloud-automl 0.1.0

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/dataset.rb

@@ -0,0 +1,77 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Cloud
+    module AutoML
+      module V1beta1
+        # A workspace for solving a single, particular machine learning (ML) problem.
+        # A workspace contains examples that may be annotated.
+        # @!attribute [rw] translation_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TranslationDatasetMetadata]
+        #     Metadata for a dataset used for translation.
+        # @!attribute [rw] image_classification_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::ImageClassificationDatasetMetadata]
+        #     Metadata for a dataset used for image classification.
+        # @!attribute [rw] text_classification_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TextClassificationDatasetMetadata]
+        #     Metadata for a dataset used for text classification.
+        # @!attribute [rw] image_object_detection_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::ImageObjectDetectionDatasetMetadata]
+        #     Metadata for a dataset used for image object detection.
+        # @!attribute [rw] video_classification_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::VideoClassificationDatasetMetadata]
+        #     Metadata for a dataset used for video classification.
+        # @!attribute [rw] video_object_tracking_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::VideoObjectTrackingDatasetMetadata]
+        #     Metadata for a dataset used for video object tracking.
+        # @!attribute [rw] text_extraction_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TextExtractionDatasetMetadata]
+        #     Metadata for a dataset used for text extraction.
+        # @!attribute [rw] text_sentiment_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TextSentimentDatasetMetadata]
+        #     Metadata for a dataset used for text sentiment.
+        # @!attribute [rw] tables_dataset_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TablesDatasetMetadata]
+        #     Metadata for a dataset used for Tables.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Output only. The resource name of the dataset.
+        #     Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     Required. The name of the dataset to show in the interface. The name can be
+        #     up to 32 characters long and can consist only of ASCII Latin letters A-Z
+        #     and a-z, underscores
+        #     (_), and ASCII digits 0-9.
+        # @!attribute [rw] description
+        #   @return [String]
+        #     User-provided description of the dataset. The description can be up to
+        #     25000 characters long.
+        # @!attribute [rw] example_count
+        #   @return [Integer]
+        #     Output only. The number of examples in the dataset.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this dataset was created.
+        # @!attribute [rw] etag
+        #   @return [String]
+        #     Used to perform consistent read-modify-write updates. If not set, a blind
+        #     "overwrite" update happens.
+        class Dataset; end
+      end
+    end
+  end
+end

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/detection.rb

@@ -0,0 +1,134 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Cloud
+    module AutoML
+      module V1beta1
+        # Annotation details for image object detection.
+        # @!attribute [rw] bounding_box
+        #   @return [Google::Cloud::AutoML::V1beta1::BoundingPoly]
+        #     Output only.
+        #     The rectangle representing the object location.
+        # @!attribute [rw] score
+        #   @return [Float]
+        #     Output only.
+        #     The confidence that this annotation is positive for the parent example,
+        #     value in [0, 1], higher means higher positivity confidence.
+        class ImageObjectDetectionAnnotation; end
+
+        # Annotation details for video object tracking.
+        # @!attribute [rw] instance_id
+        #   @return [String]
+        #     Optional.
+        #     The instance of the object, expressed as a positive integer. Used to tell
+        #     apart objects of the same type (i.e. AnnotationSpec) when multiple are
+        #     present on a single example.
+        #     NOTE: Instance ID prediction quality is not a part of model evaluation and
+        #     is done as best effort. Especially in cases when an entity goes
+        #     off-screen for a longer time (minutes), when it comes back it may be given
+        #     a new instance ID.
+        # @!attribute [rw] time_offset
+        #   @return [Google::Protobuf::Duration]
+        #     Required. A time (frame) of a video to which this annotation pertains.
+        #     Represented as the duration since the video's start.
+        # @!attribute [rw] bounding_box
+        #   @return [Google::Cloud::AutoML::V1beta1::BoundingPoly]
+        #     Required. The rectangle representing the object location on the frame (i.e.
+        #     at the time_offset of the video).
+        # @!attribute [rw] score
+        #   @return [Float]
+        #     Output only.
+        #     The confidence that this annotation is positive for the video at
+        #     the time_offset, value in [0, 1], higher means higher positivity
+        #     confidence. For annotations created by the user the score is 1. When
+        #     user approves an annotation, the original float score is kept (and not
+        #     changed to 1).
+        class VideoObjectTrackingAnnotation; end
+
+        # Bounding box matching model metrics for a single intersection-over-union
+        # threshold and multiple label match confidence thresholds.
+        # @!attribute [rw] iou_threshold
+        #   @return [Float]
+        #     Output only. The intersection-over-union threshold value used to compute
+        #     this metrics entry.
+        # @!attribute [rw] mean_average_precision
+        #   @return [Float]
+        #     Output only. The mean average precision, most often close to au_prc.
+        # @!attribute [rw] confidence_metrics_entries
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::BoundingBoxMetricsEntry::ConfidenceMetricsEntry>]
+        #     Output only. Metrics for each label-match confidence_threshold from
+        #     0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is
+        #     derived from them.
+        class BoundingBoxMetricsEntry
+          # Metrics for a single confidence threshold.
+          # @!attribute [rw] confidence_threshold
+          #   @return [Float]
+          #     Output only. The confidence threshold value used to compute the metrics.
+          # @!attribute [rw] recall
+          #   @return [Float]
+          #     Output only. Recall under the given confidence threshold.
+          # @!attribute [rw] precision
+          #   @return [Float]
+          #     Output only. Precision under the given confidence threshold.
+          # @!attribute [rw] f1_score
+          #   @return [Float]
+          #     Output only. The harmonic mean of recall and precision.
+          class ConfidenceMetricsEntry; end
+        end
+
+        # Model evaluation metrics for image object detection problems.
+        # Evaluates prediction quality of labeled bounding boxes.
+        # @!attribute [rw] evaluated_bounding_box_count
+        #   @return [Integer]
+        #     Output only. The total number of bounding boxes (i.e. summed over all
+        #     images) the ground truth used to create this evaluation had.
+        # @!attribute [rw] bounding_box_metrics_entries
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::BoundingBoxMetricsEntry>]
+        #     Output only. The bounding boxes match metrics for each
+        #     Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99
+        #     and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99
+        #     pair.
+        # @!attribute [rw] bounding_box_mean_average_precision
+        #   @return [Float]
+        #     Output only. The single metric for bounding boxes evaluation:
+        #     the mean_average_precision averaged over all bounding_box_metrics_entries.
+        class ImageObjectDetectionEvaluationMetrics; end
+
+        # Model evaluation metrics for video object tracking problems.
+        # Evaluates prediction quality of both labeled bounding boxes and labeled
+        # tracks (i.e. series of bounding boxes sharing same label and instance ID).
+        # @!attribute [rw] evaluated_frame_count
+        #   @return [Integer]
+        #     Output only. The number of video frames used to create this evaluation.
+        # @!attribute [rw] evaluated_bounding_box_count
+        #   @return [Integer]
+        #     Output only. The total number of bounding boxes (i.e. summed over all
+        #     frames) the ground truth used to create this evaluation had.
+        # @!attribute [rw] bounding_box_metrics_entries
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::BoundingBoxMetricsEntry>]
+        #     Output only. The bounding boxes match metrics for each
+        #     Intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99
+        #     and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99
+        #     pair.
+        # @!attribute [rw] bounding_box_mean_average_precision
+        #   @return [Float]
+        #     Output only. The single metric for bounding boxes evaluation:
+        #     the mean_average_precision averaged over all bounding_box_metrics_entries.
+        class VideoObjectTrackingEvaluationMetrics; end
+      end
+    end
+  end
+end

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/geometry.rb

@@ -0,0 +1,43 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Cloud
+    module AutoML
+      module V1beta1
+        # A vertex represents a 2D point in the image.
+        # The normalized vertex coordinates are between 0 to 1 fractions relative to
+        # the original plane (image, video). E.g. if the plane (e.g. whole image) would
+        # have size 10 x 20 then a point with normalized coordinates (0.1, 0.3) would
+        # be at the position (1, 6) on that plane.
+        # @!attribute [rw] x
+        #   @return [Float]
+        #     Required. Horizontal coordinate.
+        # @!attribute [rw] y
+        #   @return [Float]
+        #     Required. Vertical coordinate.
+        class NormalizedVertex; end
+
+        # A bounding polygon of a detected object on a plane.
+        # On output both vertices and normalized_vertices are provided.
+        # The polygon is formed by connecting vertices in the order they are listed.
+        # @!attribute [rw] normalized_vertices
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::NormalizedVertex>]
+        #     Output only . The bounding polygon normalized vertices.
+        class BoundingPoly; end
+      end
+    end
+  end
+end

data/lib/google/cloud/automl/v1beta1/doc/google/cloud/automl/v1beta1/image.rb

@@ -0,0 +1,141 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Cloud
+    module AutoML
+      module V1beta1
+        # Dataset metadata that is specific to image classification.
+        # @!attribute [rw] classification_type
+        #   @return [Google::Cloud::AutoML::V1beta1::ClassificationType]
+        #     Required. Type of the classification problem.
+        class ImageClassificationDatasetMetadata; end
+
+        # Dataset metadata specific to image object detection.
+        class ImageObjectDetectionDatasetMetadata; end
+
+        # Model metadata for image classification.
+        # @!attribute [rw] base_model_id
+        #   @return [String]
+        #     Optional. The ID of the `base` model. If it is specified, the new model
+        #     will be created based on the `base` model. Otherwise, the new model will be
+        #     created from scratch. The `base` model must be in the same
+        #     `project` and `location` as the new model to create, and have the same
+        #     `model_type`.
+        # @!attribute [rw] train_budget
+        #   @return [Integer]
+        #     Required. The train budget of creating this model, expressed in hours. The
+        #     actual `train_cost` will be equal or less than this value.
+        # @!attribute [rw] train_cost
+        #   @return [Integer]
+        #     Output only. The actual train cost of creating this model, expressed in
+        #     hours. If this model is created from a `base` model, the train cost used
+        #     to create the `base` model are not included.
+        # @!attribute [rw] stop_reason
+        #   @return [String]
+        #     Output only. The reason that this create model operation stopped,
+        #     e.g. `BUDGET_REACHED`, `MODEL_CONVERGED`.
+        # @!attribute [rw] model_type
+        #   @return [String]
+        #     Optional. Type of the model. The available values are:
+        #     * `cloud` - Model to be used via prediction calls to AutoML API.
+        #       This is the default value.
+        #     * `mobile-low-latency-1` - A model that, in addition to providing
+        #       prediction via AutoML API, can also be exported (see
+        #       {Google::Cloud::AutoML::V1beta1::AutoML::ExportModel 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
+        #       {Google::Cloud::AutoML::V1beta1::AutoML::ExportModel 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
+        #       {Google::Cloud::AutoML::V1beta1::AutoML::ExportModel 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.
+        #     * `mobile-core-ml-low-latency-1` - A model that, in addition to providing
+        #       prediction via AutoML API, can also be exported (see
+        #       {Google::Cloud::AutoML::V1beta1::AutoML::ExportModel AutoML::ExportModel}) and used on a mobile device with Core
+        #       ML afterwards. Expected to have low latency, but may have
+        #       lower prediction quality than other models.
+        #     * `mobile-core-ml-versatile-1` - A model that, in addition to providing
+        #       prediction via AutoML API, can also be exported (see
+        #       {Google::Cloud::AutoML::V1beta1::AutoML::ExportModel AutoML::ExportModel}) and used on a mobile device with Core
+        #       ML afterwards.
+        #     * `mobile-core-ml-high-accuracy-1` - A model that, in addition to
+        #       providing prediction via AutoML API, can also be exported
+        #       (see {Google::Cloud::AutoML::V1beta1::AutoML::ExportModel AutoML::ExportModel}) and used on a mobile device with
+        #       Core ML afterwards.  Expected to have a higher latency, but
+        #       should also have a higher prediction quality than other
+        #       models.
+        class ImageClassificationModelMetadata; end
+
+        # Model metadata specific to image object detection.
+        # @!attribute [rw] model_type
+        #   @return [String]
+        #     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.
+        # @!attribute [rw] node_count
+        #   @return [Integer]
+        #     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.
+        # @!attribute [rw] node_qps
+        #   @return [Float]
+        #     Output only. An approximate number of online prediction QPS that can
+        #     be supported by this model per each node on which it is deployed.
+        # @!attribute [rw] stop_reason
+        #   @return [String]
+        #     Output only. The reason that this create model operation stopped,
+        #     e.g. `BUDGET_REACHED`, `MODEL_CONVERGED`.
+        # @!attribute [rw] train_budget_milli_node_hours
+        #   @return [Integer]
+        #     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. The train budget
+        #     must be between 20,000 and 2,000,000 milli node hours, inclusive. The
+        #     default value is 216, 000 which represents one day in wall time.
+        # @!attribute [rw] train_cost_milli_node_hours
+        #   @return [Integer]
+        #     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.
+        class ImageObjectDetectionModelMetadata; end
+
+        # Model deployment metadata specific to Image Object Detection.
+        # @!attribute [rw] node_count
+        #   @return [Integer]
+        #     Input only. The number of nodes to deploy the model on. A node is an
+        #     abstraction of a machine resource, which can handle online prediction QPS
+        #     as given in the model's
+        #
+        #     {Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata#qps_per_node qps_per_node}.
+        #     Must be between 1 and 100, inclusive on both ends.
+        class ImageObjectDetectionModelDeploymentMetadata; end
+      end
+    end
+  end
+end