Class: Google::Apis::MlV1::GoogleCloudMlV1PredictionInput

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 input parameters for a prediction job.

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

Returns a new instance of GoogleCloudMlV1PredictionInput



935
936
937
 
# File 'generated/google/apis/ml_v1/classes.rb', line 935

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

Instance Attribute Details

#batch_size ⇒ Fixnum

Optional. Number of records per batch, defaults to 64. The service will buffer batch_size number of records in memory before invoking one Tensorflow prediction call internally. So take the record size and memory available into consideration when setting this parameter. Corresponds to the JSON property batchSize

Returns:

  • (Fixnum) 


862
863
864
 
# File 'generated/google/apis/ml_v1/classes.rb', line 862

def batch_size
  @batch_size
end

#data_format ⇒ String

Required. The format of the input data files. Corresponds to the JSON property dataFormat

Returns:

  • (String) 


867
868
869
 
# File 'generated/google/apis/ml_v1/classes.rb', line 867

def data_format
  @data_format
end

#input_paths ⇒ Array<String>

Required. The Google Cloud Storage location of the input data files. May contain wildcards. Corresponds to the JSON property inputPaths

Returns:

  • (Array<String>) 


873
874
875
 
# File 'generated/google/apis/ml_v1/classes.rb', line 873

def input_paths
  @input_paths
end

#max_worker_count ⇒ Fixnum

Optional. The maximum number of workers to be used for parallel processing. Defaults to 10 if not specified. Corresponds to the JSON property maxWorkerCount

Returns:

  • (Fixnum) 


879
880
881
 
# File 'generated/google/apis/ml_v1/classes.rb', line 879

def max_worker_count
  @max_worker_count
end

#model_name ⇒ String

Use this field if you want to use the default version for the specified model. The string must use the following format: "projects/YOUR_PROJECT/models/YOUR_MODEL" Corresponds to the JSON property modelName

Returns:

  • (String) 


886
887
888
 
# File 'generated/google/apis/ml_v1/classes.rb', line 886

def model_name
  @model_name
end

#output_path ⇒ String

Required. The output Google Cloud Storage location. Corresponds to the JSON property outputPath

Returns:

  • (String) 


891
892
893
 
# File 'generated/google/apis/ml_v1/classes.rb', line 891

def output_path
  @output_path
end

#region ⇒ String

Required. The Google Compute Engine region to run the prediction job in. See the available regions for ML Engine services. Corresponds to the JSON property region

Returns:

  • (String) 


898
899
900
 
# File 'generated/google/apis/ml_v1/classes.rb', line 898

def region
  @region
end

#runtime_version ⇒ String

Optional. The Google Cloud ML runtime version to use for this batch prediction. If not set, Google Cloud ML will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri. Corresponds to the JSON property runtimeVersion

Returns:

  • (String) 


907
908
909
 
# File 'generated/google/apis/ml_v1/classes.rb', line 907

def runtime_version
  @runtime_version
end

#signature_name ⇒ String

Optional. The name of the signature defined in the SavedModel to use for this job. Please refer to SavedModel for information about how to use signatures. Defaults to DEFAULT_SERVING_SIGNATURE_DEF_KEY , which is "serving_default". Corresponds to the JSON property signatureName

Returns:

  • (String) 


919
920
921
 
# File 'generated/google/apis/ml_v1/classes.rb', line 919

def signature_name
  @signature_name
end

#uri ⇒ String

Use this field if you want to specify a Google Cloud Storage path for the model to use. Corresponds to the JSON property uri

Returns:

  • (String) 


925
926
927
 
# File 'generated/google/apis/ml_v1/classes.rb', line 925

def uri
  @uri
end

#version_name ⇒ String

Use this field if you want to specify a version of the model to use. The string is formatted the same way as model_version, with the addition of the version information: "projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION" Corresponds to the JSON property versionName

Returns:

  • (String) 


933
934
935
 
# File 'generated/google/apis/ml_v1/classes.rb', line 933

def version_name
  @version_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'generated/google/apis/ml_v1/classes.rb', line 940

def update!(**args)
  @batch_size = args[:batch_size] if args.key?(:batch_size)
  @data_format = args[:data_format] if args.key?(:data_format)
  @input_paths = args[:input_paths] if args.key?(:input_paths)
  @max_worker_count = args[:max_worker_count] if args.key?(:max_worker_count)
  @model_name = args[:model_name] if args.key?(:model_name)
  @output_path = args[:output_path] if args.key?(:output_path)
  @region = args[:region] if args.key?(:region)
  @runtime_version = args[:runtime_version] if args.key?(:runtime_version)
  @signature_name = args[:signature_name] if args.key?(:signature_name)
  @uri = args[:uri] if args.key?(:uri)
  @version_name = args[:version_name] if args.key?(:version_name)
end