class OpenAI::FineTuningJobRequest

Included Modules

Extended Modules

Defined in:

openai/api/fine_tuning.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(training_file : String, model : String, validation_file : Nil | String = nil, hyperparameters : OpenAI::HyperParams | Nil = nil, suffix : Nil | String = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def hyperparameters : HyperParams | Nil #

The hyperparameters used for the fine-tuning job.


[View source]
def hyperparameters=(hyperparameters : HyperParams | Nil) #

The hyperparameters used for the fine-tuning job.


[View source]
def model : String #

The name of the model to fine-tune. You can select one of the supported models.


[View source]
def model=(model : String) #

The name of the model to fine-tune. You can select one of the supported models.


[View source]
def suffix : String | Nil #

A string of up to 18 characters that will be added to your fine-tuned model name.

For example, a suffix of "custom-model-name" would produce a model name like ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel.


[View source]
def suffix=(suffix : String | Nil) #

A string of up to 18 characters that will be added to your fine-tuned model name.

For example, a suffix of "custom-model-name" would produce a model name like ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel.


[View source]
def training_file : String #

The ID of an uploaded file that contains training data. See upload file for how to upload a file. Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune.


[View source]
def training_file=(training_file : String) #

The ID of an uploaded file that contains training data. See upload file for how to upload a file. Your dataset must be formatted as a JSONL file. Additionally, you must upload your file with the purpose fine-tune.


[View source]
def validation_file : String | Nil #

The ID of an uploaded file that contains validation data.

If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.

Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.


[View source]
def validation_file=(validation_file : String | Nil) #

The ID of an uploaded file that contains validation data.

If you provide this file, the data is used to generate validation metrics periodically during fine-tuning. These metrics can be viewed in the fine-tuning results file. The same data should not be present in both train and validation files.

Your dataset must be formatted as a JSONL file. You must upload your file with the purpose fine-tune.


[View source]