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

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

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:



41
42
43
 
# File 'lib/openai/resources/fine_tuning/jobs/checkpoints.rb', line 41

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:

  • fine_tuning_job_id (String) —

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

  • after (String) —

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

  • limit (Integer) —

    Number of checkpoints to retrieve.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



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

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