google-cloud-automl 0.1.0

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

@@ -0,0 +1,92 @@
+# 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
+        # API proto representing a trained machine learning model.
+        # @!attribute [rw] translation_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TranslationModelMetadata]
+        #     Metadata for translation models.
+        # @!attribute [rw] image_classification_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::ImageClassificationModelMetadata]
+        #     Metadata for image classification models.
+        # @!attribute [rw] text_classification_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TextClassificationModelMetadata]
+        #     Metadata for text classification models.
+        # @!attribute [rw] image_object_detection_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::ImageObjectDetectionModelMetadata]
+        #     Metadata for image object detection models.
+        # @!attribute [rw] video_classification_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::VideoClassificationModelMetadata]
+        #     Metadata for video classification models.
+        # @!attribute [rw] video_object_tracking_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::VideoObjectTrackingModelMetadata]
+        #     Metadata for video object tracking models.
+        # @!attribute [rw] text_extraction_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TextExtractionModelMetadata]
+        #     Metadata for text extraction models.
+        # @!attribute [rw] tables_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TablesModelMetadata]
+        #     Metadata for Tables models.
+        # @!attribute [rw] text_sentiment_model_metadata
+        #   @return [Google::Cloud::AutoML::V1beta1::TextSentimentModelMetadata]
+        #     Metadata for text sentiment models.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Output only.
+        #     Resource name of the model.
+        #     Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     Required. The name of the model 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. It must start with a letter.
+        # @!attribute [rw] dataset_id
+        #   @return [String]
+        #     Required.
+        #     The resource ID of the dataset used to create the model. The dataset must
+        #     come from the same ancestor project and location.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only.
+        #     Timestamp when the model training finished  and can be used for prediction.
+        # @!attribute [rw] update_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only.
+        #     Timestamp when this model was last updated.
+        # @!attribute [rw] deployment_state
+        #   @return [Google::Cloud::AutoML::V1beta1::Model::DeploymentState]
+        #     Output only. Deployment state of the model. A model can only serve
+        #     prediction requests after it gets deployed.
+        class Model
+          # Deployment state of the model.
+          module DeploymentState
+            # Should not be used, an un-set enum has this value by default.
+            DEPLOYMENT_STATE_UNSPECIFIED = 0
+
+            # Model is deployed.
+            DEPLOYED = 1
+
+            # Model is not deployed.
+            UNDEPLOYED = 2
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# 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
+        # Evaluation results of a model.
+        # @!attribute [rw] classification_evaluation_metrics
+        #   @return [Google::Cloud::AutoML::V1beta1::ClassificationEvaluationMetrics]
+        #     Model evaluation metrics for image, text, video and tables
+        #     classification.
+        #     Tables problem is considered a classification when the target column
+        #     is CATEGORY DataType.
+        # @!attribute [rw] regression_evaluation_metrics
+        #   @return [Google::Cloud::AutoML::V1beta1::RegressionEvaluationMetrics]
+        #     Model evaluation metrics for Tables regression.
+        #     Tables problem is considered a regression when the target column
+        #     has FLOAT64 DataType.
+        # @!attribute [rw] translation_evaluation_metrics
+        #   @return [Google::Cloud::AutoML::V1beta1::TranslationEvaluationMetrics]
+        #     Model evaluation metrics for translation.
+        # @!attribute [rw] image_object_detection_evaluation_metrics
+        #   @return [Google::Cloud::AutoML::V1beta1::ImageObjectDetectionEvaluationMetrics]
+        #     Model evaluation metrics for image object detection.
+        # @!attribute [rw] video_object_tracking_evaluation_metrics
+        #   @return [Google::Cloud::AutoML::V1beta1::VideoObjectTrackingEvaluationMetrics]
+        #     Model evaluation metrics for video object tracking.
+        # @!attribute [rw] text_sentiment_evaluation_metrics
+        #   @return [Google::Cloud::AutoML::V1beta1::TextSentimentEvaluationMetrics]
+        #     Evaluation metrics for text sentiment models.
+        # @!attribute [rw] text_extraction_evaluation_metrics
+        #   @return [Google::Cloud::AutoML::V1beta1::TextExtractionEvaluationMetrics]
+        #     Evaluation metrics for text extraction models.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Output only.
+        #     Resource name of the model evaluation.
+        #     Format:
+        #
+        #     `projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}`
+        # @!attribute [rw] annotation_spec_id
+        #   @return [String]
+        #     Output only.
+        #     The ID of the annotation spec that the model evaluation applies to. The
+        #     The ID is empty for the overall model evaluation.
+        #     For Tables annotation specs in the dataset do not exist and this ID is
+        #     always not set, but for CLASSIFICATION
+        #
+        #     {Google::Cloud::AutoML::V1beta1::TablesModelMetadata#prediction_type prediction_type-s}
+        #     the
+        #     {Google::Cloud::AutoML::V1beta1::ModelEvaluation#display_name display_name}
+        #     field is used.
+        # @!attribute [rw] display_name
+        #   @return [String]
+        #     Output only. The value of
+        #     {Google::Cloud::AutoML::V1beta1::AnnotationSpec#dispay_name display_name} at
+        #     the moment when the model was trained. Because this field returns a value
+        #     at model training time, for different models trained from the same dataset,
+        #     the values may differ, since display names could had been changed between
+        #     the two model's trainings.
+        #     For Tables CLASSIFICATION
+        #
+        #     {Google::Cloud::AutoML::V1beta1::TablesModelMetadata#prediction_type prediction_type-s}
+        #     distinct values of the target column at the moment of the model evaluation
+        #     are populated here.
+        #     The display_name is empty for the overall model evaluation.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only.
+        #     Timestamp when this model evaluation was created.
+        # @!attribute [rw] evaluated_example_count
+        #   @return [Integer]
+        #     Output only.
+        #     The number of examples used for model evaluation, i.e. for
+        #     which ground truth from time of model creation is compared against the
+        #     predicted annotations created by the model.
+        #     For overall ModelEvaluation (i.e. with annotation_spec_id not set) this is
+        #     the total number of all examples used for evaluation.
+        #     Otherwise, this is the count of examples that according to the ground
+        #     truth were annotated by the
+        #
+        #     {Google::Cloud::AutoML::V1beta1::ModelEvaluation#annotation_spec_id annotation_spec_id}.
+        class ModelEvaluation; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# 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
+        # Request message for {Google::Cloud::AutoML::V1beta1::PredictionService::Predict PredictionService::Predict}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Name of the model requested to serve the prediction.
+        # @!attribute [rw] payload
+        #   @return [Google::Cloud::AutoML::V1beta1::ExamplePayload]
+        #     Required.
+        #     Payload to perform a prediction on. The payload must match the
+        #     problem type that the model was trained to solve.
+        # @!attribute [rw] params
+        #   @return [Hash{String => String}]
+        #     Additional domain-specific parameters, any string must be up to 25000
+        #     characters long.
+        #
+        #     * For Image Classification:
+        #
+        #       `score_threshold` - (float) A value from 0.0 to 1.0. When the model
+        #       makes predictions for an image, it will only produce results that have
+        #       at least this confidence score. The default is 0.5.
+        #     * For Tables:
+        #       `feature_importance` - (boolean) Whether
+        #
+        #     [feature_importance][[google.cloud.automl.v1beta1.TablesModelColumnInfo.feature_importance]
+        #            should be populated in the returned
+        #
+        #     [TablesAnnotation(-s)][[google.cloud.automl.v1beta1.TablesAnnotation].
+        #            The default is false.
+        class PredictRequest; end
+
+        # Response message for {Google::Cloud::AutoML::V1beta1::PredictionService::Predict PredictionService::Predict}.
+        # @!attribute [rw] payload
+        #   @return [Array<Google::Cloud::AutoML::V1beta1::AnnotationPayload>]
+        #     Prediction result.
+        #     Translation and Text Sentiment will return precisely one payload.
+        # @!attribute [rw] metadata
+        #   @return [Hash{String => String}]
+        #     Additional domain-specific prediction response metadata.
+        #
+        #     * For Image Object Detection:
+        #       `max_bounding_box_count` - (int64) At most that many bounding boxes per
+        #       image could have been returned.
+        #
+        #     * For Text Sentiment:
+        #       `sentiment_score` - (float, deprecated) A value between -1 and 1,
+        #       -1 maps to least positive sentiment, while 1 maps to the most positive
+        #       one and the higher the score, the more positive the sentiment in the
+        #       document is. Yet these values are relative to the training data, so
+        #       e.g. if all data was positive then -1 will be also positive (though
+        #       the least).
+        #       The sentiment_score shouldn't be confused with "score" or "magnitude"
+        #       from the previous Natural Language Sentiment Analysis API.
+        class PredictResponse; end
+
+        # Request message for {Google::Cloud::AutoML::V1beta1::PredictionService::BatchPredict PredictionService::BatchPredict}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Name of the model requested to serve the batch prediction.
+        # @!attribute [rw] input_config
+        #   @return [Google::Cloud::AutoML::V1beta1::BatchPredictInputConfig]
+        #     Required. The input configuration for batch prediction.
+        # @!attribute [rw] output_config
+        #   @return [Google::Cloud::AutoML::V1beta1::BatchPredictOutputConfig]
+        #     Required. The Configuration specifying where output predictions should
+        #     be written.
+        # @!attribute [rw] params
+        #   @return [Hash{String => String}]
+        #     Additional domain-specific parameters for the predictions, any string must
+        #     be up to 25000 characters long.
+        #
+        #     * For Video Classification :
+        #       `score_threshold` - (float) A value from 0.0 to 1.0. When the model
+        #       makes predictions for a video, it will only produce results that
+        #       have at least this confidence score. The default is 0.5.
+        #       `segment_classification` - (boolean) Set to true to request
+        #       segment-level classification. AutoML Video Intelligence returns
+        #       labels and their confidence scores for the entire segment of the
+        #       video that user specified in the request configuration.
+        #       The default is "true".
+        #       `shot_classification` - (boolean) Set to true to request shot-level
+        #       classification. AutoML Video Intelligence determines the boundaries
+        #       for each camera shot in the entire segment of the video that user
+        #       specified in the request configuration. AutoML Video Intelligence
+        #       then returns labels and their confidence scores for each detected
+        #       shot, along with the start and end time of the shot.
+        #       WARNING: Model evaluation is not done for this classification type,
+        #       the quality of it depends on training data, but there are no metrics
+        #       provided to describe that quality. The default is "false".
+        #       `1s_interval_classification` - (boolean) Set to true to request
+        #       classification for a video at one-second intervals. AutoML Video
+        #       Intelligence returns labels and their confidence scores for each
+        #       second of the entire segment of the video that user specified in the
+        #       request configuration.
+        #       WARNING: Model evaluation is not done for this classification
+        #       type, the quality of it depends on training data, but there are no
+        #       metrics provided to describe that quality. The default is
+        #       "false".
+        #
+        #     * For Video Object Tracking:
+        #       `score_threshold` - (float) When Model detects objects on video frames,
+        #       it will only produce bounding boxes which have at least this
+        #       confidence score. Value in 0 to 1 range, default is 0.5.
+        #       `max_bounding_box_count` - (int64) No more than this number of bounding
+        #       boxes will be returned per frame. Default is 100, the requested
+        #       value may be limited by server.
+        #       `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
+        #       at least that long as a relative value of video frame size will be
+        #       returned. Value in 0 to 1 range. Default is 0.
+        class BatchPredictRequest; end
+
+        # Result of the Batch Predict. This message is returned in
+        # {Google::Longrunning::Operation#response response} of the operation returned
+        # by the {Google::Cloud::AutoML::V1beta1::PredictionService::BatchPredict PredictionService::BatchPredict}.
+        class BatchPredictResult; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# 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 range between two double numbers.
+        # @!attribute [rw] start
+        #   @return [Float]
+        #     Start of the range, inclusive.
+        # @!attribute [rw] end
+        #   @return [Float]
+        #     End of the range, exclusive.
+        class DoubleRange; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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
+        # Metrics for regression problems.
+        # @!attribute [rw] root_mean_squared_error
+        #   @return [Float]
+        #     Output only. Root Mean Squared Error (RMSE).
+        # @!attribute [rw] mean_absolute_error
+        #   @return [Float]
+        #     Output only. Mean Absolute Error (MAE).
+        # @!attribute [rw] mean_absolute_percentage_error
+        #   @return [Float]
+        #     Output only. Mean absolute percentage error. Only set if all ground truth
+        #     values are are positive.
+        # @!attribute [rw] r_squared
+        #   @return [Float]
+        #     Output only. R squared.
+        # @!attribute [rw] root_mean_squared_log_error
+        #   @return [Float]
+        #     Output only. Root mean squared log error.
+        class RegressionEvaluationMetrics; end
+      end
+    end
+  end
+end