Class: OCI::AiDocument::Models::CreateModelDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_document/models/create_model_details.rb

Overview

The information needed to create a new model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateModelDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 160

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']
  self.display_name = "The display name of the model." if display_name.nil? && !attributes.key?(:'displayName') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']
  self.display_name = "The display name of the model." if display_name.nil? && !attributes.key?(:'displayName') && !attributes.key?(:'display_name') # rubocop:disable Style/StringLiterals

  self.description = attributes[:'description'] if attributes[:'description']
  self.description = "The description of the Model." if description.nil? && !attributes.key?(:'description') # rubocop:disable Style/StringLiterals

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

  raise 'You cannot provide both :modelVersion and :model_version' if attributes.key?(:'modelVersion') && attributes.key?(:'model_version')

  self.model_version = attributes[:'model_version'] if attributes[:'model_version']

  self.model_type = attributes[:'modelType'] if attributes[:'modelType']

  raise 'You cannot provide both :modelType and :model_type' if attributes.key?(:'modelType') && attributes.key?(:'model_type')

  self.model_type = attributes[:'model_type'] if attributes[:'model_type']

  self.model_sub_type = attributes[:'modelSubType'] if attributes[:'modelSubType']

  raise 'You cannot provide both :modelSubType and :model_sub_type' if attributes.key?(:'modelSubType') && attributes.key?(:'model_sub_type')

  self.model_sub_type = attributes[:'model_sub_type'] if attributes[:'model_sub_type']

  self.inference_units = attributes[:'inferenceUnits'] if attributes[:'inferenceUnits']

  raise 'You cannot provide both :inferenceUnits and :inference_units' if attributes.key?(:'inferenceUnits') && attributes.key?(:'inference_units')

  self.inference_units = attributes[:'inference_units'] if attributes[:'inference_units']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.is_quick_mode = attributes[:'isQuickMode'] unless attributes[:'isQuickMode'].nil?
  self.is_quick_mode = false if is_quick_mode.nil? && !attributes.key?(:'isQuickMode') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isQuickMode and :is_quick_mode' if attributes.key?(:'isQuickMode') && attributes.key?(:'is_quick_mode')

  self.is_quick_mode = attributes[:'is_quick_mode'] unless attributes[:'is_quick_mode'].nil?
  self.is_quick_mode = false if is_quick_mode.nil? && !attributes.key?(:'isQuickMode') && !attributes.key?(:'is_quick_mode') # rubocop:disable Style/StringLiterals

  self.max_training_time_in_hours = attributes[:'maxTrainingTimeInHours'] if attributes[:'maxTrainingTimeInHours']

  raise 'You cannot provide both :maxTrainingTimeInHours and :max_training_time_in_hours' if attributes.key?(:'maxTrainingTimeInHours') && attributes.key?(:'max_training_time_in_hours')

  self.max_training_time_in_hours = attributes[:'max_training_time_in_hours'] if attributes[:'max_training_time_in_hours']

  self.language = attributes[:'language'] if attributes[:'language']
  self.language = "ENG" if language.nil? && !attributes.key?(:'language') # rubocop:disable Style/StringLiterals

  self.training_dataset = attributes[:'trainingDataset'] if attributes[:'trainingDataset']

  raise 'You cannot provide both :trainingDataset and :training_dataset' if attributes.key?(:'trainingDataset') && attributes.key?(:'training_dataset')

  self.training_dataset = attributes[:'training_dataset'] if attributes[:'training_dataset']

  self.testing_dataset = attributes[:'testingDataset'] if attributes[:'testingDataset']

  raise 'You cannot provide both :testingDataset and :testing_dataset' if attributes.key?(:'testingDataset') && attributes.key?(:'testing_dataset')

  self.testing_dataset = attributes[:'testing_dataset'] if attributes[:'testing_dataset']

  self.validation_dataset = attributes[:'validationDataset'] if attributes[:'validationDataset']

  raise 'You cannot provide both :validationDataset and :validation_dataset' if attributes.key?(:'validationDataset') && attributes.key?(:'validation_dataset')

  self.validation_dataset = attributes[:'validation_dataset'] if attributes[:'validation_dataset']

  self.component_models = attributes[:'componentModels'] if attributes[:'componentModels']

  raise 'You cannot provide both :componentModels and :component_models' if attributes.key?(:'componentModels') && attributes.key?(:'component_models')

  self.component_models = attributes[:'component_models'] if attributes[:'component_models']

  self.alias_name = attributes[:'aliasName'] if attributes[:'aliasName']

  raise 'You cannot provide both :aliasName and :alias_name' if attributes.key?(:'aliasName') && attributes.key?(:'alias_name')

  self.alias_name = attributes[:'alias_name'] if attributes[:'alias_name']

  self.project_id = attributes[:'projectId'] if attributes[:'projectId']

  raise 'You cannot provide both :projectId and :project_id' if attributes.key?(:'projectId') && attributes.key?(:'project_id')

  self.project_id = attributes[:'project_id'] if attributes[:'project_id']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#alias_name ⇒ String

the alias name of the model.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 66

def alias_name
  @alias_name
end

#compartment_id ⇒ String

[Required] The compartment identifier.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 37

def compartment_id
  @compartment_id
end

#component_models ⇒ Array<OCI::AiDocument::Models::ComponentModel>

The OCID list of active custom Key Value models that need to be composed.

Returns:



62
63
64
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 62

def component_models
  @component_models
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


82
83
84
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 82

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the model.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 17

def description
  @description
end

#display_name ⇒ String

A human-friendly name for the model, which can be changed.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 13

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


76
77
78
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 76

def freeform_tags
  @freeform_tags
end

#inference_units ⇒ Integer

Number of replicas required for this model.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 33

def inference_units
  @inference_units
end

#is_quick_mode ⇒ BOOLEAN

Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data.

Returns:

  • (BOOLEAN) 


41
42
43
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 41

def is_quick_mode
  @is_quick_mode
end

#language ⇒ String

The document language for model training, abbreviated according to the BCP 47 syntax.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 49

def language
  @language
end

#max_training_time_in_hours ⇒ Float

The maximum model training time in hours, expressed as a decimal fraction.

Returns:

  • (Float) 


45
46
47
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 45

def max_training_time_in_hours
  @max_training_time_in_hours
end

#model_sub_type ⇒ OCI::AiDocument::Models::ModelSubType

Applicable to only PRE_TRAINED_KEY_VALUE_EXTRACTION, PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION.

Returns:



29
30
31
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 29

def model_sub_type
  @model_sub_type
end

#model_type ⇒ String

[Required] The type of the Document model.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 25

def model_type
  @model_type
end

#model_version ⇒ String

The model version

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 21

def model_version
  @model_version
end

#project_id ⇒ String

[Required] The OCID of the project that contains the model.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 70

def project_id
  @project_id
end

#testing_dataset ⇒ OCI::AiDocument::Models::Dataset

Returns:



55
56
57
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 55

def testing_dataset
  @testing_dataset
end

#training_dataset ⇒ OCI::AiDocument::Models::Dataset

Returns:



52
53
54
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 52

def training_dataset
  @training_dataset
end

#validation_dataset ⇒ OCI::AiDocument::Models::Dataset

Returns:



58
59
60
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 58

def validation_dataset
  @validation_dataset
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 85

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'model_version': :'modelVersion',
    'model_type': :'modelType',
    'model_sub_type': :'modelSubType',
    'inference_units': :'inferenceUnits',
    'compartment_id': :'compartmentId',
    'is_quick_mode': :'isQuickMode',
    'max_training_time_in_hours': :'maxTrainingTimeInHours',
    'language': :'language',
    'training_dataset': :'trainingDataset',
    'testing_dataset': :'testingDataset',
    'validation_dataset': :'validationDataset',
    'component_models': :'componentModels',
    'alias_name': :'aliasName',
    'project_id': :'projectId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 111

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'model_version': :'String',
    'model_type': :'String',
    'model_sub_type': :'OCI::AiDocument::Models::ModelSubType',
    'inference_units': :'Integer',
    'compartment_id': :'String',
    'is_quick_mode': :'BOOLEAN',
    'max_training_time_in_hours': :'Float',
    'language': :'String',
    'training_dataset': :'OCI::AiDocument::Models::Dataset',
    'testing_dataset': :'OCI::AiDocument::Models::Dataset',
    'validation_dataset': :'OCI::AiDocument::Models::Dataset',
    'component_models': :'Array<OCI::AiDocument::Models::ComponentModel>',
    'alias_name': :'String',
    'project_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 280

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    model_version == other.model_version &&
    model_type == other.model_type &&
    model_sub_type == other.model_sub_type &&
    inference_units == other.inference_units &&
    compartment_id == other.compartment_id &&
    is_quick_mode == other.is_quick_mode &&
    max_training_time_in_hours == other.max_training_time_in_hours &&
    language == other.language &&
    training_dataset == other.training_dataset &&
    testing_dataset == other.testing_dataset &&
    validation_dataset == other.validation_dataset &&
    component_models == other.component_models &&
    alias_name == other.alias_name &&
    project_id == other.project_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 327

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


307
308
309
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 307

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



316
317
318
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 316

def hash
  [display_name, description, model_version, model_type, model_sub_type, inference_units, compartment_id, is_quick_mode, max_training_time_in_hours, language, training_dataset, testing_dataset, validation_dataset, component_models, alias_name, project_id, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 360

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



354
355
356
 
# File 'lib/oci/ai_document/models/create_model_details.rb', line 354

def to_s
  to_hash.to_s
end