Search Modaic documentation

Find a Modaic guide or API reference

modaic fine-tunes

create

Start training an existing model. See fine-tuning for the dataset format.

modaic fine-tunes create --model acme/support-priority \
  --training-path train.jsonl --wait
Flag / argumentWhat it does
--modelRequired base model or existing model path. Tuning supports mo/mo-1.3.1.
--training-fileUploaded dataset name. Use exactly one of this or --training-path.
--training-pathLocal dataset to upload before training.
--training-nameName for the dataset uploaded with --training-path.
--workspaceWorkspace for uploading the local dataset.
--training-typehead_only (default) or lora.
--destinationDestination model path.
--branchDestination branch. API default: main.
--source-commit-shaStarting model revision.
--validation-fileOptional uploaded validation dataset.
--eval-only-datasetOptional uploaded held-out eval-only-dataset.
--suffixOptional run label.
--from-checkpointCheckpoint reference for compatible continued training.
--idempotency-keyRetry key for this exact request.
--lora-rLoRA rank.
--lora-alphaLoRA scaling.
--lora-dropoutLoRA dropout.
--max-seq-lengthMaximum tokens per example. API default: 262144.
--n-epochsTraining epochs. API default: 1.
--n-checkpointsCheckpoints to save. API default: 1.
--n-evalsEvaluation count. API default: 0.
--batch-sizeBatch size or max (API default).
--gradient-accumulation-stepsAccumulation steps. API default: 1.
--learning-rateLearning rate. API default: 0.00001.
--lr-scheduler-typeconstant (API default), linear, or cosine.
--min-lr-ratioScheduler minimum learning-rate ratio. API default: 0.
--num-cyclesScheduler cycles. API default: 0.5.
--warmup-ratioFraction of steps used for warmup. API default: 0.
--max-grad-normGradient clipping threshold. API default: 1.
--weight-decayWeight decay. API default: 0.
--random-seedTraining seed. API default: 131031.
--early-stoppingEnable early stopping; requires enough evaluations.
--early-stopping-patienceEvaluations without improvement before stopping. API default: 2.
--early-stopping-min-deltaMinimum improvement. API default: 0.
--early-stopping-warmup-evalsEvaluations before checking for early stopping. API default: 1.
--wandb-api-keyWeights & Biases API key. Keep it secret.
--wandb-base-urlWeights & Biases service URL.
--wandb-project-nameWeights & Biases project.
--wandb-nameWeights & Biases run name.
--wandb-entityWeights & Biases entity.
--waitWait for a terminal job status.
--timeoutWait deadline in seconds; also applies to local dataset validation.
-h, --helpShow usage and options.

--wait returns failed/cancelled jobs too; check status and error. A timeout does not cancel training.

list

List recent fine-tuning jobs in a workspace.

modaic fine-tunes list acme --limit 10
Flag / argumentWhat it does
WORKSPACERequired workspace slug.
--model-idFilter by destination model UUID.
--limitMaximum jobs. Default: 20.
-h, --helpShow usage and options.

get

Read job status and results.

modaic fine-tunes get JOB_ID
Flag / argumentWhat it does
JOB_IDRequired fine-tuning job ID.
-h, --helpShow usage and options.

logs

Read available training and evaluation output.

modaic fine-tunes logs JOB_ID
Flag / argumentWhat it does
JOB_IDRequired fine-tuning job ID.
-h, --helpShow usage and options.

wait

Wait until the job is done, failed, or cancelled.

modaic fine-tunes wait JOB_ID --timeout 600
Flag / argumentWhat it does
JOB_IDRequired fine-tuning job ID.
--timeoutWait deadline in seconds. Omit to wait indefinitely.
-h, --helpShow usage and options.

Check status and error. A timeout stops waiting without cancelling the job.

cancel

Request cancellation.

modaic fine-tunes cancel JOB_ID
Flag / argumentWhat it does
JOB_IDRequired fine-tuning job ID.
-h, --helpShow usage and options.
Was this page helpful?