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



1538
1539
1540
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1538

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

Instance Attribute Details

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

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

Returns:



1414
1415
1416
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1414

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) 


1419
1420
1421
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1419

def create_time
  @create_time
end

#deployment_uri ⇒ String

Required. The Google 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) 


1435
1436
1437
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1435

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) 


1440
1441
1442
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1440

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) 


1445
1446
1447
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1445

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) 


1457
1458
1459
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1457

def etag
  @etag
end

#framework ⇒ String

Optional. The machine learning framework Cloud ML Engine uses to train this version of the model. Valid values are TENSORFLOW, SCIKIT_LEARN, XGBOOST. If you do not specify a framework, Cloud ML Engine 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. Corresponds to the JSON property framework

Returns:

  • (String) 


1467
1468
1469
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1467

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) 


1476
1477
1478
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1476

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


1486
1487
1488
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1486

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) 


1491
1492
1493
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1491

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. The following are currently supported and will be deprecated in Beta release. mls1-highmem-1 1 core 2 Gb RAM mls1-highcpu-4 4 core 2 Gb RAM The following are available in Beta: mls1-c1-m2 1 core 2 Gb RAM Default mls1-c4-m2 4 core 2 Gb RAM Corresponds to the JSON property machineType

Returns:

  • (String) 


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

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:



1509
1510
1511
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1509

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) 


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

def name
  @name
end

#python_version ⇒ String

Optional. The version of Python used in prediction. If not set, the default version is '2.7'. Python '3.5' is available when runtime_version is set to '1.4' and above. Python '2.7' works with all supported runtime versions. Corresponds to the JSON property pythonVersion

Returns:

  • (String) 


1522
1523
1524
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1522

def python_version
  @python_version
end

#runtime_version ⇒ String

Optional. The Cloud ML Engine runtime version to use for this deployment. If not set, Cloud ML Engine uses the default stable version, 1.0. For more information, see the runtime version list and how to manage runtime versions. Corresponds to the JSON property runtimeVersion

Returns:

  • (String) 


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

def runtime_version
  @runtime_version
end

#state ⇒ String

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

Returns:

  • (String) 


1536
1537
1538
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1536

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1543

def update!(**args)
  @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)
  @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)
  @python_version = args[:python_version] if args.key?(:python_version)
  @runtime_version = args[:runtime_version] if args.key?(:runtime_version)
  @state = args[:state] if args.key?(:state)
end