Creates a fine-tuning job which begins the process of creating a new 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. [Learn more about fine-tuning](/docs/guides/fine-tuning)
POST /fine_tuning/jobs
Authorizations
Request Body required
object
The ID of an uploaded file that contains training data.
See upload file for how to upload a file.
Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune.
The contents of the file should differ depending on if the model uses the chat or completions format.
See the fine-tuning guide for more details.
file-abc123A string of up to 18 characters that will be added to your fine-tuned model name.
For example, a suffix of “custom-model-name” would produce a model name like ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel.
The ID of an uploaded file that contains validation data.
If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.
Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.
See the fine-tuning guide for more details.
file-abc123A list of integrations to enable for your fine-tuning job.
object
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.
object
The name of the project that the new run will be created under.
my-wandb-projectA display name to set for the run. If not set, we will use the Job ID as the name.
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.
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}“.
The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.
42Responses
200
OK
The fine_tuning.job object represents a fine-tuning job that has been created through the API.
object
The object identifier, which can be referenced in the API endpoints.
The Unix timestamp (in seconds) for when the fine-tuning job was created.
For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
object
A machine-readable error code.
A human-readable error message.
The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.
The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.
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.
The hyperparameters used for the fine-tuning job. See the fine-tuning guide for more details.
The base model that is being fine-tuned.
The object type, which is always “fine_tuning.job”.
The organization that owns the fine-tuning job.
The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.
The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.
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.
The file ID used for training. You can retrieve the training data with the Files API.
The file ID used for validation. You can retrieve the validation results with the Files API.
A list of integrations to enable for this fine-tuning job.
object
The type of the integration being enabled for the fine-tuning job
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.
object
The name of the project that the new run will be created under.
my-wandb-projectA display name to set for the run. If not set, we will use the Job ID as the name.
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.
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}“.
The seed used for the fine-tuning job.
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.