glopenai/fine_tuning
Types
Batch size: auto or a specific size.
pub type BatchSize {
BatchSizeAuto
BatchSize(Int)
}
Constructors
-
BatchSizeAuto -
BatchSize(Int)
Beta parameter for DPO: auto or a specific value.
pub type Beta {
BetaAuto
Beta(Float)
}
Constructors
-
BetaAuto -
Beta(Float)
Compute multiplier for reinforcement: auto or a specific value.
pub type ComputeMultiplier {
ComputeMultiplierAuto
ComputeMultiplier(Float)
}
Constructors
-
ComputeMultiplierAuto -
ComputeMultiplier(Float)
pub type CreateFineTuningCheckpointPermissionRequest {
CreateFineTuningCheckpointPermissionRequest(
project_ids: List(String),
)
}
Constructors
-
CreateFineTuningCheckpointPermissionRequest( project_ids: List(String), )
pub type CreateFineTuningJobRequest {
CreateFineTuningJobRequest(
model: String,
training_file: String,
suffix: option.Option(String),
validation_file: option.Option(String),
integrations: option.Option(List(FineTuningIntegration)),
seed: option.Option(Int),
method: option.Option(FineTuneMethod),
metadata: option.Option(dynamic.Dynamic),
)
}
Constructors
-
CreateFineTuningJobRequest( model: String, training_file: String, suffix: option.Option(String), validation_file: option.Option(String), integrations: option.Option(List(FineTuningIntegration)), seed: option.Option(Int), method: option.Option(FineTuneMethod), metadata: option.Option(dynamic.Dynamic), )
pub type DeleteFineTuningCheckpointPermissionResponse {
DeleteFineTuningCheckpointPermissionResponse(
object: String,
id: String,
deleted: Bool,
)
}
Constructors
-
DeleteFineTuningCheckpointPermissionResponse( object: String, id: String, deleted: Bool, )
Evaluation interval: auto or a specific count.
pub type EvalInterval {
EvalIntervalAuto
EvalInterval(Int)
}
Constructors
-
EvalIntervalAuto -
EvalInterval(Int)
An eval item used as input to score model graders.
pub type EvalItem {
EvalItem(role: String, content: String)
}
Constructors
-
EvalItem(role: String, content: String)
Evaluation samples: auto or a specific count.
pub type EvalSamples {
EvalSamplesAuto
EvalSamples(Int)
}
Constructors
-
EvalSamplesAuto -
EvalSamples(Int)
pub type EventLevel {
LevelInfo
LevelWarn
LevelError
}
Constructors
-
LevelInfo -
LevelWarn -
LevelError
pub type FineTuneDpoHyperparameters {
FineTuneDpoHyperparameters(
beta: Beta,
batch_size: BatchSize,
learning_rate_multiplier: LearningRateMultiplier,
n_epochs: NEpochs,
)
}
Constructors
-
FineTuneDpoHyperparameters( beta: Beta, batch_size: BatchSize, learning_rate_multiplier: LearningRateMultiplier, n_epochs: NEpochs, )
pub type FineTuneDpoMethod {
FineTuneDpoMethod(hyperparameters: FineTuneDpoHyperparameters)
}
Constructors
-
FineTuneDpoMethod(hyperparameters: FineTuneDpoHyperparameters)
Graders used in reinforcement fine-tuning methods. Tagged by “type” field.
pub type FineTuneGrader {
StringCheckGrader(GraderStringCheck)
TextSimilarityGrader(GraderTextSimilarity)
PythonGrader(GraderPython)
ScoreModelGrader(GraderScoreModel)
MultiGrader(
name: String,
graders: dynamic.Dynamic,
calculate_output: String,
)
}
Constructors
-
StringCheckGrader(GraderStringCheck) -
TextSimilarityGrader(GraderTextSimilarity) -
PythonGrader(GraderPython) -
ScoreModelGrader(GraderScoreModel) -
MultiGrader( name: String, graders: dynamic.Dynamic, calculate_output: String, )
pub type FineTuneJobError {
FineTuneJobError(
code: String,
message: String,
param: option.Option(String),
)
}
Constructors
-
FineTuneJobError( code: String, message: String, param: option.Option(String), )
The fine-tuning method to use. Tagged by “type” field.
pub type FineTuneMethod {
Supervised(supervised: FineTuneSupervisedMethod)
Dpo(dpo: FineTuneDpoMethod)
Reinforcement(reinforcement: FineTuneReinforcementMethod)
}
Constructors
-
Supervised(supervised: FineTuneSupervisedMethod) -
Dpo(dpo: FineTuneDpoMethod) -
Reinforcement(reinforcement: FineTuneReinforcementMethod)
Reasoning effort level for reinforcement fine-tuning.
pub type FineTuneReasoningEffort {
FineTuneReasoningDefault
FineTuneReasoningLow
FineTuneReasoningMedium
FineTuneReasoningHigh
}
Constructors
-
FineTuneReasoningDefault -
FineTuneReasoningLow -
FineTuneReasoningMedium -
FineTuneReasoningHigh
pub type FineTuneReinforcementHyperparameters {
FineTuneReinforcementHyperparameters(
batch_size: BatchSize,
learning_rate_multiplier: LearningRateMultiplier,
n_epochs: NEpochs,
reasoning_effort: FineTuneReasoningEffort,
compute_multiplier: ComputeMultiplier,
eval_interval: EvalInterval,
eval_samples: EvalSamples,
)
}
Constructors
-
FineTuneReinforcementHyperparameters( batch_size: BatchSize, learning_rate_multiplier: LearningRateMultiplier, n_epochs: NEpochs, reasoning_effort: FineTuneReasoningEffort, compute_multiplier: ComputeMultiplier, eval_interval: EvalInterval, eval_samples: EvalSamples, )
pub type FineTuneReinforcementMethod {
FineTuneReinforcementMethod(
grader: FineTuneGrader,
hyperparameters: FineTuneReinforcementHyperparameters,
)
}
Constructors
-
FineTuneReinforcementMethod( grader: FineTuneGrader, hyperparameters: FineTuneReinforcementHyperparameters, )
pub type FineTuneSupervisedHyperparameters {
FineTuneSupervisedHyperparameters(
batch_size: BatchSize,
learning_rate_multiplier: LearningRateMultiplier,
n_epochs: NEpochs,
)
}
Constructors
-
FineTuneSupervisedHyperparameters( batch_size: BatchSize, learning_rate_multiplier: LearningRateMultiplier, n_epochs: NEpochs, )
pub type FineTuneSupervisedMethod {
FineTuneSupervisedMethod(
hyperparameters: FineTuneSupervisedHyperparameters,
)
}
Constructors
-
FineTuneSupervisedMethod( hyperparameters: FineTuneSupervisedHyperparameters, )
pub type FineTuningCheckpointPermission {
FineTuningCheckpointPermission(
id: String,
created_at: Int,
project_id: String,
object: String,
)
}
Constructors
-
FineTuningCheckpointPermission( id: String, created_at: Int, project_id: String, object: String, )
pub type FineTuningJob {
FineTuningJob(
id: String,
created_at: Int,
error: option.Option(FineTuneJobError),
fine_tuned_model: option.Option(String),
finished_at: option.Option(Int),
hyperparameters: Hyperparameters,
model: String,
object: String,
organization_id: String,
result_files: List(String),
status: FineTuningJobStatus,
trained_tokens: option.Option(Int),
training_file: String,
validation_file: option.Option(String),
integrations: option.Option(List(FineTuningIntegration)),
seed: Int,
estimated_finish: option.Option(Int),
method: option.Option(FineTuneMethod),
metadata: option.Option(dynamic.Dynamic),
)
}
Constructors
-
FineTuningJob( id: String, created_at: Int, error: option.Option(FineTuneJobError), fine_tuned_model: option.Option(String), finished_at: option.Option(Int), hyperparameters: Hyperparameters, model: String, object: String, organization_id: String, result_files: List(String), status: FineTuningJobStatus, trained_tokens: option.Option(Int), training_file: String, validation_file: option.Option(String), integrations: option.Option(List(FineTuningIntegration)), seed: Int, estimated_finish: option.Option(Int), method: option.Option(FineTuneMethod), metadata: option.Option(dynamic.Dynamic), )
pub type FineTuningJobCheckpoint {
FineTuningJobCheckpoint(
id: String,
created_at: Int,
fine_tuned_model_checkpoint: String,
step_number: Int,
metrics: FineTuningJobCheckpointMetrics,
fine_tuning_job_id: String,
object: String,
)
}
Constructors
-
FineTuningJobCheckpoint( id: String, created_at: Int, fine_tuned_model_checkpoint: String, step_number: Int, metrics: FineTuningJobCheckpointMetrics, fine_tuning_job_id: String, object: String, )
pub type FineTuningJobCheckpointMetrics {
FineTuningJobCheckpointMetrics(
step: Int,
train_loss: Float,
train_mean_token_accuracy: Float,
valid_loss: Float,
valid_mean_token_accuracy: Float,
full_valid_loss: Float,
full_valid_mean_token_accuracy: Float,
)
}
Constructors
-
FineTuningJobCheckpointMetrics( step: Int, train_loss: Float, train_mean_token_accuracy: Float, valid_loss: Float, valid_mean_token_accuracy: Float, full_valid_loss: Float, full_valid_mean_token_accuracy: Float, )
pub type FineTuningJobEvent {
FineTuningJobEvent(
id: String,
created_at: Int,
level: EventLevel,
message: String,
object: String,
event_type: option.Option(FineTuningJobEventType),
data: option.Option(dynamic.Dynamic),
)
}
Constructors
-
FineTuningJobEvent( id: String, created_at: Int, level: EventLevel, message: String, object: String, event_type: option.Option(FineTuningJobEventType), data: option.Option(dynamic.Dynamic), )
pub type FineTuningJobEventType {
EventMessage
EventMetrics
}
Constructors
-
EventMessage -
EventMetrics
pub type FineTuningJobStatus {
ValidatingFiles
Queued
Running
Succeeded
JobFailed
JobCancelled
}
Constructors
-
ValidatingFiles -
Queued -
Running -
Succeeded -
JobFailed -
JobCancelled
pub type GraderPython {
GraderPython(
name: String,
source: String,
image_tag: option.Option(String),
)
}
Constructors
-
GraderPython( name: String, source: String, image_tag: option.Option(String), )
pub type GraderScoreModel {
GraderScoreModel(
name: String,
model: String,
input: List(EvalItem),
sampling_params: option.Option(GraderScoreModelSamplingParams),
range: option.Option(List(Float)),
)
}
Constructors
-
GraderScoreModel( name: String, model: String, input: List(EvalItem), sampling_params: option.Option(GraderScoreModelSamplingParams), range: option.Option(List(Float)), )
pub type GraderScoreModelSamplingParams {
GraderScoreModelSamplingParams(
seed: option.Option(Int),
top_p: option.Option(Float),
temperature: option.Option(Float),
max_completion_tokens: option.Option(Int),
reasoning_effort: option.Option(shared.ReasoningEffort),
)
}
Constructors
-
GraderScoreModelSamplingParams( seed: option.Option(Int), top_p: option.Option(Float), temperature: option.Option(Float), max_completion_tokens: option.Option(Int), reasoning_effort: option.Option(shared.ReasoningEffort), )
pub type GraderStringCheck {
GraderStringCheck(
name: String,
input: String,
reference: String,
operation: GraderStringCheckOperation,
)
}
Constructors
-
GraderStringCheck( name: String, input: String, reference: String, operation: GraderStringCheckOperation, )
pub type GraderStringCheckOperation {
GraderOpEq
GraderOpNe
GraderOpLike
GraderOpIlike
}
Constructors
-
GraderOpEq -
GraderOpNe -
GraderOpLike -
GraderOpIlike
pub type GraderTextSimilarity {
GraderTextSimilarity(
name: String,
input: String,
reference: String,
evaluation_metric: GraderTextSimilarityMetric,
)
}
Constructors
-
GraderTextSimilarity( name: String, input: String, reference: String, evaluation_metric: GraderTextSimilarityMetric, )
pub type GraderTextSimilarityMetric {
MetricCosine
MetricFuzzyMatch
MetricBleu
MetricGleu
MetricMeteor
MetricRouge1
MetricRouge2
MetricRouge3
MetricRouge4
MetricRouge5
MetricRougeL
}
Constructors
-
MetricCosine -
MetricFuzzyMatch -
MetricBleu -
MetricGleu -
MetricMeteor -
MetricRouge1 -
MetricRouge2 -
MetricRouge3 -
MetricRouge4 -
MetricRouge5 -
MetricRougeL
Hyperparameters as returned in a FineTuningJob response.
pub type Hyperparameters {
Hyperparameters(
batch_size: BatchSize,
learning_rate_multiplier: LearningRateMultiplier,
n_epochs: NEpochs,
)
}
Constructors
-
Hyperparameters( batch_size: BatchSize, learning_rate_multiplier: LearningRateMultiplier, n_epochs: NEpochs, )
Learning rate multiplier: auto or a specific value.
pub type LearningRateMultiplier {
LearningRateMultiplierAuto
LearningRateMultiplier(Float)
}
Constructors
-
LearningRateMultiplierAuto -
LearningRateMultiplier(Float)
pub type ListFineTuningCheckpointPermissionResponse {
ListFineTuningCheckpointPermissionResponse(
data: List(FineTuningCheckpointPermission),
object: String,
first_id: option.Option(String),
last_id: option.Option(String),
has_more: Bool,
)
}
Constructors
-
ListFineTuningCheckpointPermissionResponse( data: List(FineTuningCheckpointPermission), object: String, first_id: option.Option(String), last_id: option.Option(String), has_more: Bool, )
pub type ListFineTuningJobCheckpointsResponse {
ListFineTuningJobCheckpointsResponse(
data: List(FineTuningJobCheckpoint),
object: String,
first_id: option.Option(String),
last_id: option.Option(String),
has_more: Bool,
)
}
Constructors
-
ListFineTuningJobCheckpointsResponse( data: List(FineTuningJobCheckpoint), object: String, first_id: option.Option(String), last_id: option.Option(String), has_more: Bool, )
pub type ListFineTuningJobEventsResponse {
ListFineTuningJobEventsResponse(
data: List(FineTuningJobEvent),
object: String,
)
}
Constructors
-
ListFineTuningJobEventsResponse( data: List(FineTuningJobEvent), object: String, )
pub type ListPaginatedFineTuningJobsResponse {
ListPaginatedFineTuningJobsResponse(
data: List(FineTuningJob),
has_more: Bool,
object: String,
)
}
Constructors
-
ListPaginatedFineTuningJobsResponse( data: List(FineTuningJob), has_more: Bool, object: String, )
Number of epochs: auto or a specific count.
pub type NEpochs {
NEpochsAuto
NEpochs(Int)
}
Constructors
-
NEpochsAuto -
NEpochs(Int)
pub type WandB {
WandB(
project: String,
name: option.Option(String),
entity: option.Option(String),
tags: option.Option(List(String)),
)
}
Constructors
-
WandB( project: String, name: option.Option(String), entity: option.Option(String), tags: option.Option(List(String)), )
Values
pub fn batch_size_decoder() -> decode.Decoder(BatchSize)
pub fn beta_decoder() -> decode.Decoder(Beta)
pub fn cancel_request(
config: config.Config,
fine_tuning_job_id: String,
) -> request.Request(String)
Build a request to cancel a fine-tuning job.
pub fn cancel_response(
response: response.Response(String),
) -> Result(FineTuningJob, error.GlopenaiError)
Parse the response from cancelling a fine-tuning job.
pub fn compute_multiplier_decoder() -> decode.Decoder(
ComputeMultiplier,
)
pub fn compute_multiplier_to_json(
value: ComputeMultiplier,
) -> json.Json
pub fn create_checkpoint_permission_request(
config: config.Config,
fine_tuned_model_checkpoint: String,
params: CreateFineTuningCheckpointPermissionRequest,
) -> request.Request(String)
Build a request to create checkpoint permissions.
pub fn create_checkpoint_permission_request_to_json(
request: CreateFineTuningCheckpointPermissionRequest,
) -> json.Json
pub fn create_checkpoint_permission_response(
response: response.Response(String),
) -> Result(
ListFineTuningCheckpointPermissionResponse,
error.GlopenaiError,
)
Parse the response from creating checkpoint permissions.
pub fn create_fine_tuning_job_request_to_json(
request: CreateFineTuningJobRequest,
) -> json.Json
pub fn create_request(
config: config.Config,
params: CreateFineTuningJobRequest,
) -> request.Request(String)
Build a request to create a fine-tuning job.
pub fn create_response(
response: response.Response(String),
) -> Result(FineTuningJob, error.GlopenaiError)
Parse the response from creating a fine-tuning job.
pub fn delete_checkpoint_permission_request(
config: config.Config,
fine_tuned_model_checkpoint: String,
permission_id: String,
) -> request.Request(String)
Build a request to delete a checkpoint permission.
pub fn delete_checkpoint_permission_response(
response: response.Response(String),
) -> Result(
DeleteFineTuningCheckpointPermissionResponse,
error.GlopenaiError,
)
Parse the response from deleting a checkpoint permission.
pub fn dpo_hyperparameters_decoder() -> decode.Decoder(
FineTuneDpoHyperparameters,
)
pub fn dpo_hyperparameters_to_json(
hp: FineTuneDpoHyperparameters,
) -> json.Json
pub fn eval_interval_decoder() -> decode.Decoder(EvalInterval)
pub fn eval_interval_to_json(value: EvalInterval) -> json.Json
pub fn eval_item_decoder() -> decode.Decoder(EvalItem)
pub fn eval_samples_decoder() -> decode.Decoder(EvalSamples)
pub fn eval_samples_to_json(value: EvalSamples) -> json.Json
pub fn event_level_decoder() -> decode.Decoder(EventLevel)
pub fn event_level_to_json(level: EventLevel) -> json.Json
pub fn fine_tune_grader_decoder() -> decode.Decoder(
FineTuneGrader,
)
pub fn fine_tune_grader_to_json(
grader: FineTuneGrader,
) -> json.Json
pub fn fine_tune_job_error_decoder() -> decode.Decoder(
FineTuneJobError,
)
pub fn fine_tune_method_decoder() -> decode.Decoder(
FineTuneMethod,
)
pub fn fine_tune_method_to_json(
method: FineTuneMethod,
) -> json.Json
pub fn fine_tune_reasoning_effort_decoder() -> decode.Decoder(
FineTuneReasoningEffort,
)
pub fn fine_tune_reasoning_effort_to_json(
value: FineTuneReasoningEffort,
) -> json.Json
pub fn fine_tuning_checkpoint_permission_decoder() -> decode.Decoder(
FineTuningCheckpointPermission,
)
pub fn fine_tuning_integration_decoder() -> decode.Decoder(
FineTuningIntegration,
)
pub fn fine_tuning_integration_to_json(
integration: FineTuningIntegration,
) -> json.Json
pub fn fine_tuning_job_checkpoint_decoder() -> decode.Decoder(
FineTuningJobCheckpoint,
)
pub fn fine_tuning_job_checkpoint_metrics_decoder() -> decode.Decoder(
FineTuningJobCheckpointMetrics,
)
pub fn fine_tuning_job_decoder() -> decode.Decoder(FineTuningJob)
pub fn fine_tuning_job_event_decoder() -> decode.Decoder(
FineTuningJobEvent,
)
pub fn fine_tuning_job_event_type_decoder() -> decode.Decoder(
FineTuningJobEventType,
)
pub fn fine_tuning_job_status_decoder() -> decode.Decoder(
FineTuningJobStatus,
)
pub fn fine_tuning_job_status_to_json(
status: FineTuningJobStatus,
) -> json.Json
pub fn grader_score_model_sampling_params_decoder() -> decode.Decoder(
GraderScoreModelSamplingParams,
)
pub fn grader_score_model_sampling_params_to_json(
params: GraderScoreModelSamplingParams,
) -> json.Json
pub fn grader_string_check_operation_decoder() -> decode.Decoder(
GraderStringCheckOperation,
)
pub fn grader_string_check_operation_to_json(
op: GraderStringCheckOperation,
) -> json.Json
pub fn grader_text_similarity_metric_decoder() -> decode.Decoder(
GraderTextSimilarityMetric,
)
pub fn grader_text_similarity_metric_to_json(
metric: GraderTextSimilarityMetric,
) -> json.Json
pub fn hyperparameters_decoder() -> decode.Decoder(
Hyperparameters,
)
pub fn hyperparameters_to_json(hp: Hyperparameters) -> json.Json
pub fn learning_rate_multiplier_decoder() -> decode.Decoder(
LearningRateMultiplier,
)
pub fn learning_rate_multiplier_to_json(
value: LearningRateMultiplier,
) -> json.Json
pub fn list_checkpoint_permissions_request(
config: config.Config,
fine_tuned_model_checkpoint: String,
) -> request.Request(String)
Build a request to list checkpoint permissions.
pub fn list_checkpoint_permissions_response(
response: response.Response(String),
) -> Result(
ListFineTuningCheckpointPermissionResponse,
error.GlopenaiError,
)
Parse the response from listing checkpoint permissions.
pub fn list_checkpoints_request(
config: config.Config,
fine_tuning_job_id: String,
) -> request.Request(String)
Build a request to list checkpoints for a fine-tuning job.
pub fn list_checkpoints_response(
response: response.Response(String),
) -> Result(
ListFineTuningJobCheckpointsResponse,
error.GlopenaiError,
)
Parse the response from listing fine-tuning job checkpoints.
pub fn list_events_request(
config: config.Config,
fine_tuning_job_id: String,
) -> request.Request(String)
Build a request to list events for a fine-tuning job.
pub fn list_events_response(
response: response.Response(String),
) -> Result(ListFineTuningJobEventsResponse, error.GlopenaiError)
Parse the response from listing fine-tuning job events.
pub fn list_request(
config: config.Config,
) -> request.Request(String)
Build a request to list fine-tuning jobs.
pub fn list_response(
response: response.Response(String),
) -> Result(
ListPaginatedFineTuningJobsResponse,
error.GlopenaiError,
)
Parse the response from listing fine-tuning jobs.
pub fn n_epochs_decoder() -> decode.Decoder(NEpochs)
pub fn new_create_request(
model model: String,
training_file training_file: String,
) -> CreateFineTuningJobRequest
Create a new fine-tuning job request with required fields.
pub fn pause_request(
config: config.Config,
fine_tuning_job_id: String,
) -> request.Request(String)
Build a request to pause a fine-tuning job.
pub fn pause_response(
response: response.Response(String),
) -> Result(FineTuningJob, error.GlopenaiError)
Parse the response from pausing a fine-tuning job.
pub fn reinforcement_hyperparameters_decoder() -> decode.Decoder(
FineTuneReinforcementHyperparameters,
)
pub fn reinforcement_hyperparameters_to_json(
hp: FineTuneReinforcementHyperparameters,
) -> json.Json
pub fn resume_request(
config: config.Config,
fine_tuning_job_id: String,
) -> request.Request(String)
Build a request to resume a fine-tuning job.
pub fn resume_response(
response: response.Response(String),
) -> Result(FineTuningJob, error.GlopenaiError)
Parse the response from resuming a fine-tuning job.
pub fn retrieve_request(
config: config.Config,
fine_tuning_job_id: String,
) -> request.Request(String)
Build a request to retrieve a fine-tuning job.
pub fn retrieve_response(
response: response.Response(String),
) -> Result(FineTuningJob, error.GlopenaiError)
Parse the response from retrieving a fine-tuning job.
pub fn supervised_hyperparameters_decoder() -> decode.Decoder(
FineTuneSupervisedHyperparameters,
)
pub fn supervised_hyperparameters_to_json(
hp: FineTuneSupervisedHyperparameters,
) -> json.Json
pub fn wandb_decoder() -> decode.Decoder(WandB)
pub fn with_integrations(
request: CreateFineTuningJobRequest,
integrations: List(FineTuningIntegration),
) -> CreateFineTuningJobRequest
pub fn with_metadata(
request: CreateFineTuningJobRequest,
metadata: dynamic.Dynamic,
) -> CreateFineTuningJobRequest
pub fn with_method(
request: CreateFineTuningJobRequest,
method: FineTuneMethod,
) -> CreateFineTuningJobRequest
pub fn with_seed(
request: CreateFineTuningJobRequest,
seed: Int,
) -> CreateFineTuningJobRequest
pub fn with_suffix(
request: CreateFineTuningJobRequest,
suffix: String,
) -> CreateFineTuningJobRequest
pub fn with_validation_file(
request: CreateFineTuningJobRequest,
validation_file: String,
) -> CreateFineTuningJobRequest