Class: OpenAI::Resources::FineTuning::Jobs::Checkpoints

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/fine_tuning/jobs/checkpoints.rb

Overview

Manage fine-tuning jobs to tailor a model to your specific training data.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Checkpoints

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Checkpoints.

Parameters:

API:

  • private



43
44
45
 
# File 'lib/openai/resources/fine_tuning/jobs/checkpoints.rb', line 43

def initialize(client:)
  @client = client
end

Instance Method Details

#list(fine_tuning_job_id, after: nil, limit: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::FineTuning::Jobs::FineTuningJobCheckpoint>

Some parameter documentations has been truncated, see Models::FineTuning::Jobs::CheckpointListParams for more details.

List checkpoints for a fine-tuning job.

Parameters:

  • The ID of the fine-tuning job to get checkpoints for.

  • Identifier for the last checkpoint ID from the previous pagination request.

  • Number of checkpoints to retrieve.

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/openai/resources/fine_tuning/jobs/checkpoints.rb', line 27

def list(fine_tuning_job_id, params = {})
  parsed, options = OpenAI::FineTuning::Jobs::CheckpointListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["fine_tuning/jobs/%1$s/checkpoints", fine_tuning_job_id],
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::FineTuning::Jobs::FineTuningJobCheckpoint,
    options: options
  )
end