GET
/
v1
/
accounts
/
{account_id}
/
supervisedFineTuningJobs
/
{supervised_fine_tuning_job_id}
Get Supervised Fine-tuning Job
curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/supervisedFineTuningJobs/{supervised_fine_tuning_job_id} \
  --header 'Authorization: Bearer <token>'
{
  "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,
  "evalAutoCarveout": true,
  "region": "REGION_UNSPECIFIED",
  "updateTime": "2023-11-07T05:31:56Z",
  "nodes": 123,
  "batchSize": 123,
  "mtpEnabled": true,
  "mtpNumDraftTokens": 123,
  "mtpFreezeBaseModel": true,
  "metricsFileSignedUrl": "<string>"
}

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

​
supervised_fine_tuning_job_id
string
required

The Supervised Fine-tuning Job Id

Query Parameters

​
readMask
string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

​
dataset
string
required

The name of the dataset used for training.

​
name
string
​
displayName
string
​
createTime
string<date-time>
​
completedTime
string<date-time>
​
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_DELETING_CLEANING_UP,
JOB_STATE_PENDING,
JOB_STATE_EXPIRED,
JOB_STATE_RE_QUEUEING,
JOB_STATE_CREATING_INPUT_DATASET
​
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.

​
evalAutoCarveout
boolean

Whether to auto-carve the dataset for eval.

​
region
enum<string>
default:REGION_UNSPECIFIED

The region where the fine-tuning job is located.

Available options:
REGION_UNSPECIFIED,
US_IOWA_1,
US_VIRGINIA_1,
US_VIRGINIA_2,
US_ILLINOIS_1,
AP_TOKYO_1,
EU_LONDON_1,
US_ARIZONA_1,
US_TEXAS_1,
US_ILLINOIS_2,
EU_FRANKFURT_1,
US_TEXAS_2,
EU_PARIS_1,
EU_HELSINKI_1,
US_NEVADA_1,
EU_ICELAND_1,
EU_ICELAND_2,
US_WASHINGTON_1,
US_WASHINGTON_2,
US_WASHINGTON_3,
AP_TOKYO_2,
US_CALIFORNIA_1,
US_UTAH_1
​
updateTime
string<date-time>

The update time for the supervised fine-tuning job.

​
nodes
integer

The number of nodes to use for the fine-tuning job.

​
batchSize
integer
​
mtpEnabled
boolean
​
mtpNumDraftTokens
integer
​
mtpFreezeBaseModel
boolean
​
metricsFileSignedUrl
string