Struct GoogleCloudAiplatformV1TrainingPipeline

pub struct GoogleCloudAiplatformV1TrainingPipeline {

    pub start_time: Option<DateTime<Utc>>,
    pub end_time: Option<DateTime<Utc>>,
    pub training_task_metadata: Option<Value>,
    pub training_task_definition: Option<String>,
    pub display_name: Option<String>,
    pub name: Option<String>,
    pub input_data_config: Option<GoogleCloudAiplatformV1InputDataConfig>,
    pub create_time: Option<DateTime<Utc>>,
    pub error: Option<GoogleRpcStatus>,
    pub state: Option<String>,
    pub model_to_upload: Option<GoogleCloudAiplatformV1Model>,
    pub labels: Option<HashMap<String, String>>,
    pub model_id: Option<String>,
    pub parent_model: Option<String>,
    pub update_time: Option<DateTime<Utc>>,
    pub training_task_inputs: Option<Value>,
    pub encryption_spec: Option<GoogleCloudAiplatformV1EncryptionSpec>,
}

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.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations training pipelines create projects (request|response)
• locations training pipelines get projects (response)

Fields

start_time: Option<DateTime<Utc>>

Output only. Time when the TrainingPipeline for the first time entered the PIPELINE_STATE_RUNNING state.

end_time: Option<DateTime<Utc>>

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

training_task_metadata: Option<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.

training_task_definition: Option<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.

display_name: Option<String>

Required. The user-defined name of this TrainingPipeline.

name: Option<String>

Output only. Resource name of the TrainingPipeline.

input_data_config: Option<GoogleCloudAiplatformV1InputDataConfig>

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.

create_time: Option<DateTime<Utc>>

Output only. Time when the TrainingPipeline was created.

error: Option<GoogleRpcStatus>

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

state: Option<String>

Output only. The detailed state of the pipeline.

model_to_upload: Option<GoogleCloudAiplatformV1Model>

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.

labels: Option<HashMap<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.

model_id: Option<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.

parent_model: Option<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.

update_time: Option<DateTime<Utc>>

Output only. Time when the TrainingPipeline was most recently updated.

training_task_inputs: Option<Value>

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

encryption_spec: Option<GoogleCloudAiplatformV1EncryptionSpec>

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.

Trait Implementations

impl Clone for GoogleCloudAiplatformV1TrainingPipeline

fn clone(&self) -> GoogleCloudAiplatformV1TrainingPipeline

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GoogleCloudAiplatformV1TrainingPipeline

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GoogleCloudAiplatformV1TrainingPipeline

fn default() -> GoogleCloudAiplatformV1TrainingPipeline

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudAiplatformV1TrainingPipeline

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoogleCloudAiplatformV1TrainingPipeline

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for GoogleCloudAiplatformV1TrainingPipeline

impl ResponseResult for GoogleCloudAiplatformV1TrainingPipeline