Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

feat: add display_name and metadata to ModelEvaluation in aiplatform model_evaluation.proto #297

Merged
merged 6 commits into from
May 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions protos/google/cloud/aiplatform/v1/model_evaluation.proto
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ message ModelEvaluation {
// Output only. The resource name of the ModelEvaluation.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// The display name of the ModelEvaluation.
string display_name = 10;

// Points to a YAML file stored on Google Cloud Storage describing the
// [metrics][google.cloud.aiplatform.v1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is
// defined as an OpenAPI 3.0.2 [Schema
Expand Down Expand Up @@ -104,4 +107,10 @@ message ModelEvaluation {
// Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] that are used for explaining
// the predicted values on the evaluated data.
repeated ModelEvaluationExplanationSpec explanation_specs = 9;

// The metadata of the ModelEvaluation.
// For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
// structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
// "evaluation_dataset_path".
google.protobuf.Value metadata = 11;
}
9 changes: 9 additions & 0 deletions protos/google/cloud/aiplatform/v1beta1/model_evaluation.proto
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ message ModelEvaluation {
// Output only. The resource name of the ModelEvaluation.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// The display name of the ModelEvaluation.
string display_name = 10;

// Points to a YAML file stored on Google Cloud Storage describing the
// [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this ModelEvaluation. The schema is
// defined as an OpenAPI 3.0.2 [Schema
Expand Down Expand Up @@ -82,4 +85,10 @@ message ModelEvaluation {
// Describes the values of [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are used for explaining
// the predicted values on the evaluated data.
repeated ModelEvaluationExplanationSpec explanation_specs = 9;

// The metadata of the ModelEvaluation.
// For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
// structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
// "evaluation_dataset_path".
google.protobuf.Value metadata = 11;
}
21 changes: 21 additions & 0 deletions protos/google/cloud/aiplatform/v1beta1/pipeline_job.proto
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,27 @@ message PipelineJob {
string network = 18 [(google.api.resource_reference) = {
type: "compute.googleapis.com/Network"
}];

// A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1beta1.PipelineJob.pipeline_spec], if empty, will
// be downloaded.
string template_uri = 19;

// Output only. Pipeline template metadata. Will fill up fields if
// [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported template registry.
PipelineTemplateMetadata template_metadata = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Pipeline template metadata if [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is from supported
// template registry. Currently, the only supported registry is Artifact
// Registry.
message PipelineTemplateMetadata {
// The version_name in artifact registry.
//
// Will always be presented in output if the [PipelineJob.template_uri][google.cloud.aiplatform.v1beta1.PipelineJob.template_uri] is
// from supported template registry.
//
// Format is "sha256:abcdef123456...".
string version = 3;
}

// The runtime detail of PipelineJob.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ import "google/cloud/aiplatform/v1beta1/schema/geometry.proto";
import "google/protobuf/duration.proto";
import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
option java_multiple_files = true;
option java_outer_classname = "AnnotationPayloadProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema";

// Annotation details specific to image classification.
message ImageClassificationAnnotation {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1.schema;
import "google/type/color.proto";
import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
option java_multiple_files = true;
option java_outer_classname = "AnnotationSpecColorProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema";

// An entry of mapping between color and AnnotationSpec. The mapping is used in
// segmentation mask.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ import "google/api/field_behavior.proto";
import "google/protobuf/duration.proto";
import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
option java_multiple_files = true;
option java_outer_classname = "DataItemPayloadProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema";

// Payload of Image DataItem.
message ImageDataItem {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
option java_multiple_files = true;
option java_outer_classname = "DatasetMetadataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema";

// The metadata of Datasets that contain Image DataItems.
message ImageDatasetMetadata {
Expand Down
3 changes: 3 additions & 0 deletions protos/google/cloud/aiplatform/v1beta1/schema/geometry.proto
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema;schema";
option java_multiple_files = true;
option java_outer_classname = "GeometryProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema";

// A vertex represents a 2D point in the image.
// NOTE: the normalized vertex coordinates are relative to the original image
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "ImageClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Image Classification.
message ImageClassificationPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Image Object Detection.
message ImageObjectDetectionPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Image Segmentation.
message ImageSegmentationPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "TextClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Text Classification.
message TextClassificationPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "TextExtractionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Text Extraction.
message TextExtractionPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "TextSentimentPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Text Sentiment.
message TextSentimentPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Video Action Recognition.
message VideoActionRecognitionPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Video Classification.
message VideoClassificationPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.instance;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Instance";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/instance;instance";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionInstanceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.instance";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Instance";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Instance";

// Prediction input format for Video Object Tracking.
message VideoObjectTrackingPredictionInstance {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
option java_multiple_files = true;
option java_outer_classname = "ImageClassificationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Params";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Params";

// Prediction model parameters for Image Classification.
message ImageClassificationPredictionParams {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
option java_multiple_files = true;
option java_outer_classname = "ImageObjectDetectionPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Params";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Params";

// Prediction model parameters for Image Object Detection.
message ImageObjectDetectionPredictionParams {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
option java_multiple_files = true;
option java_outer_classname = "ImageSegmentationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Params";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Params";

// Prediction model parameters for Image Segmentation.
message ImageSegmentationPredictionParams {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
option java_multiple_files = true;
option java_outer_classname = "VideoActionRecognitionPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Params";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Params";

// Prediction model parameters for Video Action Recognition.
message VideoActionRecognitionPredictionParams {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
option java_multiple_files = true;
option java_outer_classname = "VideoClassificationPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Params";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Params";

// Prediction model parameters for Video Classification.
message VideoClassificationPredictionParams {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.params;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Params";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/params;params";
option java_multiple_files = true;
option java_outer_classname = "VideoObjectTrackingPredictionParamsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.params";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Params";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Params";

// Prediction model parameters for Video Object Tracking.
message VideoObjectTrackingPredictionParams {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1.schema.predict.prediction;

import "google/api/annotations.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1.Schema.Predict.Prediction";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1/schema/predict/prediction;prediction";
option java_multiple_files = true;
option java_outer_classname = "ClassificationPredictionResultProto";
option java_package = "com.google.cloud.aiplatform.v1beta1.schema.predict.prediction";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1\\Schema\\Predict\\Prediction";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1::Schema::Predict::Prediction";

// Prediction output format for Image and Text Classification.
message ClassificationPredictionResult {
Expand Down
Loading