- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class TuningJob.
Represents a TuningJob that runs with Google owned models.
Generated from protobuf message google.cloud.aiplatform.v1.TuningJob
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ base_model
string
The base model that is being tuned, e.g., "gemini-1.0-pro-002".
↳ supervised_tuning_spec
↳ name
string
Output only. Identifier. Resource name of a TuningJob. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}
↳ tuned_model_display_name
string
Optional. The display name of the TunedModel . The name can be up to 128 characters long and can consist of any UTF-8 characters.
↳ description
↳ state
int
Output only. The detailed state of the job.
↳ create_time
↳ start_time
Google\Protobuf\Timestamp
Output only. Time when the TuningJob
for the first time entered the JOB_STATE_RUNNING
state.
↳ end_time
Google\Protobuf\Timestamp
Output only. Time when the TuningJob entered any of the following JobStates
: JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
, JOB_STATE_EXPIRED
.
↳ update_time
↳ error
Google\Rpc\Status
Output only. Only populated when job's state is JOB_STATE_FAILED
or JOB_STATE_CANCELLED
.
↳ labels
array| Google\Protobuf\Internal\MapField
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.
↳ experiment
↳ tuned_model
↳ tuning_data_stats
↳ encryption_spec
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.
↳ service_account
string
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.
getBaseModel
The base model that is being tuned, e.g., "gemini-1.0-pro-002".
string
hasBaseModel
setBaseModel
The base model that is being tuned, e.g., "gemini-1.0-pro-002".
var
string
$this
getSupervisedTuningSpec
Tuning Spec for Supervised Fine Tuning.
hasSupervisedTuningSpec
setSupervisedTuningSpec
Tuning Spec for Supervised Fine Tuning.
$this
getName
Output only. Identifier. Resource name of a TuningJob. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}
string
setName
Output only. Identifier. Resource name of a TuningJob. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}
var
string
$this
getTunedModelDisplayName
Optional. The display name of the TunedModel . The name can be up to 128 characters long and can consist of any UTF-8 characters.
string
setTunedModelDisplayName
Optional. The display name of the TunedModel . The name can be up to 128 characters long and can consist of any UTF-8 characters.
var
string
$this
getDescription
Optional. The description of the TuningJob .
string
setDescription
Optional. The description of the TuningJob .
var
string
$this
getState
Output only. The detailed state of the job.
int
setState
Output only. The detailed state of the job.
var
int
$this
getCreateTime
Output only. Time when the TuningJob was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the TuningJob was created.
$this
getStartTime
Output only. Time when the TuningJob
for the first time
entered the JOB_STATE_RUNNING
state.
hasStartTime
clearStartTime
setStartTime
Output only. Time when the TuningJob
for the first time
entered the JOB_STATE_RUNNING
state.
$this
getEndTime
Output only. Time when the TuningJob entered any of the following JobStates
: JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
, JOB_STATE_EXPIRED
.
hasEndTime
clearEndTime
setEndTime
Output only. Time when the TuningJob entered any of the following JobStates
: JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
, JOB_STATE_EXPIRED
.
$this
getUpdateTime
Output only. Time when the TuningJob was most recently updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the TuningJob was most recently updated.
$this
getError
Output only. Only populated when job's state is JOB_STATE_FAILED
or JOB_STATE_CANCELLED
.
hasError
clearError
setError
Output only. Only populated when job's state is JOB_STATE_FAILED
or JOB_STATE_CANCELLED
.
$this
getLabels
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.
setLabels
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.
$this
getExperiment
Output only. The Experiment associated with this TuningJob .
string
setExperiment
Output only. The Experiment associated with this TuningJob .
var
string
$this
getTunedModel
Output only. The tuned model resources assiociated with this TuningJob .
hasTunedModel
clearTunedModel
setTunedModel
Output only. The tuned model resources assiociated with this TuningJob .
$this
getTuningDataStats
Output only. The tuning data statistics associated with this TuningJob .
hasTuningDataStats
clearTuningDataStats
setTuningDataStats
Output only. The tuning data statistics associated with this TuningJob .
$this
getEncryptionSpec
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.
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
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.
$this
getServiceAccount
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.
string
setServiceAccount
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.
var
string
$this
getSourceModel
string
getTuningSpec
string
