Class: Google::Cloud::AIPlatform::V1::TrainingPipeline

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

Overview

The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI's Dataset which becomes the training input, upload the Model to Vertex AI, and evaluate the Model.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Time when the TrainingPipeline was created.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#display_name ⇒ ::String

Returns Required. The user-defined name of this TrainingPipeline.

Returns:

  • (::String) —

    Required. The user-defined name of this TrainingPipeline.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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 spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key.

Note: Model trained by this TrainingPipeline is also secured by this key if model_to_upload is not set separately.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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 TrainingPipeline entered any of the following states: PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED, PIPELINE_STATE_CANCELLED.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Time when the TrainingPipeline entered any of the following states: PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED, PIPELINE_STATE_CANCELLED.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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 the pipeline's state is PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED.

Returns:

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

    Output only. Only populated when the pipeline's state is PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#input_data_config ⇒ ::Google::Cloud::AIPlatform::V1::InputDataConfig

Returns Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline's training_task_definition should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the training_task_definition, then it should be assumed that the TrainingPipeline does not depend on this configuration.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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 The labels with user-defined metadata to organize TrainingPipelines.

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}) —

    The labels with user-defined metadata to organize TrainingPipelines.

    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.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#model_id ⇒ ::String

Returns Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name.

This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.

Returns:

  • (::String) —

    Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name.

    This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#model_to_upload ⇒ ::Google::Cloud::AIPlatform::V1::Model

Returns Describes the Model that may be uploaded (via ModelService.UploadModel) by this TrainingPipeline. The TrainingPipeline's training_task_definition should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the training_task_definition, then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline's state becomes PIPELINE_STATE_SUCCEEDED and the trained Model had been uploaded into Vertex AI, then the model_to_upload's resource name is populated. The Model is always uploaded into the Project and Location in which this pipeline is.

Returns:

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

    Describes the Model that may be uploaded (via ModelService.UploadModel) by this TrainingPipeline. The TrainingPipeline's training_task_definition should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the training_task_definition, then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline's state becomes PIPELINE_STATE_SUCCEEDED and the trained Model had been uploaded into Vertex AI, then the model_to_upload's resource name is populated. The Model is always uploaded into the Project and Location in which this pipeline is.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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. Resource name of the TrainingPipeline.

Returns:

  • (::String) —

    Output only. Resource name of the TrainingPipeline.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#parent_model ⇒ ::String

Returns Optional. When specify this field, the model_to_upload will not be uploaded as a new model, instead, it will become a new version of this parent_model.

Returns:

  • (::String) —

    Optional. When specify this field, the model_to_upload will not be uploaded as a new model, instead, it will become a new version of this parent_model.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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 TrainingPipeline for the first time entered the PIPELINE_STATE_RUNNING state.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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::PipelineState (readonly)

Returns Output only. The detailed state of the pipeline.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#training_task_definition ⇒ ::String

Returns Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

Returns:

  • (::String) —

    Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#training_task_inputs ⇒ ::Google::Protobuf::Value

Returns Required. The training task's parameter(s), as specified in the training_task_definition's inputs.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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

#training_task_metadata ⇒ ::Google::Protobuf::Value (readonly)

Returns Output only. The metadata information as specified in the training_task_definition's metadata. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's training_task_definition contains metadata object.

Returns:

  • (::Google::Protobuf::Value) —

    Output only. The metadata information as specified in the training_task_definition's metadata. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's training_task_definition contains metadata object.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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 TrainingPipeline was most recently updated.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/aiplatform/v1/training_pipeline.rb', line 140

class TrainingPipeline
  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