Package-level declarations

Types

Link copied to clipboard
@Serializable
data class ErrorInfo(val message: String? = null, val code: String? = null, val param: String? = null)

For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.

Link copied to clipboard
@Serializable
data class FineTuningCheckpoint(val id: String, val createdAt: Long, val fineTunedModelCheckpoint: ModelId, val fineTuningJobId: FineTuningId, val metrics: FineTuningCheckpointMetrics, val objectType: String, val stepNumber: Long)

A checkpoint produced at a particular training step.

Link copied to clipboard
@Serializable
data class FineTuningCheckpointMetrics(val fullValidLoss: Double? = null, val fullValidMeanTokenAccuracy: Double? = null, val step: Double? = null, val trainLoss: Double? = null, val trainMeanTokenAccuracy: Double? = null, val validLoss: Double? = null, val validMeanTokenAccuracy: Double? = null)

Optional training and validation measurements for a checkpoint.

Link copied to clipboard
@Serializable
data class FineTuningCheckpointPermission(val id: String, val createdAt: Long, val objectType: String, val projectId: String)

Access granted to a project for a fine-tuned model checkpoint.

Link copied to clipboard
@Serializable
data class FineTuningCheckpointPermissionRequest(val projectIds: List<String>)

Projects to grant access to a checkpoint. Requires an Admin API key.

Link copied to clipboard
@Serializable
data class FineTuningHyperparameters(val batchSize: FineTuningNumber? = null, val learningRateMultiplier: FineTuningNumber? = null, val nEpochs: FineTuningNumber? = null)

Current numeric training hyperparameters.

Link copied to clipboard
@Serializable
value class FineTuningId(val id: String)

Fine-tuning identifier.

Link copied to clipboard
@Serializable
data class FineTuningJob(val id: FineTuningId, val createdAt: Int, val model: ModelId, val organizationId: OrganizationId, val status: Status, val hyperparameters: Hyperparameters, val trainingFile: FileId, val resultFiles: List<FileId>, val finishedAt: Int? = null, val fineTunedModel: ModelId? = null, val validationFile: FileId? = null, val trainedTokens: Int? = null, val error: ErrorInfo? = null)

A data class representing a fine-tuning job.

Link copied to clipboard
@Serializable
data class FineTuningJobDetails(val id: FineTuningId, val createdAt: Long, val model: ModelId, val objectType: String, val organizationId: OrganizationId, val status: Status, val trainingFile: FileId, val resultFiles: List<FileId>, val error: JsonElement? = null, val fineTunedModel: ModelId? = null, val finishedAt: Long? = null, val seed: Long? = null, val trainedTokens: Long? = null, val validationFile: FileId? = null, val estimatedFinish: Long? = null, val hyperparameters: FineTuningHyperparameters? = null, val integrations: List<FineTuningWandbIntegration>? = null, val metadata: Map<String, String>? = null, val method: JsonObject? = null)

Current job details, including nullable hyperparameters and paused states, without changing the legacy job type.

Link copied to clipboard
@Serializable
data class FineTuningJobEvent(val id: String, val createdAt: Int, val level: Level, val message: String)

Data class representing a fine-tuning job event.

Link copied to clipboard
@Serializable(with = FineTuningNumberSerializer::class)
sealed interface FineTuningNumber

A numeric hyperparameter or the server's automatic selection.

Link copied to clipboard
@Serializable
data class FineTuningPage<T>(val data: List<T>, val hasMore: Boolean, val objectType: String, val firstId: String? = null, val lastId: String? = null) : List<T>

A fine-tuning resource page with its full cursor envelope.

Link copied to clipboard
@Serializable
data class FineTuningPermissionDeletion(val id: String, val deleted: Boolean, val objectType: String)

Result of removing a checkpoint permission.

Link copied to clipboard

Checkpoint-permission ordering uses full words rather than the ordinary asc/desc query values.

Link copied to clipboard
@Serializable
data class FineTuningRequest(val trainingFile: FileId, val model: ModelId, val validationFile: FileId? = null, val hyperparameters: Hyperparameters? = null, val suffix: String? = null)

A data class representing a fine-tuning request.

Link copied to clipboard

Builder of FineTuningRequest instances.

Link copied to clipboard
@Serializable
data class FineTuningWandbIntegration(val type: String, val wandb: FineTuningWandbSettings)

A Weights and Biases training integration.

Link copied to clipboard
@Serializable
data class FineTuningWandbSettings(val project: String, val entity: String? = null, val name: String? = null, val tags: List<String>? = null)

Weights and Biases job configuration.

Link copied to clipboard
@Serializable
data class Hyperparameters(val nEpochs: Hyperparameters.NEpochs)

A data class representing hyperparameters used during the fine-tuning of a model.

Link copied to clipboard
@Serializable
value class Level(val value: String)

Represents the severity level of a fine-tuning job event.

Functions

Link copied to clipboard

Create a Fine-Tuning request.