Cloud AutoML V1beta1 Client - Class TablesDatasetMetadata (1.4.17)

Version 1.4.17

• 2.0.1 (latest)
• 2.0.0
• 1.6.5
• 1.5.4
• 1.4.17

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Cloud AutoML V1beta1 Client class TablesDatasetMetadata.

Metadata for a dataset used for AutoML Tables.

Generated from protobuf message google.cloud.automl.v1beta1.TablesDatasetMetadata

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ primary_table_spec_id	string Output only. The table_spec_id of the primary table of this dataset.
↳ target_column_spec_id	string column_spec_id of the primary table's column that should be used as the training & prediction target. This column must be non-nullable and have one of following data types (otherwise model creation will error): * CATEGORY * FLOAT64 If the type is CATEGORY , only up to 100 unique values may exist in that column across all rows. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.
↳ weight_column_spec_id	string column_spec_id of the primary table's column that should be used as the weight column, i.e. the higher the value the more important the row will be during model training. Required type: FLOAT64. Allowed values: 0 to 10000, inclusive on both ends; 0 means the row is ignored for training. If not set all rows are assumed to have equal weight of 1. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.
↳ ml_use_column_spec_id	string column_spec_id of the primary table column which specifies a possible ML use of the row, i.e. the column will be used to split the rows into TRAIN, VALIDATE and TEST sets. Required type: STRING. This column, if set, must either have all of TRAIN, VALIDATE, TEST among its values, or only have TEST, UNASSIGNED values. In the latter case the rows with UNASSIGNED value will be assigned by AutoML. Note that if a given ml use distribution makes it impossible to create a "good" model, that call will error describing the issue. If both this column_spec_id and primary table's time_column_spec_id are not set, then all rows are treated as UNASSIGNED. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.
↳ target_column_correlations	array|Google\Protobuf\Internal\MapField Output only. Correlations between TablesDatasetMetadata.target_column_spec_id, and other columns of the TablesDatasetMetadataprimary_table. Only set if the target column is set. Mapping from other column spec id to its CorrelationStats with the target column. This field may be stale, see the stats_update_time field for for the timestamp at which these stats were last updated.
↳ stats_update_time	Google\Protobuf\Timestamp Output only. The most recent timestamp when target_column_correlations field and all descendant ColumnSpec.data_stats and ColumnSpec.top_correlated_columns fields were last (re-)generated. Any changes that happened to the dataset afterwards are not reflected in these fields values. The regeneration happens in the background on a best effort basis.

getPrimaryTableSpecId

Output only. The table_spec_id of the primary table of this dataset.

Returns
Type	Description
string

setPrimaryTableSpecId

Output only. The table_spec_id of the primary table of this dataset.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTargetColumnSpecId

column_spec_id of the primary table's column that should be used as the training & prediction target.

This column must be non-nullable and have one of following data types (otherwise model creation will error):

• CATEGORY
• FLOAT64 If the type is CATEGORY , only up to 100 unique values may exist in that column across all rows. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

Returns
Type	Description
string

setTargetColumnSpecId

column_spec_id of the primary table's column that should be used as the training & prediction target.

This column must be non-nullable and have one of following data types (otherwise model creation will error):

• CATEGORY
• FLOAT64 If the type is CATEGORY , only up to 100 unique values may exist in that column across all rows. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getWeightColumnSpecId

column_spec_id of the primary table's column that should be used as the weight column, i.e. the higher the value the more important the row will be during model training.

Required type: FLOAT64. Allowed values: 0 to 10000, inclusive on both ends; 0 means the row is ignored for training. If not set all rows are assumed to have equal weight of 1. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

Returns
Type	Description
string

setWeightColumnSpecId

column_spec_id of the primary table's column that should be used as the weight column, i.e. the higher the value the more important the row will be during model training.

Required type: FLOAT64. Allowed values: 0 to 10000, inclusive on both ends; 0 means the row is ignored for training. If not set all rows are assumed to have equal weight of 1. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMlUseColumnSpecId

column_spec_id of the primary table column which specifies a possible ML use of the row, i.e. the column will be used to split the rows into TRAIN, VALIDATE and TEST sets.

Required type: STRING. This column, if set, must either have all of TRAIN, VALIDATE, TEST among its values, or only have TEST, UNASSIGNED values. In the latter case the rows with UNASSIGNED value will be assigned by AutoML. Note that if a given ml use distribution makes it impossible to create a "good" model, that call will error describing the issue. If both this column_spec_id and primary table's time_column_spec_id are not set, then all rows are treated as UNASSIGNED. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

Returns
Type	Description
string

setMlUseColumnSpecId

column_spec_id of the primary table column which specifies a possible ML use of the row, i.e. the column will be used to split the rows into TRAIN, VALIDATE and TEST sets.

Required type: STRING. This column, if set, must either have all of TRAIN, VALIDATE, TEST among its values, or only have TEST, UNASSIGNED values. In the latter case the rows with UNASSIGNED value will be assigned by AutoML. Note that if a given ml use distribution makes it impossible to create a "good" model, that call will error describing the issue. If both this column_spec_id and primary table's time_column_spec_id are not set, then all rows are treated as UNASSIGNED. NOTE: Updates of this field will instantly affect any other users concurrently working with the dataset.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTargetColumnCorrelations

Output only. Correlations between TablesDatasetMetadata.target_column_spec_id, and other columns of the TablesDatasetMetadataprimary_table.

Only set if the target column is set. Mapping from other column spec id to its CorrelationStats with the target column. This field may be stale, see the stats_update_time field for for the timestamp at which these stats were last updated.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setTargetColumnCorrelations

Output only. Correlations between TablesDatasetMetadata.target_column_spec_id, and other columns of the TablesDatasetMetadataprimary_table.

Only set if the target column is set. Mapping from other column spec id to its CorrelationStats with the target column. This field may be stale, see the stats_update_time field for for the timestamp at which these stats were last updated.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getStatsUpdateTime

Output only. The most recent timestamp when target_column_correlations field and all descendant ColumnSpec.data_stats and ColumnSpec.top_correlated_columns fields were last (re-)generated. Any changes that happened to the dataset afterwards are not reflected in these fields values. The regeneration happens in the background on a best effort basis.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasStatsUpdateTime

clearStatsUpdateTime

setStatsUpdateTime

Output only. The most recent timestamp when target_column_correlations field and all descendant ColumnSpec.data_stats and ColumnSpec.top_correlated_columns fields were last (re-)generated. Any changes that happened to the dataset afterwards are not reflected in these fields values. The regeneration happens in the background on a best effort basis.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this