List Supervised Fine-tuning Jobs

GET

accounts

{account_id}

supervisedFineTuningJobs

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/supervisedFineTuningJobs \
  --header 'Authorization: Bearer <token>'

{
  "supervisedFineTuningJobs": [
    {
      "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
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

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

pageSize

integer

The maximum number of fine-tuning jobs to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 50.

pageToken

string

A page token, received from a previous ListSupervisedFineTuningJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSupervisedFineTuningJobs must match the call that provided the page token.

filter

string

Filter criteria for the returned jobs. See https://google.aip.dev/160 for the filter syntax specification.

orderBy

string

A comma-separated list of fields to order by. e.g. "foo,bar" The default sort order is ascending. To specify a descending order for a field, append a " desc" suffix. e.g. "foo desc,bar" Subfields are specified with a "." character. e.g. "foo.bar" If not specified, the default order is by "name".

Response

200 - application/json

A successful response.

supervisedFineTuningJobs

object[]

supervisedFineTuningJobs.dataset

string

required

The name of the dataset used for training.

supervisedFineTuningJobs.name

string

supervisedFineTuningJobs.displayName

string

supervisedFineTuningJobs.createTime

string

supervisedFineTuningJobs.completedTime

string

supervisedFineTuningJobs.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

supervisedFineTuningJobs.status

object

supervisedFineTuningJobs.createdBy

string

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

supervisedFineTuningJobs.outputModel

string

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

supervisedFineTuningJobs.baseModel

string

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

supervisedFineTuningJobs.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.

supervisedFineTuningJobs.jinjaTemplate

string

supervisedFineTuningJobs.earlyStop

boolean

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

supervisedFineTuningJobs.epochs

integer

The number of epochs to train for.

supervisedFineTuningJobs.learningRate

number

The learning rate used for training.

supervisedFineTuningJobs.maxContextLength

integer

The maximum context length to use with the model.

supervisedFineTuningJobs.loraRank

integer

The rank of the LoRA layers.

supervisedFineTuningJobs.wandbConfig

object

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

supervisedFineTuningJobs.evaluationDataset

string

The name of a separate dataset to use for evaluation.

supervisedFineTuningJobs.isTurbo

boolean

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

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

integer

Was this page helpful?

Suggest edits

Validate Model Upload Get Supervised Fine-tuning Job

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/supervisedFineTuningJobs \
  --header 'Authorization: Bearer <token>'

{
  "supervisedFineTuningJobs": [
    {
      "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
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

API Documentation

LLM API

Embeddings API

Image API

Audio API

Accounts

Deployments

Deployed Models

Models

Supervised Fine Tuning Jobs

Users

Datasets

API Keys

List Supervised Fine-tuning Jobs

Authorizations

Path Parameters

Query Parameters

Response