Class: OCI::GenerativeAi::Models::DedicatedAiCluster

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/dedicated_ai_cluster.rb

Overview

Dedicated AI clusters are compute resources that you can use for fine-tuning custom models or for hosting endpoints for custom models. The clusters are dedicated to your models and not shared with users in other tenancies.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resouces.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_HOSTING = 'HOSTING'.freeze,
  TYPE_FINE_TUNING = 'FINE_TUNING'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
UNIT_SHAPE_ENUM = 
[
  UNIT_SHAPE_LARGE_COHERE = 'LARGE_COHERE'.freeze,
  UNIT_SHAPE_SMALL_COHERE = 'SMALL_COHERE'.freeze,
  UNIT_SHAPE_EMBED_COHERE = 'EMBED_COHERE'.freeze,
  UNIT_SHAPE_LLAMA2_70 = 'LLAMA2_70'.freeze,
  UNIT_SHAPE_LARGE_COHERE_V2 = 'LARGE_COHERE_V2'.freeze,
  UNIT_SHAPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DedicatedAiCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 185

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.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  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.description = attributes[:'description'] if attributes[:'description']

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

  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.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.unit_count = attributes[:'unitCount'] if attributes[:'unitCount']

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

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

  self.unit_shape = attributes[:'unitShape'] if attributes[:'unitShape']

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

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

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

  self.previous_state = attributes[:'previousState'] if attributes[:'previousState']

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#capacity ⇒ OCI::GenerativeAi::Models::DedicatedAiClusterCapacity

Returns:



87
88
89
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 87

def capacity
  @capacity
end

#compartment_id ⇒ String

[Required] The compartment OCID to create the dedicated AI cluster in.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 60

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


106
107
108
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 106

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the dedicated AI cluster.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 52

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 48

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


98
99
100
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 98

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the dedicated AI cluster.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 44

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state with detail that can provide actionable information.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 76

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the dedicated AI cluster.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 72

def lifecycle_state
  @lifecycle_state
end

#previous_state ⇒ OCI::GenerativeAi::Models::DedicatedAiCluster

Returns:



90
91
92
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 90

def previous_state
  @previous_state
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


113
114
115
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 113

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the dedicated AI cluster was created, in the format defined by RFC 3339

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 64

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 68

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 56

def type
  @type
end

#unit_count ⇒ Integer

[Required] The number of dedicated units in this AI cluster.

Returns:

  • (Integer) 


80
81
82
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 80

def unit_count
  @unit_count
end

#unit_shape ⇒ String

[Required] The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 84

def unit_shape
  @unit_shape
end

Class Method Details

.attribute_map ⇒ Object

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 116

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'unit_count': :'unitCount',
    'unit_shape': :'unitShape',
    'capacity': :'capacity',
    'previous_state': :'previousState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 140

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'unit_count': :'Integer',
    'unit_shape': :'String',
    'capacity': :'OCI::GenerativeAi::Models::DedicatedAiClusterCapacity',
    'previous_state': :'OCI::GenerativeAi::Models::DedicatedAiCluster',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 318

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    unit_count == other.unit_count &&
    unit_shape == other.unit_shape &&
    capacity == other.capacity &&
    previous_state == other.previous_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 363

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


343
344
345
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 343

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



352
353
354
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 352

def hash
  [id, display_name, description, type, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, unit_count, unit_shape, capacity, previous_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



396
397
398
399
400
401
402
403
404
405
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 396

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



390
391
392
 
# File 'lib/oci/generative_ai/models/dedicated_ai_cluster.rb', line 390

def to_s
  to_hash.to_s
end