Class: Google::Cloud::AIPlatform::V1::TuningJob

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/tuning_job.rb

Overview

Represents a TuningJob that runs with Google owned models.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#base_model ⇒ ::String

Returns The base model that is being tuned. See Supported models.

Note: The following fields are mutually exclusive: base_model, pre_tuned_model. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The base model that is being tuned. See Supported models.

    Note: The following fields are mutually exclusive: base_model, pre_tuned_model. If a field in that set is populated, all other fields in the set will automatically be cleared.



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the TuningJob was created.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. The description of the TuningJob.

Returns:

  • (::String) —

    Optional. The description of the TuningJob.



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

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

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the TuningJob entered any of the following JobStates: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED, JOB_STATE_EXPIRED.

Returns:

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



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

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

Returns:

  • (::Google::Rpc::Status) —

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



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#experiment ⇒ ::String (readonly)

Returns Output only. The Experiment associated with this TuningJob.

Returns:

  • (::String) —

    Output only. The Experiment associated with this TuningJob.



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    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.



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pre_tuned_model ⇒ ::Google::Cloud::AIPlatform::V1::PreTunedModel

Returns The pre-tuned model for continuous tuning.

Note: The following fields are mutually exclusive: pre_tuned_model, base_model. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::PreTunedModel) —

    The pre-tuned model for continuous tuning.

    Note: The following fields are mutually exclusive: pre_tuned_model, base_model. If a field in that set is populated, all other fields in the set will automatically be cleared.



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account ⇒ ::String

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

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the TuningJob for the first time entered the JOB_STATE_RUNNING state.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::AIPlatform::V1::JobState (readonly)

Returns Output only. The detailed state of the job.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#supervised_tuning_spec ⇒ ::Google::Cloud::AIPlatform::V1::SupervisedTuningSpec

Returns Tuning Spec for Supervised Fine Tuning.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tuned_model ⇒ ::Google::Cloud::AIPlatform::V1::TunedModel (readonly)

Returns Output only. The tuned model resources associated with this TuningJob.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tuned_model_display_name ⇒ ::String

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

Returns:

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



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tuning_data_stats ⇒ ::Google::Cloud::AIPlatform::V1::TuningDataStats (readonly)

Returns Output only. The tuning data statistics associated with this TuningJob.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time when the TuningJob was most recently updated.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'proto_docs/google/cloud/aiplatform/v1/tuning_job.rb', line 119

class TuningJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end