Class: OpenApiOpenAIClient::CreateFineTuningJobRequest

Inherits:
ApiModelBase
  • 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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateFineTuningJobRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 89

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
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_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: " + acceptable_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

  if attributes.key?(:'method')
    self.method = attributes[:'method']
  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

#method ⇒ Object

Returns the value of attribute method.



37
38
39
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 37

def method
  @method
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 64 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-4o-mini: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/create) 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. The contents of the file should differ depending on if the model uses the [chat](/docs/api-reference/fine-tuning/chat-input), [completions](/docs/api-reference/fine-tuning/completions-input) format, or if the fine-tuning method uses the [preference](/docs/api-reference/fine-tuning/preference-input) format. 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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



54
55
56
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 54

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 59

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 265

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



78
79
80
81
82
83
84
85
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 64

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 237

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 &&
      method == o.method
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 258

def hash
  [model, training_file, hyperparameters, suffix, validation_file, integrations, seed, method].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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 144

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 > 64
    invalid_properties.push('invalid value for "suffix", the character length must be smaller than or equal to 64.')
  end

  if !@suffix.nil? && @suffix.to_s.length < 1
    invalid_properties.push('invalid value for "suffix", the character length must be greater 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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 287

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/openapi_openai/models/create_fine_tuning_job_request.rb', line 176

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 > 64
  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