fine_tuning: DataStream Class

In openaistream: Streaming Capabilities for 'OpenAI API' Interactions

DataStream Class

Description

DataStream Class

DataStream Class

Super class

openaistream::openai -> fine_tuning

Methods

Public methods

• fine_tuning$create()

• fine_tuning$list()

• fine_tuning$retrieve()

• fine_tuning$cancel()

• fine_tuning$events()

• fine_tuning$clone()

Inherited methods

• openaistream::openai$initialize()

---

Method create()

Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

Usage

fine_tuning$create(
  model,
  training_file,
  hyperparameters = list(n_epochs = 1),
  ...,
  verbosity = 0
)

Arguments

model

character Required. The model ID.

training_file

character Required. The file used for training.

hyperparameters

list. The hyperparameters used for the fine-tuning job. include batch_size;learning_rate_multiplier;n_epochs.

...

Additional parameters as required by the OpenAI API.For example:validation_file......

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

Returns

Response indicating the success or failure of the fine-tuning job creation.

---

Method list()

List your organization's fine-tuning jobs

Usage

fine_tuning$list(verbosity = 0, ...)

Arguments

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

...

Additional parameters as required by the OpenAI API. For example:after,limit.

Returns

A list of paginated fine-tuning job objects.

---

Method retrieve()

Get info about a fine-tuning job.

Usage

fine_tuning$retrieve(job_id, verbosity = 0)

Arguments

job_id

character Required. The ID of the fine-tuning job.

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

Returns

The fine-tuning object with the given ID.

---

Method cancel()

Immediately cancel a fine-tune job.

Usage

fine_tuning$cancel(job_id, verbosity = 0)

Arguments

job_id

character Required. The ID of the fine-tuning job to cancel.

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

Returns

The cancelled fine-tuning object.

---

Method events()

Get status updates for a fine-tuning job.

Usage

fine_tuning$events(job_id, ..., verbosity = 0)

Arguments

job_id

character Required. The ID of the fine-tuning job to get events for.

...

Additional parameters as required by the OpenAI API. For example:after,limit.

verbosity

numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.).

Returns

A list of fine-tuning event objects.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

fine_tuning$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

openaistream documentation built on June 22, 2024, 9:55 a.m.