Create fine-tuning job

POST

fine-tuning

jobs

curl --request POST \
  --url https://console.sqwish.ai/v1/fine-tuning/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset_id": "<string>",
  "model": "sqwish-d1-core",
  "method": "sft",
  "hyperparameters": {
    "steps": 1000,
    "learning_rate": 0.00005,
    "lora_rank": 8,
    "seed": 42,
    "checkpoint_every": 10,
    "kl_coefficient": 0.05
  },
  "validation_fraction": 0.2,
  "model_name": "<string>",
  "parent": "<string>",
  "replay": 1
}
'

import requests

url = "https://console.sqwish.ai/v1/fine-tuning/jobs"

payload = {
    "dataset_id": "<string>",
    "model": "sqwish-d1-core",
    "method": "sft",
    "hyperparameters": {
        "steps": 1000,
        "learning_rate": 0.00005,
        "lora_rank": 8,
        "seed": 42,
        "checkpoint_every": 10,
        "kl_coefficient": 0.05
    },
    "validation_fraction": 0.2,
    "model_name": "<string>",
    "parent": "<string>",
    "replay": 1
}
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_id: '<string>',
    model: 'sqwish-d1-core',
    method: 'sft',
    hyperparameters: {
      steps: 1000,
      learning_rate: 0.00005,
      lora_rank: 8,
      seed: 42,
      checkpoint_every: 10,
      kl_coefficient: 0.05
    },
    validation_fraction: 0.2,
    model_name: '<string>',
    parent: '<string>',
    replay: 1
  })
};

fetch('https://console.sqwish.ai/v1/fine-tuning/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "dataset_id": "<string>",
  "model": "<string>",
  "method": "sft",
  "hyperparameters": {
    "steps": 123,
    "learning_rate": 123,
    "lora_rank": 123,
    "seed": 123,
    "checkpoint_every": 123,
    "kl_coefficient": 123,
    "gradient_accumulation": 123,
    "max_prompt_tokens": 123
  },
  "validation_fraction": 123,
  "model_name": "<string>",
  "parent": "<string>",
  "replay": 123,
  "status": "queued",
  "created_at": 123,
  "updated_at": 123,
  "attempts": 123,
  "output_model": "<string>",
  "metrics": {},
  "error": "<string>",
  "progress": {},
  "base_model": "<string>",
  "base_revision": "<string>",
  "base_id": "<string>",
  "initialization": {},
  "base_artifact_sha256": "<string>",
  "compute_dtype": "<string>",
  "layout": "<string>",
  "limits": {},
  "full_spec_sha256": "<string>",
  "split": {},
  "lineage": {},
  "price_cents": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Create an API key in the console. Required when accounts are enabled.

Headers

idempotency-key

string | null

Body

application/json

dataset_id

string

required

Pattern: ^ds_[a-f0-9]{24}$

model

enum<string>

default:sqwish-d1-core

Available options:

sqwish-d1-core,

sqwish-d1-bit,

sqwish-d1-dot

method

enum<string>

default:sft

Available options:

sft,

reward

hyperparameters

Hyperparameters · object

Show child attributes

validation_fraction

number

default:0.2

Required range: 0.1 <= x <= 0.5

model_name

string | null

Pattern: ^[a-z][a-z0-9-]{1,62}$

parent

string | null

Required string length: 1 - 140

replay

number

default:1

Required range: 0 <= x <= 4

Response

Successful Response

string

required

dataset_id

string

required

model

string

required

method

enum<string>

required

Available options:

sft,

reward

hyperparameters

ResolvedHyperparameters · object

required

Show child attributes

validation_fraction

number

required

model_name

string | null

required

parent

string | null

required

replay

number

required

status

enum<string>

required

Available options:

queued,

running,

cancelling,

succeeded,

failed,

cancelled

created_at

number

required

updated_at

number

required

attempts

integer

required

output_model

string | null

required

metrics

Metrics · object | null

required

Evaluation groups and promotion gate, when complete.

error

required

progress

Progress · object | null

required

base_model

string

required

base_revision

string

required

base_id

string | null

required

initialization

Initialization · object | null

required

base_artifact_sha256

string | null

required

compute_dtype

string

required

layout

string

required

limits

Limits · object

required

Show child attributes

full_spec_sha256

string

required

split

Split · object

required

Show child attributes

lineage

Lineage · object | null

required

price_cents

integer

required

Create fine-tuning job

curl --request POST \
  --url https://console.sqwish.ai/v1/fine-tuning/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset_id": "<string>",
  "model": "sqwish-d1-core",
  "method": "sft",
  "hyperparameters": {
    "steps": 1000,
    "learning_rate": 0.00005,
    "lora_rank": 8,
    "seed": 42,
    "checkpoint_every": 10,
    "kl_coefficient": 0.05
  },
  "validation_fraction": 0.2,
  "model_name": "<string>",
  "parent": "<string>",
  "replay": 1
}
'

import requests

url = "https://console.sqwish.ai/v1/fine-tuning/jobs"

payload = {
    "dataset_id": "<string>",
    "model": "sqwish-d1-core",
    "method": "sft",
    "hyperparameters": {
        "steps": 1000,
        "learning_rate": 0.00005,
        "lora_rank": 8,
        "seed": 42,
        "checkpoint_every": 10,
        "kl_coefficient": 0.05
    },
    "validation_fraction": 0.2,
    "model_name": "<string>",
    "parent": "<string>",
    "replay": 1
}
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_id: '<string>',
    model: 'sqwish-d1-core',
    method: 'sft',
    hyperparameters: {
      steps: 1000,
      learning_rate: 0.00005,
      lora_rank: 8,
      seed: 42,
      checkpoint_every: 10,
      kl_coefficient: 0.05
    },
    validation_fraction: 0.2,
    model_name: '<string>',
    parent: '<string>',
    replay: 1
  })
};

fetch('https://console.sqwish.ai/v1/fine-tuning/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "dataset_id": "<string>",
  "model": "<string>",
  "method": "sft",
  "hyperparameters": {
    "steps": 123,
    "learning_rate": 123,
    "lora_rank": 123,
    "seed": 123,
    "checkpoint_every": 123,
    "kl_coefficient": 123,
    "gradient_accumulation": 123,
    "max_prompt_tokens": 123
  },
  "validation_fraction": 123,
  "model_name": "<string>",
  "parent": "<string>",
  "replay": 123,
  "status": "queued",
  "created_at": 123,
  "updated_at": 123,
  "attempts": 123,
  "output_model": "<string>",
  "metrics": {},
  "error": "<string>",
  "progress": {},
  "base_model": "<string>",
  "base_revision": "<string>",
  "base_id": "<string>",
  "initialization": {},
  "base_artifact_sha256": "<string>",
  "compute_dtype": "<string>",
  "layout": "<string>",
  "limits": {},
  "full_spec_sha256": "<string>",
  "split": {},
  "lineage": {},
  "price_cents": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "details": [
      {
        "path": [
          "<string>"
        ],
        "message": "<string>",
        "type": "<string>"
      }
    ]
  }
}

Decisions

Feedback

Models

Datasets

Fine-tuning

Prompt tuning

Labeling

Accounts

Billing

Integrations

System

Create fine-tuning job

Authorizations

Headers

Body

Response