List Job

# Docs for v2 can be found by changing the above selector ^
from together import Together
import os

client = Together(
    api_key=os.environ.get("TOGETHER_API_KEY"),
)

fine_tune = client.fine_tuning.retrieve(id="ft-id")

print(fine_tune)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "training_file": "<string>",
  "validation_file": "<string>",
  "model": "<string>",
  "model_output_name": "<string>",
  "model_output_path": "<string>",
  "trainingfile_numlines": 123,
  "trainingfile_size": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "n_epochs": 123,
  "n_checkpoints": 123,
  "n_evals": 123,
  "batch_size": "max",
  "learning_rate": 123,
  "lr_scheduler": {
    "lr_scheduler_type": "linear",
    "lr_scheduler_args": {
      "min_lr_ratio": 0
    }
  },
  "warmup_ratio": 123,
  "max_grad_norm": 123,
  "weight_decay": 123,
  "eval_steps": 123,
  "train_on_inputs": "auto",
  "training_method": {
    "method": "sft",
    "train_on_inputs": "auto"
  },
  "training_type": {
    "type": "Full"
  },
  "job_id": "<string>",
  "events": [
    {
      "object": "fine-tune-event",
      "created_at": "<string>",
      "message": "<string>",
      "type": "job_pending",
      "param_count": 123,
      "token_count": 123,
      "total_steps": 123,
      "wandb_url": "<string>",
      "step": 123,
      "checkpoint_path": "<string>",
      "model_path": "<string>",
      "training_offset": 123,
      "hash": "<string>",
      "level": null
    }
  ],
  "token_count": 123,
  "param_count": 123,
  "total_price": 123,
  "epochs_completed": 123,
  "queue_depth": 123,
  "wandb_project_name": "<string>",
  "wandb_url": "<string>",
  "from_checkpoint": "<string>",
  "from_hf_model": "<string>",
  "hf_model_revision": "<string>"
}

GET

fine-tunes

{id}

# Docs for v2 can be found by changing the above selector ^
from together import Together
import os

client = Together(
    api_key=os.environ.get("TOGETHER_API_KEY"),
)

fine_tune = client.fine_tuning.retrieve(id="ft-id")

print(fine_tune)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "training_file": "<string>",
  "validation_file": "<string>",
  "model": "<string>",
  "model_output_name": "<string>",
  "model_output_path": "<string>",
  "trainingfile_numlines": 123,
  "trainingfile_size": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "n_epochs": 123,
  "n_checkpoints": 123,
  "n_evals": 123,
  "batch_size": "max",
  "learning_rate": 123,
  "lr_scheduler": {
    "lr_scheduler_type": "linear",
    "lr_scheduler_args": {
      "min_lr_ratio": 0
    }
  },
  "warmup_ratio": 123,
  "max_grad_norm": 123,
  "weight_decay": 123,
  "eval_steps": 123,
  "train_on_inputs": "auto",
  "training_method": {
    "method": "sft",
    "train_on_inputs": "auto"
  },
  "training_type": {
    "type": "Full"
  },
  "job_id": "<string>",
  "events": [
    {
      "object": "fine-tune-event",
      "created_at": "<string>",
      "message": "<string>",
      "type": "job_pending",
      "param_count": 123,
      "token_count": 123,
      "total_steps": 123,
      "wandb_url": "<string>",
      "step": 123,
      "checkpoint_path": "<string>",
      "model_path": "<string>",
      "training_offset": 123,
      "hash": "<string>",
      "level": null
    }
  ],
  "token_count": 123,
  "param_count": 123,
  "total_price": 123,
  "epochs_completed": 123,
  "queue_depth": 123,
  "wandb_project_name": "<string>",
  "wandb_url": "<string>",
  "from_checkpoint": "<string>",
  "from_hf_model": "<string>",
  "hf_model_revision": "<string>"
}

Authorizations

Authorization

string

header

default:default

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Response

200 - application/json

Fine-tune job details retrieved successfully

string<uuid>

required

status

enum<string>

required

Available options:

pending,

queued,

running,

compressing,

uploading,

cancel_requested,

cancelled,

error,

completed

training_file

string

validation_file

string

model

string

model_output_name

string

model_output_path

string

trainingfile_numlines

integer

trainingfile_size

integer

created_at

string

updated_at

string

n_epochs

integer

n_checkpoints

integer

n_evals

integer

batch_size

default:max

learning_rate

number

lr_scheduler

object

Show child attributes

lr_scheduler.lr_scheduler_type

enum<string>

required

Available options:

linear,

cosine

lr_scheduler.lr_scheduler_args

object

Option 1
Option 2

Show child attributes

lr_scheduler.lr_scheduler_args.min_lr_ratio

number<float>

default:0

The ratio of the final learning rate to the peak learning rate

warmup_ratio

number

max_grad_norm

number<float>

weight_decay

number<float>

eval_steps

integer

train_on_inputs

default:auto

training_method

object

Option 1
Option 2

Show child attributes

training_method.method

enum<string>

required

Available options:

sft

training_method.train_on_inputs

boolean

default:auto

required

Whether to mask the user messages in conversational data or prompts in instruction data.

training_type

object

Option 1
Option 2

Show child attributes

training_type.type

enum<string>

required

Available options:

Full

job_id

string

events

object[]

Show child attributes

events.object

enum<string>

required

Available options:

fine-tune-event

events.created_at

string

required

events.message

string

required

events.type

enum<string>

required

Available options:

job_pending,

job_start,

job_stopped,

model_downloading,

model_download_complete,

training_data_downloading,

training_data_download_complete,

validation_data_downloading,

validation_data_download_complete,

wandb_init,

training_start,

checkpoint_save,

billing_limit,

epoch_complete,

training_complete,

model_compressing,

model_compression_complete,

model_uploading,

model_upload_complete,

job_complete,

job_error,

cancel_requested,

job_restarted,

refund,

warning

events.param_count

integer

required

events.token_count

integer

required

events.total_steps

integer

required

events.wandb_url

string

required

events.step

integer

required

events.checkpoint_path

string

required

events.model_path

string

required

events.training_offset

integer

required

events.hash

string

required

events.level

enum<string>

Available options:

info,

warning,

error,

legacy_info,

legacy_iwarning,

legacy_ierror

token_count

integer

param_count

integer

total_price

integer

epochs_completed

integer

queue_depth

integer

wandb_project_name

string

wandb_url

string

from_checkpoint

string

from_hf_model

string

hf_model_revision

string

List All Jobs

List Job Events

⌘I

Together APIs

Command Line Interface

General

Authorizations

Path Parameters

Response