List Fine-tuning Jobs

GET

accounts

{account_id}

fineTuningJobs

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

{
  "fineTuningJobs": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "state": "STATE_UNSPECIFIED",
      "dataset": "<string>",
      "datasets": [
        {
          "dataset": "<string>"
        }
      ],
      "status": {
        "code": "OK",
        "message": "<string>"
      },
      "createdBy": "<string>",
      "containerVersion": "<string>",
      "modelId": "<string>",
      "legacyJob": {},
      "textCompletion": {
        "inputTemplate": "<string>",
        "outputTemplate": "<string>"
      },
      "textClassification": {
        "text": "<string>",
        "label": "<string>"
      },
      "conversation": {
        "jinjaTemplate": "<string>"
      },
      "draftModelData": {
        "deploymentName": "<string>",
        "jinjaTemplate": "<string>",
        "cleanupDeployment": true
      },
      "draftModel": {},
      "genie": {
        "pipelineName": "<string>"
      },
      "baseModel": "<string>",
      "warmStartFrom": "<string>",
      "epochs": 123,
      "learningRate": 123,
      "loraRank": 123,
      "loraTargetModules": [
        "<string>"
      ],
      "batchSize": 123,
      "microBatchSize": 123,
      "maskToken": "<string>",
      "padToken": "<string>",
      "wandbUrl": "<string>",
      "wandbEntity": "<string>",
      "wandbApiKey": "<string>",
      "wandbProject": "<string>",
      "evaluation": true,
      "evaluationSplit": 123,
      "evaluationDataset": "<string>",
      "dependentJobs": [
        "<string>"
      ]
    }
  ],
  "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 ListFineTuningJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListFineTuningJobs must match the call that provided the page token.

filter

string

Only model satisfying the provided filter (if specified) will be returned. See https://google.aip.dev/160 for the filter grammar.

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.

fineTuningJobs

object[]

fineTuningJobs.name

string

fineTuningJobs.displayName

string

fineTuningJobs.createTime

string

fineTuningJobs.state

enum<string>

default:STATE_UNSPECIFIED

CREATING: The fine-tuning job is being created.
PENDING: The fine-tuning job scheduled and is waiting for resource allocation.
RUNNING: The fine-tuning job is running.
COMPLETED: The fine-tuning job has finished successfully.
FAILED: The fine-tuning job has failed.
DELETING: The fine-tuning job is being deleted

Available options:

STATE_UNSPECIFIED,

CREATING,

PENDING,

RUNNING,

COMPLETED,

FAILED,

DELETING

fineTuningJobs.dataset

string

The name of the dataset used for training. A dataset ID may also be supplied, in which case the ID will be normalized into the fully qualified dataset name using the parent of the job.

fineTuningJobs.datasets

object[]

The list of datasets to be used for training. The dataset IDs may also be supplied, in which case the ID will be normalized into the fully qualified dataset name using the parent of the job.

fineTuningJobs.status

object

fineTuningJobs.createdBy

string

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

fineTuningJobs.containerVersion

string

fineTuningJobs.modelId

string

the model id to generate for training jobs.

fineTuningJobs.legacyJob

object

fineTuningJobs.textCompletion

object

fineTuningJobs.textClassification

object

fineTuningJobs.conversation

object

fineTuningJobs.draftModelData

object

fineTuningJobs.draftModel

object

fineTuningJobs.genie

object

fineTuningJobs.baseModel

string

The name of the base model.

fineTuningJobs.warmStartFrom

string

peft addon model in fireworks format to warm start a fine-tuning job from.

fineTuningJobs.epochs

number

The number of epochs to train for.

fineTuningJobs.learningRate

number

The learning rate used for training.

fineTuningJobs.loraRank

integer

The lora rank used for training.

fineTuningJobs.loraTargetModules

string[]

The lora target modules used for training.

fineTuningJobs.batchSize

integer

The batch size of dataset used for training.

fineTuningJobs.microBatchSize

integer

The batch size of dataset used for training per accelerator.

fineTuningJobs.maskToken

string

The token to mask out prompts, used by draft model data generation.

fineTuningJobs.padToken

string

The token for padding, used by draft model data generation.

fineTuningJobs.wandbUrl

string

The Weights & Biases url to see training progress.

fineTuningJobs.wandbEntity

string

The Weights & Biases entity where training progress should be reported. If unspecified, then progress will not be reported to W&B.

fineTuningJobs.wandbApiKey

string

The Weights & Biases API key associated with the entity. Required if and only if wandb_entity is specified.

fineTuningJobs.wandbProject

string

The Weights & Biases project where training progress should be reported. Required if and only if wandb_entity is specified.

fineTuningJobs.evaluation

boolean

fineTuningJobs.evaluationSplit

number

the split flag to take from training dataset for evaluation.

fineTuningJobs.evaluationDataset

string

the dataset to use for evaluation.

fineTuningJobs.dependentJobs

string[]

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

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

{
  "fineTuningJobs": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "state": "STATE_UNSPECIFIED",
      "dataset": "<string>",
      "datasets": [
        {
          "dataset": "<string>"
        }
      ],
      "status": {
        "code": "OK",
        "message": "<string>"
      },
      "createdBy": "<string>",
      "containerVersion": "<string>",
      "modelId": "<string>",
      "legacyJob": {},
      "textCompletion": {
        "inputTemplate": "<string>",
        "outputTemplate": "<string>"
      },
      "textClassification": {
        "text": "<string>",
        "label": "<string>"
      },
      "conversation": {
        "jinjaTemplate": "<string>"
      },
      "draftModelData": {
        "deploymentName": "<string>",
        "jinjaTemplate": "<string>",
        "cleanupDeployment": true
      },
      "draftModel": {},
      "genie": {
        "pipelineName": "<string>"
      },
      "baseModel": "<string>",
      "warmStartFrom": "<string>",
      "epochs": 123,
      "learningRate": 123,
      "loraRank": 123,
      "loraTargetModules": [
        "<string>"
      ],
      "batchSize": 123,
      "microBatchSize": 123,
      "maskToken": "<string>",
      "padToken": "<string>",
      "wandbUrl": "<string>",
      "wandbEntity": "<string>",
      "wandbApiKey": "<string>",
      "wandbProject": "<string>",
      "evaluation": true,
      "evaluationSplit": 123,
      "evaluationDataset": "<string>",
      "dependentJobs": [
        "<string>"
      ]
    }
  ],
  "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

Authorizations

Path Parameters

Query Parameters

Response