Class TuningJob
-
- All Implemented Interfaces:
public abstract class TuningJob extends JsonSerializable
A tuning job.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public abstract classTuningJob.BuilderBuilder for TuningJob.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description TuningJob()
-
Method Summary
Modifier and Type Method Description abstract Optional<HttpResponse>sdkHttpResponse()Used to retain the full HTTP response. abstract Optional<String>name()Output only. abstract Optional<JobState>state()Output only. abstract Optional<Instant>createTime()Output only. abstract Optional<Instant>startTime()Output only. abstract Optional<Instant>endTime()Output only. abstract Optional<Instant>updateTime()Output only. abstract Optional<GoogleRpcStatus>error()Output only. abstract Optional<String>description()Optional. abstract Optional<String>baseModel()The base model that is being tuned. abstract Optional<TunedModel>tunedModel()Output only. abstract Optional<PreTunedModel>preTunedModel()The pre-tuned model for continuous tuning. abstract Optional<SupervisedTuningSpec>supervisedTuningSpec()Tuning Spec for Supervised Fine Tuning. abstract Optional<PreferenceOptimizationSpec>preferenceOptimizationSpec()Tuning Spec for Preference Optimization. abstract Optional<DistillationSpec>distillationSpec()Tuning Spec for Distillation. abstract Optional<TuningDataStats>tuningDataStats()Output only. abstract Optional<EncryptionSpec>encryptionSpec()Customer-managed encryption key options for a TuningJob. abstract Optional<PartnerModelTuningSpec>partnerModelTuningSpec()Tuning Spec for open sourced and third party Partner models. abstract Optional<EvaluationConfig>evaluationConfig()Evaluation config for the tuning job. abstract Optional<String>customBaseModel()Optional. abstract Optional<List<EvaluateDatasetRun>>evaluateDatasetRuns()Output only. abstract Optional<String>experiment()Output only. abstract Optional<FullFineTuningSpec>fullFineTuningSpec()Tuning Spec for Full Fine Tuning. abstract Optional<Map<String, String>>labels()Optional. abstract Optional<String>outputUri()Optional. abstract Optional<String>pipelineJob()Output only. abstract Optional<String>serviceAccount()The service account that the tuningJob workload runs as. abstract Optional<String>tunedModelDisplayName()Optional. abstract Optional<TuningJobState>tuningJobState()Output only. abstract Optional<VeoTuningSpec>veoTuningSpec()Tuning Spec for Veo Tuning. abstract Optional<DistillationSamplingSpec>distillationSamplingSpec()Optional. abstract Optional<TuningJobMetadata>tuningJobMetadata()Output only. static TuningJob.Builderbuilder()Instantiates a builder for TuningJob. abstract TuningJob.BuildertoBuilder()Creates a builder with the same values as this instance. static TuningJobfromJson(String jsonString)Deserializes a JSON string to a TuningJob object. -
Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
sdkHttpResponse
abstract Optional<HttpResponse> sdkHttpResponse()
Used to retain the full HTTP response.
-
name
abstract Optional<String> name()
Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
-
createTime
abstract Optional<Instant> createTime()
Output only. Time when the TuningJob was created.
-
startTime
abstract Optional<Instant> startTime()
Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
-
endTime
abstract Optional<Instant> endTime()
Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
-
updateTime
abstract Optional<Instant> updateTime()
Output only. Time when the TuningJob was most recently updated.
-
error
abstract Optional<GoogleRpcStatus> error()
Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
-
description
abstract Optional<String> description()
Optional. The description of the TuningJob.
-
baseModel
abstract Optional<String> baseModel()
The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).
-
tunedModel
abstract Optional<TunedModel> tunedModel()
Output only. The tuned model resources associated with this TuningJob.
-
preTunedModel
abstract Optional<PreTunedModel> preTunedModel()
The pre-tuned model for continuous tuning.
-
supervisedTuningSpec
abstract Optional<SupervisedTuningSpec> supervisedTuningSpec()
Tuning Spec for Supervised Fine Tuning.
-
preferenceOptimizationSpec
abstract Optional<PreferenceOptimizationSpec> preferenceOptimizationSpec()
Tuning Spec for Preference Optimization.
-
distillationSpec
abstract Optional<DistillationSpec> distillationSpec()
Tuning Spec for Distillation.
-
tuningDataStats
abstract Optional<TuningDataStats> tuningDataStats()
Output only. The tuning data statistics associated with this TuningJob.
-
encryptionSpec
abstract Optional<EncryptionSpec> encryptionSpec()
Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key.
-
partnerModelTuningSpec
abstract Optional<PartnerModelTuningSpec> partnerModelTuningSpec()
Tuning Spec for open sourced and third party Partner models.
-
evaluationConfig
abstract Optional<EvaluationConfig> evaluationConfig()
Evaluation config for the tuning job.
-
customBaseModel
abstract Optional<String> customBaseModel()
Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models.
-
evaluateDatasetRuns
abstract Optional<List<EvaluateDatasetRun>> evaluateDatasetRuns()
Output only. Evaluation runs for the Tuning Job.
-
experiment
abstract Optional<String> experiment()
Output only. The Experiment associated with this TuningJob.
-
fullFineTuningSpec
abstract Optional<FullFineTuningSpec> fullFineTuningSpec()
Tuning Spec for Full Fine Tuning.
-
labels
abstract Optional<Map<String, String>> labels()
Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
-
outputUri
abstract Optional<String> outputUri()
Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models.
-
pipelineJob
abstract Optional<String> pipelineJob()
Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.
-
serviceAccount
abstract Optional<String> serviceAccount()
The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
-
tunedModelDisplayName
abstract Optional<String> tunedModelDisplayName()
Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
-
tuningJobState
abstract Optional<TuningJobState> tuningJobState()
Output only. The detail state of the tuning job (while the overall `JobState` is running).
-
veoTuningSpec
abstract Optional<VeoTuningSpec> veoTuningSpec()
Tuning Spec for Veo Tuning.
-
distillationSamplingSpec
abstract Optional<DistillationSamplingSpec> distillationSamplingSpec()
Optional. Spec for creating a distillation dataset.
-
tuningJobMetadata
abstract Optional<TuningJobMetadata> tuningJobMetadata()
Output only. Tuning Job metadata.
-
builder
static TuningJob.Builder builder()
Instantiates a builder for TuningJob.
-
toBuilder
abstract TuningJob.Builder toBuilder()
Creates a builder with the same values as this instance.
-
-
-
-