Class: Google::Apis::MlV1::GoogleCloudMlV1Model

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

Overview

Represents a machine learning solution. A model can have multiple versions, each of which is a deployed, trained model ready to receive prediction requests. The model itself is just a container.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudMlV1Model

Returns a new instance of GoogleCloudMlV1Model.



1572
1573
1574
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1572

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

Instance Attribute Details

#default_version ⇒ Google::Apis::MlV1::GoogleCloudMlV1Version

Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list. Corresponds to the JSON property defaultVersion

Returns:



1498
1499
1500
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1498

def default_version
  @default_version
end

#description ⇒ String

Optional. The description specified for the model when it was created. Corresponds to the JSON property description

Returns:

  • (String) 


1503
1504
1505
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1503

def description
  @description
end

#etag ⇒ String

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform model updates in order to avoid race conditions: An etag is returned in the response to GetModel, and systems are expected to put that etag in the request to UpdateModel to ensure that their change will be applied to the model as intended. Corresponds to the JSON property etag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1515
1516
1517
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1515

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1524
1525
1526
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1524

def labels
  @labels
end

#name ⇒ String

Required. The name specified for the model when it was created. The model name must be unique within the project it is created in. Corresponds to the JSON property name

Returns:

  • (String) 


1530
1531
1532
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1530

def name
  @name
end

#online_prediction_console_logging ⇒ Boolean Also known as: online_prediction_console_logging?

Optional. If true, online prediction nodes send stderr and stdout streams to Stackdriver Logging. These can be more verbose than the standard access logs (see onlinePredictionLogging) and can incur higher cost. However, they are helpful for debugging. Note that Stackdriver logs may incur a cost, especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false. Corresponds to the JSON property onlinePredictionConsoleLogging

Returns:

  • (Boolean) 


1542
1543
1544
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1542

def online_prediction_console_logging
  @online_prediction_console_logging
end

#online_prediction_logging ⇒ Boolean Also known as: online_prediction_logging?

Optional. If true, online prediction access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that Stackdriver logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false. Corresponds to the JSON property onlinePredictionLogging

Returns:

  • (Boolean) 


1554
1555
1556
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1554

def online_prediction_logging
  @online_prediction_logging
end

#regions ⇒ Array<String>

Optional. The list of regions where the model is going to be deployed. Currently only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the available regions for AI Platform services. Note:

  • No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction.
  • The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field. Corresponds to the JSON property regions

Returns:

  • (Array<String>) 


1570
1571
1572
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1570

def regions
  @regions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1577

def update!(**args)
  @default_version = args[:default_version] if args.key?(:default_version)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @online_prediction_console_logging = args[:online_prediction_console_logging] if args.key?(:online_prediction_console_logging)
  @online_prediction_logging = args[:online_prediction_logging] if args.key?(:online_prediction_logging)
  @regions = args[:regions] if args.key?(:regions)
end