POST
/
v1
/
accounts
/
{account_id}
/
supervisedFineTuningJobs
curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/supervisedFineTuningJobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "<string>",
  "dataset": "<string>",
  "outputModel": "<string>",
  "baseModel": "<string>",
  "warmStartFrom": "<string>",
  "jinjaTemplate": "<string>",
  "earlyStop": true,
  "epochs": 123,
  "learningRate": 123,
  "maxContextLength": 123,
  "loraRank": 123,
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>"
  },
  "evaluationDataset": "<string>",
  "isTurbo": true
}'
{
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "completedTime": "2023-11-07T05:31:56Z",
  "dataset": "<string>",
  "state": "JOB_STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "createdBy": "<string>",
  "outputModel": "<string>",
  "baseModel": "<string>",
  "warmStartFrom": "<string>",
  "jinjaTemplate": "<string>",
  "earlyStop": true,
  "epochs": 123,
  "learningRate": 123,
  "maxContextLength": 123,
  "loraRank": 123,
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>",
    "url": "<string>"
  },
  "evaluationDataset": "<string>",
  "isTurbo": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
account_id
string
required

The Account Id

Query Parameters

​
supervisedFineTuningJobId
string

ID of the supervised fine-tuning job, a random UUID will be generated if not specified.

Body

application/json
​
dataset
string
required

The name of the dataset used for training.

​
displayName
string
​
state
enum<string>
default:
JOB_STATE_UNSPECIFIED

JobState represents the state an asynchronous job can be in.

Available options:
JOB_STATE_UNSPECIFIED,
JOB_STATE_CREATING,
JOB_STATE_RUNNING,
JOB_STATE_COMPLETED,
JOB_STATE_FAILED,
JOB_STATE_CANCELLED,
JOB_STATE_DELETING,
JOB_STATE_WRITING_RESULTS,
JOB_STATE_VALIDATING,
JOB_STATE_ROLLOUT,
JOB_STATE_EVALUATION
​
status
object
​
outputModel
string

The model ID to be assigned to the resulting fine-tuned model. If not specified, the job ID will be used.

​
baseModel
string

The name of the base model to be fine-tuned Only one of 'base_model' or 'warm_start_from' should be specified.

​
warmStartFrom
string

The PEFT addon model in Fireworks format to be fine-tuned from Only one of 'base_model' or 'warm_start_from' should be specified.

​
jinjaTemplate
string
​
earlyStop
boolean

Whether to stop training early if the validation loss does not improve.

​
epochs
integer

The number of epochs to train for.

​
learningRate
number

The learning rate used for training.

​
maxContextLength
integer

The maximum context length to use with the model.

​
loraRank
integer

The rank of the LoRA layers.

​
wandbConfig
object

The Weights & Biases team/user account for logging training progress.

​
evaluationDataset
string

The name of a separate dataset to use for evaluation.

​
isTurbo
boolean

Whether to run the fine-tuning job in turbo mode.

Response

200 - application/json
A successful response.
​
dataset
string
required

The name of the dataset used for training.

​
name
string
​
displayName
string
​
createTime
string
​
completedTime
string
​
state
enum<string>
default:
JOB_STATE_UNSPECIFIED

JobState represents the state an asynchronous job can be in.

Available options:
JOB_STATE_UNSPECIFIED,
JOB_STATE_CREATING,
JOB_STATE_RUNNING,
JOB_STATE_COMPLETED,
JOB_STATE_FAILED,
JOB_STATE_CANCELLED,
JOB_STATE_DELETING,
JOB_STATE_WRITING_RESULTS,
JOB_STATE_VALIDATING,
JOB_STATE_ROLLOUT,
JOB_STATE_EVALUATION
​
status
object
​
createdBy
string

The email address of the user who initiated this fine-tuning job.

​
outputModel
string

The model ID to be assigned to the resulting fine-tuned model. If not specified, the job ID will be used.

​
baseModel
string

The name of the base model to be fine-tuned Only one of 'base_model' or 'warm_start_from' should be specified.

​
warmStartFrom
string

The PEFT addon model in Fireworks format to be fine-tuned from Only one of 'base_model' or 'warm_start_from' should be specified.

​
jinjaTemplate
string
​
earlyStop
boolean

Whether to stop training early if the validation loss does not improve.

​
epochs
integer

The number of epochs to train for.

​
learningRate
number

The learning rate used for training.

​
maxContextLength
integer

The maximum context length to use with the model.

​
loraRank
integer

The rank of the LoRA layers.

​
wandbConfig
object

The Weights & Biases team/user account for logging training progress.

​
evaluationDataset
string

The name of a separate dataset to use for evaluation.

​
isTurbo
boolean

Whether to run the fine-tuning job in turbo mode.

Was this page helpful?

Suggest edits
Get Supervised Fine-tuning JobDelete Supervised Fine-tuning Job