Create DPO Job

POST

accounts

{account_id}

dpoJobs

cURL

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset": "<string>",
  "displayName": "<string>",
  "trainingConfig": {
    "outputModel": "<string>",
    "baseModel": "<string>",
    "warmStartFrom": "<string>",
    "jinjaTemplate": "<string>",
    "learningRate": 123,
    "maxContextLength": 123,
    "loraRank": 123,
    "epochs": 123,
    "batchSize": 123,
    "gradientAccumulationSteps": 123,
    "learningRateWarmupSteps": 123,
    "batchSizeSamples": 123,
    "optimizerWeightDecay": 123,
    "trainerShardingScheme": {
      "tensorParallelism": 123,
      "pipelineParallelism": 123,
      "contextParallelism": 123,
      "expertParallelism": 123,
      "sequenceParallelism": true
    },
    "loraAlpha": 123,
    "loraDropout": 123,
    "loraTargetModules": [
      "<string>"
    ],
    "lrScheduler": {
      "constant": {},
      "linear": {
        "minLrRatio": 123,
        "decayRatio": 123
      },
      "cosine": {
        "minLrRatio": 123,
        "decayRatio": 123
      }
    }
  },
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>"
  },
  "lossConfig": {
    "method": "METHOD_UNSPECIFIED",
    "klBeta": 123,
    "dpo": {
      "beta": 123,
      "refCacheConcurrency": 123,
      "refCacheBatchSize": 123
    },
    "orpo": {
      "lambda": 123
    }
  },
  "awsS3Config": {
    "credentialsSecret": "<string>",
    "iamRoleArn": "<string>"
  },
  "azureBlobStorageConfig": {
    "credentialsSecret": "<string>",
    "managedIdentityClientId": "<string>",
    "tenantId": "<string>"
  },
  "purpose": "PURPOSE_UNSPECIFIED",
  "useReservation": true
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs"

payload = {
    "dataset": "<string>",
    "displayName": "<string>",
    "trainingConfig": {
        "outputModel": "<string>",
        "baseModel": "<string>",
        "warmStartFrom": "<string>",
        "jinjaTemplate": "<string>",
        "learningRate": 123,
        "maxContextLength": 123,
        "loraRank": 123,
        "epochs": 123,
        "batchSize": 123,
        "gradientAccumulationSteps": 123,
        "learningRateWarmupSteps": 123,
        "batchSizeSamples": 123,
        "optimizerWeightDecay": 123,
        "trainerShardingScheme": {
            "tensorParallelism": 123,
            "pipelineParallelism": 123,
            "contextParallelism": 123,
            "expertParallelism": 123,
            "sequenceParallelism": True
        },
        "loraAlpha": 123,
        "loraDropout": 123,
        "loraTargetModules": ["<string>"],
        "lrScheduler": {
            "constant": {},
            "linear": {
                "minLrRatio": 123,
                "decayRatio": 123
            },
            "cosine": {
                "minLrRatio": 123,
                "decayRatio": 123
            }
        }
    },
    "wandbConfig": {
        "enabled": True,
        "apiKey": "<string>",
        "project": "<string>",
        "entity": "<string>",
        "runId": "<string>"
    },
    "lossConfig": {
        "method": "METHOD_UNSPECIFIED",
        "klBeta": 123,
        "dpo": {
            "beta": 123,
            "refCacheConcurrency": 123,
            "refCacheBatchSize": 123
        },
        "orpo": { "lambda": 123 }
    },
    "awsS3Config": {
        "credentialsSecret": "<string>",
        "iamRoleArn": "<string>"
    },
    "azureBlobStorageConfig": {
        "credentialsSecret": "<string>",
        "managedIdentityClientId": "<string>",
        "tenantId": "<string>"
    },
    "purpose": "PURPOSE_UNSPECIFIED",
    "useReservation": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dataset: '<string>',
    displayName: '<string>',
    trainingConfig: {
      outputModel: '<string>',
      baseModel: '<string>',
      warmStartFrom: '<string>',
      jinjaTemplate: '<string>',
      learningRate: 123,
      maxContextLength: 123,
      loraRank: 123,
      epochs: 123,
      batchSize: 123,
      gradientAccumulationSteps: 123,
      learningRateWarmupSteps: 123,
      batchSizeSamples: 123,
      optimizerWeightDecay: 123,
      trainerShardingScheme: {
        tensorParallelism: 123,
        pipelineParallelism: 123,
        contextParallelism: 123,
        expertParallelism: 123,
        sequenceParallelism: true
      },
      loraAlpha: 123,
      loraDropout: 123,
      loraTargetModules: ['<string>'],
      lrScheduler: {
        constant: {},
        linear: {minLrRatio: 123, decayRatio: 123},
        cosine: {minLrRatio: 123, decayRatio: 123}
      }
    },
    wandbConfig: {
      enabled: true,
      apiKey: '<string>',
      project: '<string>',
      entity: '<string>',
      runId: '<string>'
    },
    lossConfig: {
      method: 'METHOD_UNSPECIFIED',
      klBeta: 123,
      dpo: {beta: 123, refCacheConcurrency: 123, refCacheBatchSize: 123},
      orpo: {lambda: 123}
    },
    awsS3Config: {credentialsSecret: '<string>', iamRoleArn: '<string>'},
    azureBlobStorageConfig: {
      credentialsSecret: '<string>',
      managedIdentityClientId: '<string>',
      tenantId: '<string>'
    },
    purpose: 'PURPOSE_UNSPECIFIED',
    useReservation: true
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dataset' => '<string>',
    'displayName' => '<string>',
    'trainingConfig' => [
        'outputModel' => '<string>',
        'baseModel' => '<string>',
        'warmStartFrom' => '<string>',
        'jinjaTemplate' => '<string>',
        'learningRate' => 123,
        'maxContextLength' => 123,
        'loraRank' => 123,
        'epochs' => 123,
        'batchSize' => 123,
        'gradientAccumulationSteps' => 123,
        'learningRateWarmupSteps' => 123,
        'batchSizeSamples' => 123,
        'optimizerWeightDecay' => 123,
        'trainerShardingScheme' => [
                'tensorParallelism' => 123,
                'pipelineParallelism' => 123,
                'contextParallelism' => 123,
                'expertParallelism' => 123,
                'sequenceParallelism' => true
        ],
        'loraAlpha' => 123,
        'loraDropout' => 123,
        'loraTargetModules' => [
                '<string>'
        ],
        'lrScheduler' => [
                'constant' => [
                                
                ],
                'linear' => [
                                'minLrRatio' => 123,
                                'decayRatio' => 123
                ],
                'cosine' => [
                                'minLrRatio' => 123,
                                'decayRatio' => 123
                ]
        ]
    ],
    'wandbConfig' => [
        'enabled' => true,
        'apiKey' => '<string>',
        'project' => '<string>',
        'entity' => '<string>',
        'runId' => '<string>'
    ],
    'lossConfig' => [
        'method' => 'METHOD_UNSPECIFIED',
        'klBeta' => 123,
        'dpo' => [
                'beta' => 123,
                'refCacheConcurrency' => 123,
                'refCacheBatchSize' => 123
        ],
        'orpo' => [
                'lambda' => 123
        ]
    ],
    'awsS3Config' => [
        'credentialsSecret' => '<string>',
        'iamRoleArn' => '<string>'
    ],
    'azureBlobStorageConfig' => [
        'credentialsSecret' => '<string>',
        'managedIdentityClientId' => '<string>',
        'tenantId' => '<string>'
    ],
    'purpose' => 'PURPOSE_UNSPECIFIED',
    'useReservation' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs"

	payload := strings.NewReader("{\n  \"dataset\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"trainingConfig\": {\n    \"outputModel\": \"<string>\",\n    \"baseModel\": \"<string>\",\n    \"warmStartFrom\": \"<string>\",\n    \"jinjaTemplate\": \"<string>\",\n    \"learningRate\": 123,\n    \"maxContextLength\": 123,\n    \"loraRank\": 123,\n    \"epochs\": 123,\n    \"batchSize\": 123,\n    \"gradientAccumulationSteps\": 123,\n    \"learningRateWarmupSteps\": 123,\n    \"batchSizeSamples\": 123,\n    \"optimizerWeightDecay\": 123,\n    \"trainerShardingScheme\": {\n      \"tensorParallelism\": 123,\n      \"pipelineParallelism\": 123,\n      \"contextParallelism\": 123,\n      \"expertParallelism\": 123,\n      \"sequenceParallelism\": true\n    },\n    \"loraAlpha\": 123,\n    \"loraDropout\": 123,\n    \"loraTargetModules\": [\n      \"<string>\"\n    ],\n    \"lrScheduler\": {\n      \"constant\": {},\n      \"linear\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      },\n      \"cosine\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      }\n    }\n  },\n  \"wandbConfig\": {\n    \"enabled\": true,\n    \"apiKey\": \"<string>\",\n    \"project\": \"<string>\",\n    \"entity\": \"<string>\",\n    \"runId\": \"<string>\"\n  },\n  \"lossConfig\": {\n    \"method\": \"METHOD_UNSPECIFIED\",\n    \"klBeta\": 123,\n    \"dpo\": {\n      \"beta\": 123,\n      \"refCacheConcurrency\": 123,\n      \"refCacheBatchSize\": 123\n    },\n    \"orpo\": {\n      \"lambda\": 123\n    }\n  },\n  \"awsS3Config\": {\n    \"credentialsSecret\": \"<string>\",\n    \"iamRoleArn\": \"<string>\"\n  },\n  \"azureBlobStorageConfig\": {\n    \"credentialsSecret\": \"<string>\",\n    \"managedIdentityClientId\": \"<string>\",\n    \"tenantId\": \"<string>\"\n  },\n  \"purpose\": \"PURPOSE_UNSPECIFIED\",\n  \"useReservation\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"trainingConfig\": {\n    \"outputModel\": \"<string>\",\n    \"baseModel\": \"<string>\",\n    \"warmStartFrom\": \"<string>\",\n    \"jinjaTemplate\": \"<string>\",\n    \"learningRate\": 123,\n    \"maxContextLength\": 123,\n    \"loraRank\": 123,\n    \"epochs\": 123,\n    \"batchSize\": 123,\n    \"gradientAccumulationSteps\": 123,\n    \"learningRateWarmupSteps\": 123,\n    \"batchSizeSamples\": 123,\n    \"optimizerWeightDecay\": 123,\n    \"trainerShardingScheme\": {\n      \"tensorParallelism\": 123,\n      \"pipelineParallelism\": 123,\n      \"contextParallelism\": 123,\n      \"expertParallelism\": 123,\n      \"sequenceParallelism\": true\n    },\n    \"loraAlpha\": 123,\n    \"loraDropout\": 123,\n    \"loraTargetModules\": [\n      \"<string>\"\n    ],\n    \"lrScheduler\": {\n      \"constant\": {},\n      \"linear\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      },\n      \"cosine\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      }\n    }\n  },\n  \"wandbConfig\": {\n    \"enabled\": true,\n    \"apiKey\": \"<string>\",\n    \"project\": \"<string>\",\n    \"entity\": \"<string>\",\n    \"runId\": \"<string>\"\n  },\n  \"lossConfig\": {\n    \"method\": \"METHOD_UNSPECIFIED\",\n    \"klBeta\": 123,\n    \"dpo\": {\n      \"beta\": 123,\n      \"refCacheConcurrency\": 123,\n      \"refCacheBatchSize\": 123\n    },\n    \"orpo\": {\n      \"lambda\": 123\n    }\n  },\n  \"awsS3Config\": {\n    \"credentialsSecret\": \"<string>\",\n    \"iamRoleArn\": \"<string>\"\n  },\n  \"azureBlobStorageConfig\": {\n    \"credentialsSecret\": \"<string>\",\n    \"managedIdentityClientId\": \"<string>\",\n    \"tenantId\": \"<string>\"\n  },\n  \"purpose\": \"PURPOSE_UNSPECIFIED\",\n  \"useReservation\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"trainingConfig\": {\n    \"outputModel\": \"<string>\",\n    \"baseModel\": \"<string>\",\n    \"warmStartFrom\": \"<string>\",\n    \"jinjaTemplate\": \"<string>\",\n    \"learningRate\": 123,\n    \"maxContextLength\": 123,\n    \"loraRank\": 123,\n    \"epochs\": 123,\n    \"batchSize\": 123,\n    \"gradientAccumulationSteps\": 123,\n    \"learningRateWarmupSteps\": 123,\n    \"batchSizeSamples\": 123,\n    \"optimizerWeightDecay\": 123,\n    \"trainerShardingScheme\": {\n      \"tensorParallelism\": 123,\n      \"pipelineParallelism\": 123,\n      \"contextParallelism\": 123,\n      \"expertParallelism\": 123,\n      \"sequenceParallelism\": true\n    },\n    \"loraAlpha\": 123,\n    \"loraDropout\": 123,\n    \"loraTargetModules\": [\n      \"<string>\"\n    ],\n    \"lrScheduler\": {\n      \"constant\": {},\n      \"linear\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      },\n      \"cosine\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      }\n    }\n  },\n  \"wandbConfig\": {\n    \"enabled\": true,\n    \"apiKey\": \"<string>\",\n    \"project\": \"<string>\",\n    \"entity\": \"<string>\",\n    \"runId\": \"<string>\"\n  },\n  \"lossConfig\": {\n    \"method\": \"METHOD_UNSPECIFIED\",\n    \"klBeta\": 123,\n    \"dpo\": {\n      \"beta\": 123,\n      \"refCacheConcurrency\": 123,\n      \"refCacheBatchSize\": 123\n    },\n    \"orpo\": {\n      \"lambda\": 123\n    }\n  },\n  \"awsS3Config\": {\n    \"credentialsSecret\": \"<string>\",\n    \"iamRoleArn\": \"<string>\"\n  },\n  \"azureBlobStorageConfig\": {\n    \"credentialsSecret\": \"<string>\",\n    \"managedIdentityClientId\": \"<string>\",\n    \"tenantId\": \"<string>\"\n  },\n  \"purpose\": \"PURPOSE_UNSPECIFIED\",\n  \"useReservation\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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,
    "epochs": 123,
    "batchSize": 123,
    "gradientAccumulationSteps": 123,
    "learningRateWarmupSteps": 123,
    "batchSizeSamples": 123,
    "optimizerWeightDecay": 123,
    "trainerShardingScheme": {
      "tensorParallelism": 123,
      "pipelineParallelism": 123,
      "contextParallelism": 123,
      "expertParallelism": 123,
      "sequenceParallelism": true
    },
    "loraAlpha": 123,
    "loraDropout": 123,
    "loraTargetModules": [
      "<string>"
    ],
    "lrScheduler": {
      "constant": {},
      "linear": {
        "minLrRatio": 123,
        "decayRatio": 123
      },
      "cosine": {
        "minLrRatio": 123,
        "decayRatio": 123
      }
    }
  },
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>",
    "url": "<string>"
  },
  "trainerLogsSignedUrl": "<string>",
  "lossConfig": {
    "method": "METHOD_UNSPECIFIED",
    "klBeta": 123,
    "dpo": {
      "beta": 123,
      "refCacheConcurrency": 123,
      "refCacheBatchSize": 123
    },
    "orpo": {
      "lambda": 123
    }
  },
  "awsS3Config": {
    "credentialsSecret": "<string>",
    "iamRoleArn": "<string>"
  },
  "azureBlobStorageConfig": {
    "credentialsSecret": "<string>",
    "managedIdentityClientId": "<string>",
    "tenantId": "<string>"
  },
  "purpose": "PURPOSE_UNSPECIFIED",
  "useReservation": true
}

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

Query Parameters

dpoJobId

string

ID of the DPO job, a random ID will be generated if not specified.

Body

application/json

dataset

string

required

The name of the dataset used for training.

displayName

string

trainingConfig

BaseTrainingConfig contains common configuration fields shared across different training job types. · object

Common training configurations.

Show child attributes

wandbConfig

object

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

Show child attributes

lossConfig

object

Loss configuration for the training job. If not specified, defaults to DPO loss. Set method to ORPO for ORPO training.

Show child attributes

awsS3Config

object

The AWS configuration for S3 dataset access.

Show child attributes

azureBlobStorageConfig

object

The Azure configuration for Azure Blob Storage dataset access.

Show child attributes

purpose

enum<string>

default:PURPOSE_UNSPECIFIED

Scheduling purpose for this job.

Available options:

PURPOSE_UNSPECIFIED,

PURPOSE_PILOT

useReservation

boolean

Whether to try the account's reservation capacity before falling back to shared trainer capacity.

Response

200 - application/json

A successful response.

dataset

string

required

The name of the dataset used for training.

name

string

read-only

displayName

string

createTime

string<date-time>

read-only

completedTime

string<date-time>

read-only

state

enum<string>

default:JOB_STATE_UNSPECIFIED

read-only

JobState represents the state an asynchronous job can be in.

JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
JOB_STATE_DELETED: Job has been deleted.
JOB_STATE_ARCHIVED: User-facing state for jobs whose row is retained post-delete (e.g. RLOR trainers within the checkpoint retention window). The internal row is still in JOB_STATE_DELETED; the gateway translates it to ARCHIVED on public responses.

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,

JOB_STATE_DELETED,

JOB_STATE_ARCHIVED

status

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

read-only

Show child attributes

createdBy

string

read-only

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

trainingConfig

BaseTrainingConfig contains common configuration fields shared across different training job types. · object

Common training configurations.

Show child attributes

wandbConfig

object

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

Show child attributes

trainerLogsSignedUrl

string

read-only

The signed URL for the trainer logs file (stdout/stderr). Only populated if the account has trainer log reading enabled.

lossConfig

object

Loss configuration for the training job. If not specified, defaults to DPO loss. Set method to ORPO for ORPO training.

Show child attributes

awsS3Config

object

The AWS configuration for S3 dataset access.

Show child attributes

azureBlobStorageConfig

object

The Azure configuration for Azure Blob Storage dataset access.

Show child attributes

purpose

enum<string>

default:PURPOSE_UNSPECIFIED

Scheduling purpose for this job.

Available options:

PURPOSE_UNSPECIFIED,

PURPOSE_PILOT

useReservation

boolean

Whether to try the account's reservation capacity before falling back to shared trainer capacity.

cURL

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset": "<string>",
  "displayName": "<string>",
  "trainingConfig": {
    "outputModel": "<string>",
    "baseModel": "<string>",
    "warmStartFrom": "<string>",
    "jinjaTemplate": "<string>",
    "learningRate": 123,
    "maxContextLength": 123,
    "loraRank": 123,
    "epochs": 123,
    "batchSize": 123,
    "gradientAccumulationSteps": 123,
    "learningRateWarmupSteps": 123,
    "batchSizeSamples": 123,
    "optimizerWeightDecay": 123,
    "trainerShardingScheme": {
      "tensorParallelism": 123,
      "pipelineParallelism": 123,
      "contextParallelism": 123,
      "expertParallelism": 123,
      "sequenceParallelism": true
    },
    "loraAlpha": 123,
    "loraDropout": 123,
    "loraTargetModules": [
      "<string>"
    ],
    "lrScheduler": {
      "constant": {},
      "linear": {
        "minLrRatio": 123,
        "decayRatio": 123
      },
      "cosine": {
        "minLrRatio": 123,
        "decayRatio": 123
      }
    }
  },
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>"
  },
  "lossConfig": {
    "method": "METHOD_UNSPECIFIED",
    "klBeta": 123,
    "dpo": {
      "beta": 123,
      "refCacheConcurrency": 123,
      "refCacheBatchSize": 123
    },
    "orpo": {
      "lambda": 123
    }
  },
  "awsS3Config": {
    "credentialsSecret": "<string>",
    "iamRoleArn": "<string>"
  },
  "azureBlobStorageConfig": {
    "credentialsSecret": "<string>",
    "managedIdentityClientId": "<string>",
    "tenantId": "<string>"
  },
  "purpose": "PURPOSE_UNSPECIFIED",
  "useReservation": true
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs"

payload = {
    "dataset": "<string>",
    "displayName": "<string>",
    "trainingConfig": {
        "outputModel": "<string>",
        "baseModel": "<string>",
        "warmStartFrom": "<string>",
        "jinjaTemplate": "<string>",
        "learningRate": 123,
        "maxContextLength": 123,
        "loraRank": 123,
        "epochs": 123,
        "batchSize": 123,
        "gradientAccumulationSteps": 123,
        "learningRateWarmupSteps": 123,
        "batchSizeSamples": 123,
        "optimizerWeightDecay": 123,
        "trainerShardingScheme": {
            "tensorParallelism": 123,
            "pipelineParallelism": 123,
            "contextParallelism": 123,
            "expertParallelism": 123,
            "sequenceParallelism": True
        },
        "loraAlpha": 123,
        "loraDropout": 123,
        "loraTargetModules": ["<string>"],
        "lrScheduler": {
            "constant": {},
            "linear": {
                "minLrRatio": 123,
                "decayRatio": 123
            },
            "cosine": {
                "minLrRatio": 123,
                "decayRatio": 123
            }
        }
    },
    "wandbConfig": {
        "enabled": True,
        "apiKey": "<string>",
        "project": "<string>",
        "entity": "<string>",
        "runId": "<string>"
    },
    "lossConfig": {
        "method": "METHOD_UNSPECIFIED",
        "klBeta": 123,
        "dpo": {
            "beta": 123,
            "refCacheConcurrency": 123,
            "refCacheBatchSize": 123
        },
        "orpo": { "lambda": 123 }
    },
    "awsS3Config": {
        "credentialsSecret": "<string>",
        "iamRoleArn": "<string>"
    },
    "azureBlobStorageConfig": {
        "credentialsSecret": "<string>",
        "managedIdentityClientId": "<string>",
        "tenantId": "<string>"
    },
    "purpose": "PURPOSE_UNSPECIFIED",
    "useReservation": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dataset: '<string>',
    displayName: '<string>',
    trainingConfig: {
      outputModel: '<string>',
      baseModel: '<string>',
      warmStartFrom: '<string>',
      jinjaTemplate: '<string>',
      learningRate: 123,
      maxContextLength: 123,
      loraRank: 123,
      epochs: 123,
      batchSize: 123,
      gradientAccumulationSteps: 123,
      learningRateWarmupSteps: 123,
      batchSizeSamples: 123,
      optimizerWeightDecay: 123,
      trainerShardingScheme: {
        tensorParallelism: 123,
        pipelineParallelism: 123,
        contextParallelism: 123,
        expertParallelism: 123,
        sequenceParallelism: true
      },
      loraAlpha: 123,
      loraDropout: 123,
      loraTargetModules: ['<string>'],
      lrScheduler: {
        constant: {},
        linear: {minLrRatio: 123, decayRatio: 123},
        cosine: {minLrRatio: 123, decayRatio: 123}
      }
    },
    wandbConfig: {
      enabled: true,
      apiKey: '<string>',
      project: '<string>',
      entity: '<string>',
      runId: '<string>'
    },
    lossConfig: {
      method: 'METHOD_UNSPECIFIED',
      klBeta: 123,
      dpo: {beta: 123, refCacheConcurrency: 123, refCacheBatchSize: 123},
      orpo: {lambda: 123}
    },
    awsS3Config: {credentialsSecret: '<string>', iamRoleArn: '<string>'},
    azureBlobStorageConfig: {
      credentialsSecret: '<string>',
      managedIdentityClientId: '<string>',
      tenantId: '<string>'
    },
    purpose: 'PURPOSE_UNSPECIFIED',
    useReservation: true
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dataset' => '<string>',
    'displayName' => '<string>',
    'trainingConfig' => [
        'outputModel' => '<string>',
        'baseModel' => '<string>',
        'warmStartFrom' => '<string>',
        'jinjaTemplate' => '<string>',
        'learningRate' => 123,
        'maxContextLength' => 123,
        'loraRank' => 123,
        'epochs' => 123,
        'batchSize' => 123,
        'gradientAccumulationSteps' => 123,
        'learningRateWarmupSteps' => 123,
        'batchSizeSamples' => 123,
        'optimizerWeightDecay' => 123,
        'trainerShardingScheme' => [
                'tensorParallelism' => 123,
                'pipelineParallelism' => 123,
                'contextParallelism' => 123,
                'expertParallelism' => 123,
                'sequenceParallelism' => true
        ],
        'loraAlpha' => 123,
        'loraDropout' => 123,
        'loraTargetModules' => [
                '<string>'
        ],
        'lrScheduler' => [
                'constant' => [
                                
                ],
                'linear' => [
                                'minLrRatio' => 123,
                                'decayRatio' => 123
                ],
                'cosine' => [
                                'minLrRatio' => 123,
                                'decayRatio' => 123
                ]
        ]
    ],
    'wandbConfig' => [
        'enabled' => true,
        'apiKey' => '<string>',
        'project' => '<string>',
        'entity' => '<string>',
        'runId' => '<string>'
    ],
    'lossConfig' => [
        'method' => 'METHOD_UNSPECIFIED',
        'klBeta' => 123,
        'dpo' => [
                'beta' => 123,
                'refCacheConcurrency' => 123,
                'refCacheBatchSize' => 123
        ],
        'orpo' => [
                'lambda' => 123
        ]
    ],
    'awsS3Config' => [
        'credentialsSecret' => '<string>',
        'iamRoleArn' => '<string>'
    ],
    'azureBlobStorageConfig' => [
        'credentialsSecret' => '<string>',
        'managedIdentityClientId' => '<string>',
        'tenantId' => '<string>'
    ],
    'purpose' => 'PURPOSE_UNSPECIFIED',
    'useReservation' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs"

	payload := strings.NewReader("{\n  \"dataset\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"trainingConfig\": {\n    \"outputModel\": \"<string>\",\n    \"baseModel\": \"<string>\",\n    \"warmStartFrom\": \"<string>\",\n    \"jinjaTemplate\": \"<string>\",\n    \"learningRate\": 123,\n    \"maxContextLength\": 123,\n    \"loraRank\": 123,\n    \"epochs\": 123,\n    \"batchSize\": 123,\n    \"gradientAccumulationSteps\": 123,\n    \"learningRateWarmupSteps\": 123,\n    \"batchSizeSamples\": 123,\n    \"optimizerWeightDecay\": 123,\n    \"trainerShardingScheme\": {\n      \"tensorParallelism\": 123,\n      \"pipelineParallelism\": 123,\n      \"contextParallelism\": 123,\n      \"expertParallelism\": 123,\n      \"sequenceParallelism\": true\n    },\n    \"loraAlpha\": 123,\n    \"loraDropout\": 123,\n    \"loraTargetModules\": [\n      \"<string>\"\n    ],\n    \"lrScheduler\": {\n      \"constant\": {},\n      \"linear\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      },\n      \"cosine\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      }\n    }\n  },\n  \"wandbConfig\": {\n    \"enabled\": true,\n    \"apiKey\": \"<string>\",\n    \"project\": \"<string>\",\n    \"entity\": \"<string>\",\n    \"runId\": \"<string>\"\n  },\n  \"lossConfig\": {\n    \"method\": \"METHOD_UNSPECIFIED\",\n    \"klBeta\": 123,\n    \"dpo\": {\n      \"beta\": 123,\n      \"refCacheConcurrency\": 123,\n      \"refCacheBatchSize\": 123\n    },\n    \"orpo\": {\n      \"lambda\": 123\n    }\n  },\n  \"awsS3Config\": {\n    \"credentialsSecret\": \"<string>\",\n    \"iamRoleArn\": \"<string>\"\n  },\n  \"azureBlobStorageConfig\": {\n    \"credentialsSecret\": \"<string>\",\n    \"managedIdentityClientId\": \"<string>\",\n    \"tenantId\": \"<string>\"\n  },\n  \"purpose\": \"PURPOSE_UNSPECIFIED\",\n  \"useReservation\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"trainingConfig\": {\n    \"outputModel\": \"<string>\",\n    \"baseModel\": \"<string>\",\n    \"warmStartFrom\": \"<string>\",\n    \"jinjaTemplate\": \"<string>\",\n    \"learningRate\": 123,\n    \"maxContextLength\": 123,\n    \"loraRank\": 123,\n    \"epochs\": 123,\n    \"batchSize\": 123,\n    \"gradientAccumulationSteps\": 123,\n    \"learningRateWarmupSteps\": 123,\n    \"batchSizeSamples\": 123,\n    \"optimizerWeightDecay\": 123,\n    \"trainerShardingScheme\": {\n      \"tensorParallelism\": 123,\n      \"pipelineParallelism\": 123,\n      \"contextParallelism\": 123,\n      \"expertParallelism\": 123,\n      \"sequenceParallelism\": true\n    },\n    \"loraAlpha\": 123,\n    \"loraDropout\": 123,\n    \"loraTargetModules\": [\n      \"<string>\"\n    ],\n    \"lrScheduler\": {\n      \"constant\": {},\n      \"linear\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      },\n      \"cosine\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      }\n    }\n  },\n  \"wandbConfig\": {\n    \"enabled\": true,\n    \"apiKey\": \"<string>\",\n    \"project\": \"<string>\",\n    \"entity\": \"<string>\",\n    \"runId\": \"<string>\"\n  },\n  \"lossConfig\": {\n    \"method\": \"METHOD_UNSPECIFIED\",\n    \"klBeta\": 123,\n    \"dpo\": {\n      \"beta\": 123,\n      \"refCacheConcurrency\": 123,\n      \"refCacheBatchSize\": 123\n    },\n    \"orpo\": {\n      \"lambda\": 123\n    }\n  },\n  \"awsS3Config\": {\n    \"credentialsSecret\": \"<string>\",\n    \"iamRoleArn\": \"<string>\"\n  },\n  \"azureBlobStorageConfig\": {\n    \"credentialsSecret\": \"<string>\",\n    \"managedIdentityClientId\": \"<string>\",\n    \"tenantId\": \"<string>\"\n  },\n  \"purpose\": \"PURPOSE_UNSPECIFIED\",\n  \"useReservation\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/dpoJobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"trainingConfig\": {\n    \"outputModel\": \"<string>\",\n    \"baseModel\": \"<string>\",\n    \"warmStartFrom\": \"<string>\",\n    \"jinjaTemplate\": \"<string>\",\n    \"learningRate\": 123,\n    \"maxContextLength\": 123,\n    \"loraRank\": 123,\n    \"epochs\": 123,\n    \"batchSize\": 123,\n    \"gradientAccumulationSteps\": 123,\n    \"learningRateWarmupSteps\": 123,\n    \"batchSizeSamples\": 123,\n    \"optimizerWeightDecay\": 123,\n    \"trainerShardingScheme\": {\n      \"tensorParallelism\": 123,\n      \"pipelineParallelism\": 123,\n      \"contextParallelism\": 123,\n      \"expertParallelism\": 123,\n      \"sequenceParallelism\": true\n    },\n    \"loraAlpha\": 123,\n    \"loraDropout\": 123,\n    \"loraTargetModules\": [\n      \"<string>\"\n    ],\n    \"lrScheduler\": {\n      \"constant\": {},\n      \"linear\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      },\n      \"cosine\": {\n        \"minLrRatio\": 123,\n        \"decayRatio\": 123\n      }\n    }\n  },\n  \"wandbConfig\": {\n    \"enabled\": true,\n    \"apiKey\": \"<string>\",\n    \"project\": \"<string>\",\n    \"entity\": \"<string>\",\n    \"runId\": \"<string>\"\n  },\n  \"lossConfig\": {\n    \"method\": \"METHOD_UNSPECIFIED\",\n    \"klBeta\": 123,\n    \"dpo\": {\n      \"beta\": 123,\n      \"refCacheConcurrency\": 123,\n      \"refCacheBatchSize\": 123\n    },\n    \"orpo\": {\n      \"lambda\": 123\n    }\n  },\n  \"awsS3Config\": {\n    \"credentialsSecret\": \"<string>\",\n    \"iamRoleArn\": \"<string>\"\n  },\n  \"azureBlobStorageConfig\": {\n    \"credentialsSecret\": \"<string>\",\n    \"managedIdentityClientId\": \"<string>\",\n    \"tenantId\": \"<string>\"\n  },\n  \"purpose\": \"PURPOSE_UNSPECIFIED\",\n  \"useReservation\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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,
    "epochs": 123,
    "batchSize": 123,
    "gradientAccumulationSteps": 123,
    "learningRateWarmupSteps": 123,
    "batchSizeSamples": 123,
    "optimizerWeightDecay": 123,
    "trainerShardingScheme": {
      "tensorParallelism": 123,
      "pipelineParallelism": 123,
      "contextParallelism": 123,
      "expertParallelism": 123,
      "sequenceParallelism": true
    },
    "loraAlpha": 123,
    "loraDropout": 123,
    "loraTargetModules": [
      "<string>"
    ],
    "lrScheduler": {
      "constant": {},
      "linear": {
        "minLrRatio": 123,
        "decayRatio": 123
      },
      "cosine": {
        "minLrRatio": 123,
        "decayRatio": 123
      }
    }
  },
  "wandbConfig": {
    "enabled": true,
    "apiKey": "<string>",
    "project": "<string>",
    "entity": "<string>",
    "runId": "<string>",
    "url": "<string>"
  },
  "trainerLogsSignedUrl": "<string>",
  "lossConfig": {
    "method": "METHOD_UNSPECIFIED",
    "klBeta": 123,
    "dpo": {
      "beta": 123,
      "refCacheConcurrency": 123,
      "refCacheBatchSize": 123
    },
    "orpo": {
      "lambda": 123
    }
  },
  "awsS3Config": {
    "credentialsSecret": "<string>",
    "iamRoleArn": "<string>"
  },
  "azureBlobStorageConfig": {
    "credentialsSecret": "<string>",
    "managedIdentityClientId": "<string>",
    "tenantId": "<string>"
  },
  "purpose": "PURPOSE_UNSPECIFIED",
  "useReservation": true
}

API Reference

Inference

Deployments

Training

Training SDK

Admin

Authorizations

Path Parameters

Query Parameters

Body

Response