Class: OpenAI::Models::FineTuning::JobCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/fine_tuning/job_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Model Classes: Hyperparameters, Integration, Method

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(project: , entity: nil, name: nil, tags: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::FineTuning::JobCreateParams::Integration::Wandb for more details.

The settings for your integration with Weights and Biases. This payload specifies the project that metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags to your run, and set a default entity (team, username, etc) to be associated with your run.

Parameters:

  • project (String) (defaults to: ) —

    The name of the project that the new run will be created under.

  • entity (String, nil) (defaults to: nil) —

    The entity to use for the run. This allows you to set the team or username of th

  • name (String, nil) (defaults to: nil) —

    A display name to set for the run. If not set, we will use the Job ID as the nam

  • tags (Array<String>) (defaults to: nil) —

    A list of tags to be attached to the newly created run. These tags are passed th




# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 109

Instance Attribute Details

#hyperparameters ⇒ OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters?

Deprecated.

The hyperparameters used for the fine-tuning job. This value is now deprecated in favor of ‘method`, and should be passed in under the `method` parameter.

Returns:



47
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 47

optional :hyperparameters, -> { OpenAI::FineTuning::JobCreateParams::Hyperparameters }

#integrations ⇒ Array<OpenAI::Models::FineTuning::JobCreateParams::Integration>?

A list of integrations to enable for your fine-tuning job.

Returns:



53
54
55
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 53

optional :integrations,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::FineTuning::JobCreateParams::Integration] },
nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

  • (Hash{Symbol=>String}, nil) 


66
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 66

optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#method_ ⇒ OpenAI::Models::FineTuning::JobCreateParams::Method?

The method used for fine-tuning.

Returns:



72
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 72

optional :method_, -> { OpenAI::FineTuning::JobCreateParams::Method }, api_name: :method

#model ⇒ String, ...

The name of the model to fine-tune. You can select one of the [supported models](platform.openai.com/docs/guides/fine-tuning#which-models-can-be-fine-tuned).

Returns:



16
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 16

required :model, union: -> { OpenAI::FineTuning::JobCreateParams::Model }

#seed ⇒ Integer?

The seed controls the reproducibility of the job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.

Returns:

  • (Integer, nil) 


80
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 80

optional :seed, Integer, nil?: true

#suffix ⇒ String?

A string of up to 64 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-4o-mini:openai:custom-model-name:7p4lURel`.

Returns:

  • (String, nil) 


90
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 90

optional :suffix, String, nil?: true

#training_file ⇒ String

The ID of an uploaded file that contains training data.

See [upload file](platform.openai.com/docs/api-reference/files/create) 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`.

The contents of the file should differ depending on if the model uses the [chat](platform.openai.com/docs/api-reference/fine-tuning/chat-input), [completions](platform.openai.com/docs/api-reference/fine-tuning/completions-input) format, or if the fine-tuning method uses the [preference](platform.openai.com/docs/api-reference/fine-tuning/preference-input) format.

See the [fine-tuning guide](platform.openai.com/docs/guides/fine-tuning) for more details.

Returns:

  • (String) 


38
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 38

required :training_file, String

#validation_file ⇒ String?

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`.

See the [fine-tuning guide](platform.openai.com/docs/guides/fine-tuning) for more details.

Returns:

  • (String, nil) 


107
 
# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 107

optional :validation_file, String, nil?: true

Class Method Details

.variants ⇒ Array(Symbol, :auto, Integer)

Returns:

  • (Array(Symbol, :auto, Integer)) 



# File 'lib/openai/models/fine_tuning/job_create_params.rb', line 243