Class: OpenAI::Models::FineTuning::FineTuningJob

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/fine_tuning/fine_tuning_job.rb

Overview

See Also:

Defined Under Namespace

Modules: Status Classes: Error, Hyperparameters, Method

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(code: , message: , param: ) ⇒ Object

Some parameter documentations has been truncated, see Error for more details.

For fine-tuning jobs that have ‘failed`, this will contain more information on the cause of the failure.

Parameters:

  • code (String) (defaults to: ) —

    A machine-readable error code.

  • message (String) (defaults to: ) —

    A human-readable error message.

  • param (String, nil) (defaults to: ) —

    The parameter that was invalid, usually ‘training_file` or `validation_file`. Th




# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 143

Instance Attribute Details

#created_at ⇒ Integer

The Unix timestamp (in seconds) for when the fine-tuning job was created.

Returns:

  • (Integer) 


18
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 18

required :created_at, Integer

#error ⇒ OpenAI::Models::FineTuning::FineTuningJob::Error?

For fine-tuning jobs that have ‘failed`, this will contain more information on the cause of the failure.

Returns:



25
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 25

required :error, -> { OpenAI::FineTuning::FineTuningJob::Error }, nil?: true

#estimated_finish ⇒ Integer?

The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.

Returns:

  • (Integer, nil) 


114
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 114

optional :estimated_finish, Integer, nil?: true

#fine_tuned_model ⇒ String?

The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.

Returns:

  • (String, nil) 


32
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 32

required :fine_tuned_model, String, nil?: true

#finished_at ⇒ Integer?

The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.

Returns:

  • (Integer, nil) 


39
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 39

required :finished_at, Integer, nil?: true

#hyperparameters ⇒ OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters

The hyperparameters used for the fine-tuning job. This value will only be returned when running ‘supervised` jobs.

Returns:



46
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 46

required :hyperparameters, -> { OpenAI::FineTuning::FineTuningJob::Hyperparameters }

#id ⇒ String

The object identifier, which can be referenced in the API endpoints.

Returns:

  • (String) 


12
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 12

required :id, String

#integrations ⇒ Array<OpenAI::Models::FineTuning::FineTuningJobWandbIntegrationObject>?

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

Returns:



120
121
122
123
124
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 120

optional :integrations,
-> {
  OpenAI::Internal::Type::ArrayOf[OpenAI::FineTuning::FineTuningJobWandbIntegrationObject]
},
nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

  • (Hash{Symbol=>String}, nil) 


135
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 135

optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#method_ ⇒ OpenAI::Models::FineTuning::FineTuningJob::Method?

The method used for fine-tuning.

Returns:



141
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 141

optional :method_, -> { OpenAI::FineTuning::FineTuningJob::Method }, api_name: :method

#model ⇒ String

The base model that is being fine-tuned.

Returns:

  • (String) 


52
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 52

required :model, String

#object ⇒ Symbol, :"fine_tuning.job"

The object type, which is always “fine_tuning.job”.

Returns:

  • (Symbol, :"fine_tuning.job") 


58
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 58

required :object, const: :"fine_tuning.job"

#organization_id ⇒ String

The organization that owns the fine-tuning job.

Returns:

  • (String) 


64
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 64

required :organization_id, String

#result_files ⇒ Array<String>

The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](platform.openai.com/docs/api-reference/files/retrieve-contents).

Returns:

  • (Array<String>) 


72
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 72

required :result_files, OpenAI::Internal::Type::ArrayOf[String]

#seed ⇒ Integer

The seed used for the fine-tuning job.

Returns:

  • (Integer) 


78
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 78

required :seed, Integer

#status ⇒ Symbol, OpenAI::Models::FineTuning::FineTuningJob::Status

The current status of the fine-tuning job, which can be either ‘validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.

Returns:



85
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 85

required :status, enum: -> { OpenAI::FineTuning::FineTuningJob::Status }

#trained_tokens ⇒ Integer?

The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.

Returns:

  • (Integer, nil) 


92
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 92

required :trained_tokens, Integer, nil?: true

#training_file ⇒ String

The file ID used for training. You can retrieve the training data with the [Files API](platform.openai.com/docs/api-reference/files/retrieve-contents).

Returns:

  • (String) 


99
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 99

required :training_file, String

#validation_file ⇒ String?

The file ID used for validation. You can retrieve the validation results with the [Files API](platform.openai.com/docs/api-reference/files/retrieve-contents).

Returns:

  • (String, nil) 


107
 
# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 107

required :validation_file, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 322

.variants ⇒ Array(Symbol, :auto, Integer)

Returns:

  • (Array(Symbol, :auto, Integer)) 



# File 'lib/openai/models/fine_tuning/fine_tuning_job.rb', line 303