Show / Hide Table of Contents

Class GoogleCloudAiplatformV1InputDataConfig

Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.

Inheritance
object
GoogleCloudAiplatformV1InputDataConfig
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1InputDataConfig : IDirectResponseSchema

Properties

AnnotationSchemaUri

Applicable only to custom training with Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.

Declaration
[JsonProperty("annotationSchemaUri")]
public virtual string AnnotationSchemaUri { get; set; }
Property Value
Type Description
string

AnnotationsFilter

Applicable only to Datasets that have DataItems and Annotations. A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.

Declaration
[JsonProperty("annotationsFilter")]
public virtual string AnnotationsFilter { get; set; }
Property Value
Type Description
string

BigqueryDestination

Only applicable to custom training with tabular Dataset with BigQuery source. The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name dataset___ where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, training, validation and test. * AIP_DATA_FORMAT = "bigquery". * AIP_TRAINING_DATA_URI = "bigquery_destination.dataset___.training" * AIP_VALIDATION_DATA_URI = "bigquery_destination.dataset___.validation" * AIP_TEST_DATA_URI = "bigquery_destination.dataset___.test"

Declaration
[JsonProperty("bigqueryDestination")]
public virtual GoogleCloudAiplatformV1BigQueryDestination BigqueryDestination { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1BigQueryDestination

DatasetId

Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline's training_task_definition. For tabular Datasets, all their data is exported to training, to pick and choose from.

Declaration
[JsonProperty("datasetId")]
public virtual string DatasetId { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FilterSplit

Split based on the provided filters for each set.

Declaration
[JsonProperty("filterSplit")]
public virtual GoogleCloudAiplatformV1FilterSplit FilterSplit { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1FilterSplit

FractionSplit

Split based on fractions defining the size of each set.

Declaration
[JsonProperty("fractionSplit")]
public virtual GoogleCloudAiplatformV1FractionSplit FractionSplit { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1FractionSplit

GcsDestination

The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: dataset--- where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory. The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: "gs://.../training-.jsonl" * AIP_DATA_FORMAT = "jsonl" for non-tabular data, "csv" for tabular data * AIP_TRAINING_DATA_URI = "gcs_destination/dataset---/training-.${AIP_DATA_FORMAT}" * AIP_VALIDATION_DATA_URI = "gcs_destination/dataset---/validation-.${AIP_DATA_FORMAT}" * AIP_TEST_DATA_URI = "gcs_destination/dataset---/test-.${AIP_DATA_FORMAT}"

Declaration
[JsonProperty("gcsDestination")]
public virtual GoogleCloudAiplatformV1GcsDestination GcsDestination { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1GcsDestination

PersistMlUseAssignment

Whether to persist the ML use assignment to data item system labels.

Declaration
[JsonProperty("persistMlUseAssignment")]
public virtual bool? PersistMlUseAssignment { get; set; }
Property Value
Type Description
bool?

PredefinedSplit

Supported only for tabular Datasets. Split based on a predefined key.

Declaration
[JsonProperty("predefinedSplit")]
public virtual GoogleCloudAiplatformV1PredefinedSplit PredefinedSplit { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1PredefinedSplit

SavedQueryId

Only applicable to Datasets that have SavedQueries. The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.

Declaration
[JsonProperty("savedQueryId")]
public virtual string SavedQueryId { get; set; }
Property Value
Type Description
string

StratifiedSplit

Supported only for tabular Datasets. Split based on the distribution of the specified column.

Declaration
[JsonProperty("stratifiedSplit")]
public virtual GoogleCloudAiplatformV1StratifiedSplit StratifiedSplit { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1StratifiedSplit

TimestampSplit

Supported only for tabular Datasets. Split based on the timestamp of the input data pieces.

Declaration
[JsonProperty("timestampSplit")]
public virtual GoogleCloudAiplatformV1TimestampSplit TimestampSplit { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1TimestampSplit

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX