Get dpo job

cURL

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

{
  "dataset": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "completedTime": "2023-11-07T05:31:56Z",
  "state": "JOB_STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "createdBy": "<string>",
  "trainingConfig": {
    "outputModel": "<string>",
    "baseModel": "<string>",
    "warmStartFrom": "<string>",
    "jinjaTemplate": "<string>",
    "learningRate": 123,
    "maxContextLength": 123,
    "loraRank": 123,
    "region": "REGION_UNSPECIFIED",
    "epochs": 123,
    "batchSize": 123,
    "gradientAccumulationSteps": 123,
    "learningRateWarmupSteps": 123
  },
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>",
    "url": "<string>"
  }
}

GET

accounts

{account_id}

dpoJobs

{dpo_job_id}

cURL

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

{
  "dataset": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "completedTime": "2023-11-07T05:31:56Z",
  "state": "JOB_STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "createdBy": "<string>",
  "trainingConfig": {
    "outputModel": "<string>",
    "baseModel": "<string>",
    "warmStartFrom": "<string>",
    "jinjaTemplate": "<string>",
    "learningRate": 123,
    "maxContextLength": 123,
    "loraRank": 123,
    "region": "REGION_UNSPECIFIED",
    "epochs": 123,
    "batchSize": 123,
    "gradientAccumulationSteps": 123,
    "learningRateWarmupSteps": 123
  },
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

dpo_job_id

string

required

The Dpo 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.

JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.

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,

JOB_STATE_IDLE,

JOB_STATE_CANCELLING,

JOB_STATE_EARLY_STOPPED,

JOB_STATE_PAUSED

status

Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object

Show child attributes

status.code

enum<string>

default:OK

The status code.

Available options:

OK,

CANCELLED,

UNKNOWN,

INVALID_ARGUMENT,

DEADLINE_EXCEEDED,

NOT_FOUND,

ALREADY_EXISTS,

PERMISSION_DENIED,

UNAUTHENTICATED,

RESOURCE_EXHAUSTED,

FAILED_PRECONDITION,

ABORTED,

OUT_OF_RANGE,

UNIMPLEMENTED,

INTERNAL,

UNAVAILABLE,

DATA_LOSS

status.message

string

A developer-facing error message in English.

createdBy

string

The email address of the user who initiated this dpo job.

trainingConfig

BaseTrainingConfig contains common configuration fields shared across different training job types. Next ID: 19 · object

Common training configurations.

Show child attributes

trainingConfig.outputModel

string

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

trainingConfig.baseModel

string

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

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

trainingConfig.jinjaTemplate

string

trainingConfig.learningRate

number<float>

The learning rate used for training.

trainingConfig.maxContextLength

integer<int32>

The maximum context length to use with the model.

trainingConfig.loraRank

integer<int32>

The rank of the LoRA layers.

trainingConfig.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_ILLINOIS_1,

AP_TOKYO_1,

US_ARIZONA_1,

US_TEXAS_1,

US_ILLINOIS_2,

EU_FRANKFURT_1,

US_TEXAS_2,

EU_ICELAND_1,

EU_ICELAND_2,

US_WASHINGTON_1,

US_WASHINGTON_2,

US_WASHINGTON_3,

AP_TOKYO_2,

US_CALIFORNIA_1,

US_UTAH_1,

US_TEXAS_3,

US_GEORGIA_1,

US_GEORGIA_2,

US_WASHINGTON_4,

US_GEORGIA_3

trainingConfig.epochs

integer<int32>

The number of epochs to train for.

trainingConfig.batchSize

integer<int32>

The maximum packed number of tokens per batch for training in sequence packing.

trainingConfig.gradientAccumulationSteps

integer<int32>

trainingConfig.learningRateWarmupSteps

integer<int32>

wandbConfig

object

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

Show child attributes

wandbConfig.enabled

boolean

Whether to enable wandb logging.

wandbConfig.apiKey

string

The API key for the wandb service.

wandbConfig.project

string

The project name for the wandb service.

wandbConfig.entity

string

The entity name for the wandb service.

wandbConfig.runId

string

The run ID for the wandb service.

wandbConfig.url

string

The URL for the wandb service.

⌘I

API Reference

Inference

Deployments

Fine-tuning

Multimedia

Admin

Build SDK (Deprecated)

Authorizations

Path Parameters

Query Parameters

Response