Class TuningJob

    • Constructor Detail

      • TuningJob

        TuningJob()
    • Method Detail

      • name

         abstract Optional<String> name()

        Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`

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

      • error

         abstract Optional<GoogleRpcStatus> error()

        Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.

      • 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).

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

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

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