Class: OpenApiOpenAIClient::CreateFineTuningJobRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_openai/models/create_fine_tuning_job_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFineTuningJobRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 80

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::CreateFineTuningJobRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::CreateFineTuningJobRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  else
    self.model = nil
  end

  if attributes.key?(:'training_file')
    self.training_file = attributes[:'training_file']
  else
    self.training_file = nil
  end

  if attributes.key?(:'hyperparameters')
    self.hyperparameters = attributes[:'hyperparameters']
  end

  if attributes.key?(:'suffix')
    self.suffix = attributes[:'suffix']
  end

  if attributes.key?(:'validation_file')
    self.validation_file = attributes[:'validation_file']
  end

  if attributes.key?(:'integrations')
    if (value = attributes[:'integrations']).is_a?(Array)
      self.integrations = value
    end
  end

  if attributes.key?(:'seed')
    self.seed = attributes[:'seed']
  end
end

Instance Attribute Details

#hyperparameters ⇒ Object

Returns the value of attribute hyperparameters.



23
24
25
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 23

def hyperparameters
  @hyperparameters
end

#integrations ⇒ Object

A list of integrations to enable for your fine-tuning job.



32
33
34
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 32

def integrations
  @integrations
end

#model ⇒ Object

Returns the value of attribute model.



18
19
20
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 18

def model
  @model
end

#seed ⇒ Object

The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.



35
36
37
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 35

def seed
  @seed
end

#suffix ⇒ Object

A string of up to 18 characters that will be added to your fine-tuned model name. For example, a ‘suffix` of "custom-model-name" would produce a model name like `ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel`.



26
27
28
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 26

def suffix
  @suffix
end

#training_file ⇒ Object

The ID of an uploaded file that contains training data. See [upload file](/docs/api-reference/files/upload) for how to upload a file. Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose ‘fine-tune`. See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.



21
22
23
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 21

def training_file
  @training_file
end

#validation_file ⇒ Object

The ID of an uploaded file that contains validation data. If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files. Your dataset must be formatted as a JSONL file. You must upload your file with the purpose ‘fine-tune`. See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.



29
30
31
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 29

def validation_file
  @validation_file
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 254

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OpenApiOpenAIClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 51

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 38

def self.attribute_map
  {
    :'model' => :'model',
    :'training_file' => :'training_file',
    :'hyperparameters' => :'hyperparameters',
    :'suffix' => :'suffix',
    :'validation_file' => :'validation_file',
    :'integrations' => :'integrations',
    :'seed' => :'seed'
  }
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 230

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
73
74
75
76
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 69

def self.openapi_nullable
  Set.new([
    :'suffix',
    :'validation_file',
    :'integrations',
    :'seed'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 56

def self.openapi_types
  {
    :'model' => :'CreateFineTuningJobRequestModel',
    :'training_file' => :'String',
    :'hyperparameters' => :'CreateFineTuningJobRequestHyperparameters',
    :'suffix' => :'String',
    :'validation_file' => :'String',
    :'integrations' => :'Array<CreateFineTuningJobRequestIntegrationsInner>',
    :'seed' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      model == o.model &&
      training_file == o.training_file &&
      hyperparameters == o.hyperparameters &&
      suffix == o.suffix &&
      validation_file == o.validation_file &&
      integrations == o.integrations &&
      seed == o.seed
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 325

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 223

def hash
  [model, training_file, hyperparameters, suffix, validation_file, integrations, seed].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 130

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @model.nil?
    invalid_properties.push('invalid value for "model", model cannot be nil.')
  end

  if @training_file.nil?
    invalid_properties.push('invalid value for "training_file", training_file cannot be nil.')
  end

  if !@suffix.nil? && @suffix.to_s.length > 40
    invalid_properties.push('invalid value for "suffix", the character length must be smaller than or equal to 40.')
  end

  if !@suffix.nil? && @suffix.to_s.length < 1
    invalid_properties.push('invalid value for "suffix", the character length must be great than or equal to 1.')
  end

  if !@seed.nil? && @seed > 2147483647
    invalid_properties.push('invalid value for "seed", must be smaller than or equal to 2147483647.')
  end

  if !@seed.nil? && @seed < 0
    invalid_properties.push('invalid value for "seed", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



301
302
303
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 301

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 307

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



295
296
297
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 295

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 162

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @model.nil?
  return false if @training_file.nil?
  return false if !@suffix.nil? && @suffix.to_s.length > 40
  return false if !@suffix.nil? && @suffix.to_s.length < 1
  return false if !@seed.nil? && @seed > 2147483647
  return false if !@seed.nil? && @seed < 0
  true
end