Skip to content

Latest commit

 

History

History
69 lines (62 loc) · 12.4 KB

finetuningjob.md

File metadata and controls

69 lines (62 loc) · 12.4 KB

FineTuningJob

The fine_tuning.job object represents a fine-tuning job that has been created through the API.

Example Usage

import { FineTuningJob } from "argot-open-ai/models/components";

let value: FineTuningJob = {
  id: "<id>",
  createdAt: 652103,
  error: {
    code: "<value>",
    message: "<value>",
    param: "<value>",
  },
  fineTunedModel: "<value>",
  finishedAt: 431418,
  hyperparameters: {
    nEpochs: 367562,
  },
  model: "Expedition",
  object: "fine_tuning.job",
  organizationId: "<id>",
  resultFiles: [
    "file-abc123",
  ],
  status: "cancelled",
  trainedTokens: 806194,
  trainingFile: "<value>",
  validationFile: "<value>",
  integrations: [
    {
      type: "wandb",
      wandb: {
        project: "my-wandb-project",
        tags: [
          "custom-tag",
        ],
      },
    },
  ],
  seed: 703889,
};

Fields

Field Type Required Description
id string ✔️ The object identifier, which can be referenced in the API endpoints.
createdAt number ✔️ The Unix timestamp (in seconds) for when the fine-tuning job was created.
error components.FineTuningJobError ✔️ For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
fineTunedModel string ✔️ The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.
finishedAt number ✔️ The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.
hyperparameters components.FineTuningJobHyperparameters ✔️ The hyperparameters used for the fine-tuning job. See the fine-tuning guide for more details.
model string ✔️ The base model that is being fine-tuned.
object components.FineTuningJobObject ✔️ The object type, which is always "fine_tuning.job".
organizationId string ✔️ The organization that owns the fine-tuning job.
resultFiles string[] ✔️ The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.
status components.FineTuningJobStatus ✔️ The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.
trainedTokens number ✔️ The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.
trainingFile string ✔️ The file ID used for training. You can retrieve the training data with the Files API.
validationFile string ✔️ The file ID used for validation. You can retrieve the validation results with the Files API.
integrations components.FineTuningJobIntegrations[] ➖ A list of integrations to enable for this fine-tuning job.
seed number ✔️ The seed used for the fine-tuning job.
estimatedFinish number ➖ The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.