Jobs

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

Create fine-tuning job

fine_tuning.jobs.create() -> FineTuningJob

POST/fine_tuning/jobs

List fine-tuning jobs

fine_tuning.jobs.list() -> SyncCursorPage[FineTuningJob]

GET/fine_tuning/jobs

Retrieve fine-tuning job

fine_tuning.jobs.retrieve() -> FineTuningJob

GET/fine_tuning/jobs/{fine_tuning_job_id}

List fine-tuning events

fine_tuning.jobs.list_events(, ) -> SyncCursorPage[FineTuningJobEvent]

GET/fine_tuning/jobs/{fine_tuning_job_id}/events

Cancel fine-tuning

fine_tuning.jobs.cancel() -> FineTuningJob

POST/fine_tuning/jobs/{fine_tuning_job_id}/cancel

Pause fine-tuning

fine_tuning.jobs.pause() -> FineTuningJob

POST/fine_tuning/jobs/{fine_tuning_job_id}/pause

Resume fine-tuning

fine_tuning.jobs.resume() -> FineTuningJob

POST/fine_tuning/jobs/{fine_tuning_job_id}/resume

ModelsExpand Collapse

class FineTuningJob: …

The fine_tuning.job object represents a fine-tuning job that has been created through the API.

id: str

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

created_at: int

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

error: Optional[Error]

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

code: str

A machine-readable error code.

message: str

A human-readable error message.

param: Optional[str]

The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.

fine_tuned_model: Optional[str]

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

finished_at: Optional[int]

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.

hyperparameters: Hyperparameters

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

batch_size: Optional[Union[Literal["auto"], int, null]]

Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.

One of the following:

Literal["auto"]

int

learning_rate_multiplier: Optional[Union[Literal["auto"], float, null]]

Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.

One of the following:

Literal["auto"]

float

n_epochs: Optional[Union[Literal["auto"], int, null]]

The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.

One of the following:

Literal["auto"]

int

model: str

The base model that is being fine-tuned.

object: Literal["fine_tuning.job"]

The object type, which is always "fine_tuning.job".

organization_id: str

The organization that owns the fine-tuning job.

result_files: List[str]

The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.

seed: int

The seed used for the fine-tuning job.

status: Literal["validating_files", "queued", "running", 3 more]

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

One of the following:

"validating_files"

"queued"

"running"

"succeeded"

"failed"

"cancelled"

trained_tokens: Optional[int]

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.

training_file: str

The file ID used for training. You can retrieve the training data with the Files API.

validation_file: Optional[str]

The file ID used for validation. You can retrieve the validation results with the Files API.

estimated_finish: Optional[int]

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.

integrations: Optional[List[FineTuningJobWandbIntegrationObject]]

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

type: Literal["wandb"]

The type of the integration being enabled for the fine-tuning job

wandb: FineTuningJobWandbIntegration

The settings for your integration with Weights and Biases. This payload specifies the project that metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags to your run, and set a default entity (team, username, etc) to be associated with your run.

metadata: Optional[Metadata]

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.

method: Optional[Method]

The method used for fine-tuning.

type: Literal["supervised", "dpo", "reinforcement"]

The type of method. Is either supervised, dpo, or reinforcement.

One of the following:

"supervised"

"dpo"

"reinforcement"

dpo: Optional[DpoMethod]

Configuration for the DPO fine-tuning method.

reinforcement: Optional[ReinforcementMethod]

Configuration for the reinforcement fine-tuning method.

supervised: Optional[SupervisedMethod]

Configuration for the supervised fine-tuning method.

class FineTuningJobEvent: …

Fine-tuning job event object

id: str

The object identifier.

created_at: int

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

level: Literal["info", "warn", "error"]

The log level of the event.

One of the following:

"info"

"warn"

"error"

message: str

The message of the event.

object: Literal["fine_tuning.job.event"]

The object type, which is always "fine_tuning.job.event".

data: Optional[object]

The data associated with the event.

type: Optional[Literal["message", "metrics"]]

The type of event.

One of the following:

"message"

"metrics"

class FineTuningJobWandbIntegration: …

project: str

The name of the project that the new run will be created under.

entity: Optional[str]

The entity to use for the run. This allows you to set the team or username of the WandB user that you would like associated with the run. If not set, the default entity for the registered WandB API key is used.

name: Optional[str]

A display name to set for the run. If not set, we will use the Job ID as the name.

tags: Optional[List[str]]

A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some default tags are generated by OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".

class FineTuningJobWandbIntegrationObject: …

type: Literal["wandb"]

The type of the integration being enabled for the fine-tuning job

wandb: FineTuningJobWandbIntegration

JobsCheckpoints

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

List fine-tuning checkpoints

fine_tuning.jobs.checkpoints.list(, ) -> SyncCursorPage[FineTuningJobCheckpoint]

GET/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

ModelsExpand Collapse

class FineTuningJobCheckpoint: …

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

id: str

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

created_at: int

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

fine_tuned_model_checkpoint: str

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

fine_tuning_job_id: str

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

metrics: Metrics

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

full_valid_loss: Optional[float]

full_valid_mean_token_accuracy: Optional[float]

step: Optional[float]

train_loss: Optional[float]

train_mean_token_accuracy: Optional[float]

valid_loss: Optional[float]

valid_mean_token_accuracy: Optional[float]

object: Literal["fine_tuning.job.checkpoint"]

The object type, which is always "fine_tuning.job.checkpoint".

step_number: int

The step number that the checkpoint was created at.

Suggested

Jobs

ModelsExpand Collapse

JobsCheckpoints

ModelsExpand Collapse