Class FineTuningJob
-
- All Implemented Interfaces:
public final class FineTuningJobThe
fine_tuning.jobobject represents a fine-tuning job that has been created through the API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFineTuningJob.BuilderA builder for FineTuningJob.
public final classFineTuningJob.ErrorFor fine-tuning jobs that have
failed, this will contain more information on the cause of the failure.public final classFineTuningJob.HyperparametersThe hyperparameters used for the fine-tuning job. This value will only be returned when running
supervisedjobs.public final classFineTuningJob.StatusThe current status of the fine-tuning job, which can be either
validating_files,queued,running,succeeded,failed, orcancelled.public final classFineTuningJob.MetadataSet 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.
public final classFineTuningJob.MethodThe method used for fine-tuning.
-
Method Summary
Modifier and Type Method Description final Stringid()The object identifier, which can be referenced in the API endpoints. final LongcreatedAt()The Unix timestamp (in seconds) for when the fine-tuning job was created. final Optional<FineTuningJob.Error>error()For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.final Optional<String>fineTunedModel()The name of the fine-tuned model that is being created. final Optional<Long>finishedAt()The Unix timestamp (in seconds) for when the fine-tuning job was finished. final FineTuningJob.Hyperparametershyperparameters()The hyperparameters used for the fine-tuning job. final Stringmodel()The base model that is being fine-tuned. final JsonValue_object_()The object type, which is always "fine_tuning.job". final StringorganizationId()The organization that owns the fine-tuning job. final List<String>resultFiles()The compiled results file ID(s) for the fine-tuning job. final Longseed()The seed used for the fine-tuning job. final FineTuningJob.Statusstatus()The current status of the fine-tuning job, which can be either validating_files,queued,running,succeeded,failed, orcancelled.final Optional<Long>trainedTokens()The total number of billable tokens processed by this fine-tuning job. final StringtrainingFile()The file ID used for training. final Optional<String>validationFile()The file ID used for validation. final Optional<Long>estimatedFinish()The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. final Optional<List<FineTuningJobWandbIntegrationObject>>integrations()A list of integrations to enable for this fine-tuning job. final Optional<FineTuningJob.Metadata>metadata()Set of 16 key-value pairs that can be attached to an object. final Optional<FineTuningJob.Method>method()The method used for fine-tuning. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<Long>_createdAt()Returns the raw JSON value of createdAt. final JsonField<FineTuningJob.Error>_error()Returns the raw JSON value of error. final JsonField<String>_fineTunedModel()Returns the raw JSON value of fineTunedModel. final JsonField<Long>_finishedAt()Returns the raw JSON value of finishedAt. final JsonField<FineTuningJob.Hyperparameters>_hyperparameters()Returns the raw JSON value of hyperparameters. final JsonField<String>_model()Returns the raw JSON value of model. final JsonField<String>_organizationId()Returns the raw JSON value of organizationId. final JsonField<List<String>>_resultFiles()Returns the raw JSON value of resultFiles. final JsonField<Long>_seed()Returns the raw JSON value of seed. final JsonField<FineTuningJob.Status>_status()Returns the raw JSON value of status. final JsonField<Long>_trainedTokens()Returns the raw JSON value of trainedTokens. final JsonField<String>_trainingFile()Returns the raw JSON value of trainingFile. final JsonField<String>_validationFile()Returns the raw JSON value of validationFile. final JsonField<Long>_estimatedFinish()Returns the raw JSON value of estimatedFinish. final JsonField<List<FineTuningJobWandbIntegrationObject>>_integrations()Returns the raw JSON value of integrations. final JsonField<FineTuningJob.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<FineTuningJob.Method>_method()Returns the raw JSON value of method. final Map<String, JsonValue>_additionalProperties()final FineTuningJob.BuildertoBuilder()final FineTuningJobvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FineTuningJob.Builderbuilder()Returns a mutable builder for constructing an instance of FineTuningJob. -
-
Method Detail
-
createdAt
final Long createdAt()
The Unix timestamp (in seconds) for when the fine-tuning job was created.
-
error
final Optional<FineTuningJob.Error> error()
For fine-tuning jobs that have
failed, this will contain more information on the cause of the failure.
-
fineTunedModel
final Optional<String> fineTunedModel()
The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.
-
finishedAt
final Optional<Long> finishedAt()
The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.
-
hyperparameters
final FineTuningJob.Hyperparameters hyperparameters()
The hyperparameters used for the fine-tuning job. This value will only be returned when running
supervisedjobs.
-
_object_
final JsonValue _object_()
The object type, which is always "fine_tuning.job".
Expected to always return the following:
JsonValue.from("fine_tuning.job")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
organizationId
final String organizationId()
The organization that owns the fine-tuning job.
-
resultFiles
final List<String> resultFiles()
The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the Files API.
-
status
final FineTuningJob.Status status()
The current status of the fine-tuning job, which can be either
validating_files,queued,running,succeeded,failed, orcancelled.
-
trainedTokens
final Optional<Long> trainedTokens()
The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.
-
trainingFile
final String trainingFile()
The file ID used for training. You can retrieve the training data with the Files API.
-
validationFile
final Optional<String> validationFile()
The file ID used for validation. You can retrieve the validation results with the Files API.
-
estimatedFinish
final Optional<Long> estimatedFinish()
The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.
-
integrations
final Optional<List<FineTuningJobWandbIntegrationObject>> integrations()
A list of integrations to enable for this fine-tuning job.
-
metadata
final Optional<FineTuningJob.Metadata> metadata()
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.
-
method
final Optional<FineTuningJob.Method> method()
The method used for fine-tuning.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_error
final JsonField<FineTuningJob.Error> _error()
Returns the raw JSON value of error.
Unlike error, this method doesn't throw if the JSON field has an unexpected type.
-
_fineTunedModel
final JsonField<String> _fineTunedModel()
Returns the raw JSON value of fineTunedModel.
Unlike fineTunedModel, this method doesn't throw if the JSON field has an unexpected type.
-
_finishedAt
final JsonField<Long> _finishedAt()
Returns the raw JSON value of finishedAt.
Unlike finishedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_hyperparameters
final JsonField<FineTuningJob.Hyperparameters> _hyperparameters()
Returns the raw JSON value of hyperparameters.
Unlike hyperparameters, this method doesn't throw if the JSON field has an unexpected type.
-
_model
final JsonField<String> _model()
Returns the raw JSON value of model.
Unlike model, this method doesn't throw if the JSON field has an unexpected type.
-
_organizationId
final JsonField<String> _organizationId()
Returns the raw JSON value of organizationId.
Unlike organizationId, this method doesn't throw if the JSON field has an unexpected type.
-
_resultFiles
final JsonField<List<String>> _resultFiles()
Returns the raw JSON value of resultFiles.
Unlike resultFiles, this method doesn't throw if the JSON field has an unexpected type.
-
_seed
final JsonField<Long> _seed()
Returns the raw JSON value of seed.
Unlike seed, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<FineTuningJob.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_trainedTokens
final JsonField<Long> _trainedTokens()
Returns the raw JSON value of trainedTokens.
Unlike trainedTokens, this method doesn't throw if the JSON field has an unexpected type.
-
_trainingFile
final JsonField<String> _trainingFile()
Returns the raw JSON value of trainingFile.
Unlike trainingFile, this method doesn't throw if the JSON field has an unexpected type.
-
_validationFile
final JsonField<String> _validationFile()
Returns the raw JSON value of validationFile.
Unlike validationFile, this method doesn't throw if the JSON field has an unexpected type.
-
_estimatedFinish
final JsonField<Long> _estimatedFinish()
Returns the raw JSON value of estimatedFinish.
Unlike estimatedFinish, this method doesn't throw if the JSON field has an unexpected type.
-
_integrations
final JsonField<List<FineTuningJobWandbIntegrationObject>> _integrations()
Returns the raw JSON value of integrations.
Unlike integrations, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<FineTuningJob.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_method
final JsonField<FineTuningJob.Method> _method()
Returns the raw JSON value of method.
Unlike method, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FineTuningJob.Builder toBuilder()
-
validate
final FineTuningJob validate()
-
builder
final static FineTuningJob.Builder builder()
Returns a mutable builder for constructing an instance of FineTuningJob.
The following fields are required:
.id() .createdAt() .error() .fineTunedModel() .finishedAt() .hyperparameters() .model() .organizationId() .resultFiles() .seed() .status() .trainedTokens() .trainingFile() .validationFile()
-
-
-
-