Class: OpenAI::Models::FineTuning::Jobs::FineTuningJobCheckpoint

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

Overview

See Also:

Defined Under Namespace

Classes: Metrics

Instance Attribute 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(id: , created_at: , fine_tuned_model_checkpoint: , fine_tuning_job_id: , metrics: , step_number: , object: :"fine_tuning.job.checkpoint") ⇒ Object

The ‘fine_tuning.job.checkpoint` object represents a model checkpoint for a fine-tuning job that is ready to use.

Parameters:

  • id (String) (defaults to: ) —

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

  • created_at (Integer) (defaults to: ) —

    The Unix timestamp (in seconds) for when the checkpoint was created.

  • fine_tuned_model_checkpoint (String) (defaults to: ) —

    The name of the fine-tuned checkpoint model that is created.

  • fine_tuning_job_id (String) (defaults to: ) —

    The name of the fine-tuning job that this checkpoint was created from.

  • metrics (OpenAI::Models::FineTuning::Jobs::FineTuningJobCheckpoint::Metrics) (defaults to: ) —

    Metrics at the step number during the fine-tuning job.

  • step_number (Integer) (defaults to: ) —

    The step number that the checkpoint was created at.

  • object (Symbol, :"fine_tuning.job.checkpoint") (defaults to: :"fine_tuning.job.checkpoint") —

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




# File 'lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb', line 51

Instance Attribute Details

#created_at ⇒ Integer

The Unix timestamp (in seconds) for when the checkpoint was created.

Returns:

  • (Integer) 


19
 
# File 'lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb', line 19

required :created_at, Integer

#fine_tuned_model_checkpoint ⇒ String

The name of the fine-tuned checkpoint model that is created.

Returns:

  • (String) 


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

required :fine_tuned_model_checkpoint, String

#fine_tuning_job_id ⇒ String

The name of the fine-tuning job that this checkpoint was created from.

Returns:

  • (String) 


31
 
# File 'lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb', line 31

required :fine_tuning_job_id, String

#id ⇒ String

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

Returns:

  • (String) 


13
 
# File 'lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb', line 13

required :id, String

#metrics ⇒ OpenAI::Models::FineTuning::Jobs::FineTuningJobCheckpoint::Metrics

Metrics at the step number during the fine-tuning job.

Returns:



37
 
# File 'lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb', line 37

required :metrics, -> { OpenAI::FineTuning::Jobs::FineTuningJobCheckpoint::Metrics }

#object ⇒ Symbol, :"fine_tuning.job.checkpoint"

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

Returns:

  • (Symbol, :"fine_tuning.job.checkpoint") 


43
 
# File 'lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb', line 43

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

#step_number ⇒ Integer

The step number that the checkpoint was created at.

Returns:

  • (Integer) 


49
 
# File 'lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb', line 49

required :step_number, Integer