Module fine_tuning_shared 

Structures shared across the Fine-tuning API, including jobs, checkpoints, and events.

Modules

exposed

Exposed namespace of the module.

orphan

Orphan namespace of the module.

own

Own namespace of the module.

prelude

Prelude to use essentials: use my_module ::prelude :: *.

Structs

DPOHyperparameters

Hyperparameters specific to the DPO fine-tuning method.

FineTuneChatRequestInput

Represents the input structure for a chat-based fine-tuning job using the supervised method. This is typically one line in the training JSONL file.

FineTuneCompletionRequestInput

Represents the input structure for a completions-based fine-tuning job. This is typically one line in the training JSONL file.

FineTuneDPOMethod

Configuration for the DPO (Direct Preference Optimization) fine-tuning method.

FineTunePreferenceInputData

Contains the input messages and optional tools for a DPO preference example.

FineTunePreferenceRequestInput

Represents the input structure for a preference-based (DPO) fine-tuning job. This is typically one line in the training JSONL file.

FineTuneSupervisedMethod

Configuration for the supervised fine-tuning method.

FineTuningCheckpointPermission

Represents a permission for a fine-tuned model checkpoint.

FineTuningIntegration

Represents an integration configuration for a fine-tuning job.

FineTuningIntegrationWandb

Represents the configuration for Weights & Biases integration.

FineTuningJob

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

FineTuningJobCheckpoint

Represents a model checkpoint for a fine-tuning job that is ready to use.

FineTuningJobCheckpointMetrics

Metrics reported at a specific step number during a fine-tuning job.

FineTuningJobError

Represents an error that occurred during a fine-tuning job.

FineTuningJobEvent

Represents an event related to a fine-tuning job (e.g., status updates, metric reports).

FineTuningJobHyperparameters

Represents the hyperparameters used for a fine-tuning job (legacy format). This structure is deprecated in favor of specifying hyperparameters within the method field.

ListFineTuningCheckpointPermissionResponse

Response containing a list of fine-tuning checkpoint permissions.

ListFineTuningJobCheckpointsResponse

Response containing a list of fine-tuning job checkpoints.

ListFineTuningJobEventsResponse

Response containing a list of fine-tuning job events.

ListPaginatedFineTuningJobsResponse

Response containing a paginated list of fine-tuning jobs.

Enums

FineTuneMethod

Represents the method used for fine-tuning (supervised or DPO).