Class: Google::Apis::MlV1::GoogleCloudMlV1Version

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 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.

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) ⇒ GoogleCloudMlV1Version

Returns a new instance of GoogleCloudMlV1Version.



2031
2032
2033
 
# File 'generated/google/apis/ml_v1/classes.rb', line 2031

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

Instance Attribute Details

#accelerator_config ⇒ Google::Apis::MlV1::GoogleCloudMlV1AcceleratorConfig

Represents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about accelerators for training and accelerators for online prediction. Corresponds to the JSON property acceleratorConfig

Returns:



1777
1778
1779
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1777

def accelerator_config
  @accelerator_config
end

#auto_scaling ⇒ Google::Apis::MlV1::GoogleCloudMlV1AutoScaling

Options for automatically scaling a model. Corresponds to the JSON property autoScaling

Returns:



1782
1783
1784
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1782

def auto_scaling
  @auto_scaling
end

#create_time ⇒ String

Output only. The time the version was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1787
1788
1789
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1787

def create_time
  @create_time
end

#deployment_uri ⇒ String

Required. The Cloud Storage location of the trained model used to create the version. See the guide to model deployment for more information. When passing Version to projects.models.versions.create the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000. Corresponds to the JSON property deploymentUri

Returns:

  • (String) 


1802
1803
1804
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1802

def deployment_uri
  @deployment_uri
end

#description ⇒ String

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

Returns:

  • (String) 


1807
1808
1809
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1807

def description
  @description
end

#error_message ⇒ String

Output only. The details of a failure or a cancellation. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


1812
1813
1814
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1812

def error_message
  @error_message
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 GetVersion, and systems are expected to put that etag in the request to UpdateVersion 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) 


1824
1825
1826
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1824

def etag
  @etag
end

#explanation_config ⇒ Google::Apis::MlV1::GoogleCloudMlV1ExplanationConfig

Message holding configuration options for explaining model predictions. There are two feature attribution methods supported for TensorFlow models: integrated gradients and sampled Shapley. Learn more about feature attributions. Corresponds to the JSON property explanationConfig

Returns:



1833
1834
1835
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1833

def explanation_config
  @explanation_config
end

#framework ⇒ String

Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are TENSORFLOW, SCIKIT_LEARN, XGBOOST. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose SCIKIT_LEARN or XGBOOST, you must also set the runtime version of the model to 1.4 or greater. Do not specify a framework if you're deploying a custom prediction routine. If you specify a Compute Engine (N1) machine type in the machineType field, you must specify TENSORFLOW for the framework. Corresponds to the JSON property framework

Returns:

  • (String) 


1849
1850
1851
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1849

def framework
  @framework
end

#is_default ⇒ Boolean Also known as: is_default?

Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


1857
1858
1859
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1857

def is_default
  @is_default
end

#labels ⇒ Hash<String,String>

Optional. One or more labels that you can add, to organize your model versions. 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>) 


1867
1868
1869
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1867

def labels
  @labels
end

#last_use_time ⇒ String

Output only. The time the version was last used for prediction. Corresponds to the JSON property lastUseTime

Returns:

  • (String) 


1872
1873
1874
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1872

def last_use_time
  @last_use_time
end

#machine_type ⇒ String

Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. If this field is not specified, it defaults to mls1-c1-m2. Online prediction supports the following machine types:

  • mls1-c1-m2
  • mls1-c4-m2
  • n1-standard-2
  • n1-standard-4
  • n1-standard-8
  • n1-standard-16
  • n1-standard-32
  • n1-highmem-2
  • n1-highmem-4
  • n1-highmem-8
  • n1-highmem-16
  • n1-highmem-32
  • n1-highcpu-2
  • n1-highcpu-4
  • n1-highcpu-8
  • n1-highcpu-16
  • n1-highcpu-32 mls1-c1-m2 is generally available. All other machine types are available in beta. Learn more about the differences between machine types. Corresponds to the JSON property machineType

Returns:

  • (String) 


1900
1901
1902
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1900

def machine_type
  @machine_type
end

#manual_scaling ⇒ Google::Apis::MlV1::GoogleCloudMlV1ManualScaling

Options for manually scaling a model. Corresponds to the JSON property manualScaling

Returns:



1905
1906
1907
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1905

def manual_scaling
  @manual_scaling
end

#name ⇒ String

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

Returns:

  • (String) 


1911
1912
1913
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1911

def name
  @name
end

#package_uris ⇒ Array<String>

Optional. Cloud Storage paths (gs://…) of packages for custom prediction routines or scikit-learn pipelines with custom code. For a custom prediction routine, one of these packages must contain your Predictor class (see predictionClass). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected runtime version. If you specify this field, you must also set runtimeVersion to 1.4 or greater. Corresponds to the JSON property packageUris

Returns:

  • (Array<String>) 


1927
1928
1929
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1927

def package_uris
  @package_uris
end

#prediction_class ⇒ String

Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the packageUris field. Specify this field if and only if you are deploying a custom prediction routine (beta). If you specify this field, you must set runtimeVersion to 1.4 or greater and you must set machineType to a legacy (MLS1) machine type. The following code sample provides the Predictor interface:


class Predictor(object):
"""Interface for constructing custom predictors."""
def predict(self, instances, **kwargs):
"""Performs custom prediction.
Instances are the decoded values from the request. They have already
been deserialized from JSON.
Args:
instances: A list of prediction input instances.
**kwargs: A dictionary of keyword args provided as additional
fields on the predict request body.
Returns:
A list of outputs containing the prediction results. This list must
be JSON serializable.
"""
raise NotImplementedError()
def from_path(cls, model_dir):
"""Creates an instance of Predictor using the given path.
Loading of the predictor should be done in this method.
Args:
model_dir: The local directory that contains the exported model
file along with any additional files uploaded when creating the
version resource.
Returns:
An instance implementing this Predictor class.
"""
raise NotImplementedError()

Learn more about the Predictor interface and custom prediction routines. Corresponds to the JSON property predictionClass

Returns:

  • (String) 


1974
1975
1976
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1974

def prediction_class
  @prediction_class
end

#python_version ⇒ String

Optional. The version of Python used in prediction. If not set, the default version is '2.7'. Starting January 13, 2020, this field is required. The following Python versions are available:

  • Python '3.7' is available when runtime_version is set to '1.15' or later.
  • Python '3.5' is available when runtime_version is set to a version from '1.4' to '1.14'.
  • Python '2.7' is available when runtime_version is set to '1.15' or earlier. (Runtime versions released after January 1, 2020 do not support Python 2.7.) Read more about the Python versions available for each runtime version. Corresponds to the JSON property pythonVersion

Returns:

  • (String) 


1993
1994
1995
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1993

def python_version
  @python_version
end

#request_logging_config ⇒ Google::Apis::MlV1::GoogleCloudMlV1RequestLoggingConfig

Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by BigQuery quotas and limits. If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using continuous evaluation, you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. Corresponds to the JSON property requestLoggingConfig

Returns:



2008
2009
2010
 
# File 'generated/google/apis/ml_v1/classes.rb', line 2008

def request_logging_config
  @request_logging_config
end

#runtime_version ⇒ String

Optional. The AI Platform runtime version to use for this deployment. If not set, AI Platform uses the default stable version, 1.0. Starting January 13, 2020, this field is required. For more information, see the runtime version list and how to manage runtime versions. Corresponds to the JSON property runtimeVersion

Returns:

  • (String) 


2019
2020
2021
 
# File 'generated/google/apis/ml_v1/classes.rb', line 2019

def runtime_version
  @runtime_version
end

#service_account ⇒ String

Optional. Specifies the service account for resource access control. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


2024
2025
2026
 
# File 'generated/google/apis/ml_v1/classes.rb', line 2024

def 
  @service_account
end

#state ⇒ String

Output only. The state of a version. Corresponds to the JSON property state

Returns:

  • (String) 


2029
2030
2031
 
# File 'generated/google/apis/ml_v1/classes.rb', line 2029

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
 
# File 'generated/google/apis/ml_v1/classes.rb', line 2036

def update!(**args)
  @accelerator_config = args[:accelerator_config] if args.key?(:accelerator_config)
  @auto_scaling = args[:auto_scaling] if args.key?(:auto_scaling)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployment_uri = args[:deployment_uri] if args.key?(:deployment_uri)
  @description = args[:description] if args.key?(:description)
  @error_message = args[:error_message] if args.key?(:error_message)
  @etag = args[:etag] if args.key?(:etag)
  @explanation_config = args[:explanation_config] if args.key?(:explanation_config)
  @framework = args[:framework] if args.key?(:framework)
  @is_default = args[:is_default] if args.key?(:is_default)
  @labels = args[:labels] if args.key?(:labels)
  @last_use_time = args[:last_use_time] if args.key?(:last_use_time)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @manual_scaling = args[:manual_scaling] if args.key?(:manual_scaling)
  @name = args[:name] if args.key?(:name)
  @package_uris = args[:package_uris] if args.key?(:package_uris)
  @prediction_class = args[:prediction_class] if args.key?(:prediction_class)
  @python_version = args[:python_version] if args.key?(:python_version)
  @request_logging_config = args[:request_logging_config] if args.key?(:request_logging_config)
  @runtime_version = args[:runtime_version] if args.key?(:runtime_version)
  @service_account = args[:service_account] if args.key?(:service_account)
  @state = args[:state] if args.key?(:state)
end