Class: OCI::GenerativeAi::Models::FineTuneDetails

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

Overview

Details about fine-tuning a custom model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FineTuneDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 54

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

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

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

  self.training_config = attributes[:'trainingConfig'] if attributes[:'trainingConfig']

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

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

Instance Attribute Details

#dedicated_ai_cluster_id ⇒ String

[Required] The OCID of the dedicated AI cluster this fine-tuning runs on.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 18

def dedicated_ai_cluster_id
  @dedicated_ai_cluster_id
end

#training_config ⇒ OCI::GenerativeAi::Models::TrainingConfig

Returns:



21
22
23
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 21

def training_config
  @training_config
end

#training_dataset ⇒ OCI::GenerativeAi::Models::Dataset

This attribute is required.

Returns:



14
15
16
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 14

def training_dataset
  @training_dataset
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'training_dataset': :'trainingDataset',
    'dedicated_ai_cluster_id': :'dedicatedAiClusterId',
    'training_config': :'trainingConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'training_dataset': :'OCI::GenerativeAi::Models::Dataset',
    'dedicated_ai_cluster_id': :'String',
    'training_config': :'OCI::GenerativeAi::Models::TrainingConfig'
    # 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



86
87
88
89
90
91
92
93
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 86

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

  self.class == other.class &&
    training_dataset == other.training_dataset &&
    dedicated_ai_cluster_id == other.dedicated_ai_cluster_id &&
    training_config == other.training_config
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



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

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 107

def hash
  [training_dataset, dedicated_ai_cluster_id, training_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 151

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



145
146
147
 
# File 'lib/oci/generative_ai/models/fine_tune_details.rb', line 145

def to_s
  to_hash.to_s
end