Cloud AI Platform v1 API - Class TrainingPipeline (2.18.0)

public sealed class TrainingPipeline : IMessage<TrainingPipeline>, IEquatable<TrainingPipeline>, IDeepCloneable<TrainingPipeline>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class TrainingPipeline.

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][google.cloud.aiplatform.v1.ModelService.UploadModel] the Model to Vertex AI, and evaluate the Model.

Inheritance

object > TrainingPipeline

Implements

IMessage TrainingPipeline, IEquatable TrainingPipeline, IDeepCloneable TrainingPipeline, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TrainingPipeline()

public TrainingPipeline()

TrainingPipeline(TrainingPipeline)

public TrainingPipeline(TrainingPipeline other)

Parameter
Name	Description
`other`	`TrainingPipeline`

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time when the TrainingPipeline was created.

Property Value
Type	Description
`Timestamp`

DisplayName

public string DisplayName { get; set; }

Required. The user-defined name of this TrainingPipeline.

Property Value
Type	Description
`string`

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

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][google.cloud.aiplatform.v1.TrainingPipeline.encryption_spec] is not set separately.

Property Value
Type	Description
`EncryptionSpec`

EndTime

public Timestamp EndTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

Error

public Status Error { get; set; }

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

Property Value
Type	Description
`Status`

InputDataConfig

public InputDataConfig InputDataConfig { get; set; }

Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.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][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition], then it should be assumed that the TrainingPipeline does not depend on this configuration.

Property Value
Type	Description
`InputDataConfig`

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type	Description
`MapFieldstringstring`

ModelId

public string ModelId { get; set; }

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.

Property Value
Type	Description
`string`

ModelToUpload

public Model ModelToUpload { get; set; }

Describes the Model that may be uploaded (via [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel]) by this TrainingPipeline. The TrainingPipeline's [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.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][google.cloud.aiplatform.v1.TrainingPipeline.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][google.cloud.aiplatform.v1.Model.name] is populated. The Model is always uploaded into the Project and Location in which this pipeline is.

Property Value
Type	Description
`Model`

Name

public string Name { get; set; }

Output only. Resource name of the TrainingPipeline.

Property Value
Type	Description
`string`

ParentModel

public string ParentModel { get; set; }

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.

Property Value
Type	Description
`string`

StartTime

public Timestamp StartTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

State

public PipelineState State { get; set; }

Output only. The detailed state of the pipeline.

Property Value
Type	Description
`PipelineState`

TrainingPipelineName

public TrainingPipelineName TrainingPipelineName { get; set; }

TrainingPipelineName-typed view over the Name resource name property.

Property Value
Type	Description
`TrainingPipelineName`

TrainingTaskDefinition

public string TrainingTaskDefinition { get; set; }

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.

Property Value
Type	Description
`string`

TrainingTaskInputs

public Value TrainingTaskInputs { get; set; }

Required. The training task's parameter(s), as specified in the [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition]'s inputs.

Property Value
Type	Description
`Value`

TrainingTaskMetadata

public Value TrainingTaskMetadata { get; set; }

Output only. The metadata information as specified in the [training_task_definition][google.cloud.aiplatform.v1.TrainingPipeline.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][google.cloud.aiplatform.v1.TrainingPipeline.training_task_definition] contains metadata object.

Property Value
Type	Description
`Value`

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type	Description
`Timestamp`