Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1ModelMonitor

Returns a new instance of GoogleCloudAiplatformV1beta1ModelMonitor.



18862
18863
18864
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18862

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when this ModelMonitor was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


18793
18794
18795
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18793

def create_time
  @create_time
end

#display_name ⇒ String

The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8. Corresponds to the JSON property displayName

Returns:

  • (String) 


18799
18800
18801
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18799

def display_name
  @display_name
end

#explanation_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplanationSpec

Specification of Model explanation. Corresponds to the JSON property explanationSpec

Returns:



18804
18805
18806
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18804

def explanation_spec
  @explanation_spec
end

#model_monitoring_schema ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringSchema

The Model Monitoring Schema definition. Corresponds to the JSON property modelMonitoringSchema

Returns:



18809
18810
18811
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18809

def model_monitoring_schema
  @model_monitoring_schema
end

#model_monitoring_target ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitorModelMonitoringTarget

The monitoring target refers to the entity that is subject to analysis. e.g. Vertex AI Model version. Corresponds to the JSON property modelMonitoringTarget

Returns:



18815
18816
18817
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18815

def model_monitoring_target
  @model_monitoring_target
end

#name ⇒ String

Immutable. Resource name of the ModelMonitor. Format: projects/project/ locations/location/modelMonitors/model_monitor`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


18821
18822
18823
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18821

def name
  @name
end

#notification_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpec

Notification spec(email, notification channel) for model monitoring statistics/ alerts. Corresponds to the JSON property notificationSpec

Returns:



18827
18828
18829
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18827

def notification_spec
  @notification_spec
end

#output_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec

Specification for the export destination of monitoring results, including metrics, logs, etc. Corresponds to the JSON property outputSpec

Returns:



18833
18834
18835
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18833

def output_spec
  @output_spec
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


18838
18839
18840
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18838

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


18844
18845
18846
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18844

def satisfies_pzs
  @satisfies_pzs
end

#tabular_objective ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective

Tabular monitoring objective. Corresponds to the JSON property tabularObjective

Returns:



18850
18851
18852
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18850

def tabular_objective
  @tabular_objective
end

#training_dataset ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringInput

Model monitoring data input spec. Corresponds to the JSON property trainingDataset

Returns:



18855
18856
18857
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18855

def training_dataset
  @training_dataset
end

#update_time ⇒ String

Output only. Timestamp when this ModelMonitor was updated most recently. Corresponds to the JSON property updateTime

Returns:

  • (String) 


18860
18861
18862
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18860

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18867

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @explanation_spec = args[:explanation_spec] if args.key?(:explanation_spec)
  @model_monitoring_schema = args[:model_monitoring_schema] if args.key?(:model_monitoring_schema)
  @model_monitoring_target = args[:model_monitoring_target] if args.key?(:model_monitoring_target)
  @name = args[:name] if args.key?(:name)
  @notification_spec = args[:notification_spec] if args.key?(:notification_spec)
  @output_spec = args[:output_spec] if args.key?(:output_spec)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @tabular_objective = args[:tabular_objective] if args.key?(:tabular_objective)
  @training_dataset = args[:training_dataset] if args.key?(:training_dataset)
  @update_time = args[:update_time] if args.key?(:update_time)
end