Class: Google::Cloud::AutoML::V1beta1::TablesDatasetMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/automl/v1beta1/tables.rb

Overview

Metadata for a dataset used for AutoML Tables.

Defined Under Namespace

Classes: TargetColumnCorrelationsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#ml_use_column_spec_id ⇒ ::String

Returns 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:

  • (::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.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/automl/v1beta1/tables.rb', line 90

class TablesDatasetMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::AutoML::V1beta1::CorrelationStats]
  class TargetColumnCorrelationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#primary_table_spec_id ⇒ ::String

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

Returns:

  • (::String) —

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



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/automl/v1beta1/tables.rb', line 90

class TablesDatasetMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::AutoML::V1beta1::CorrelationStats]
  class TargetColumnCorrelationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#stats_update_time ⇒ ::Google::Protobuf::Timestamp

Returns 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:

  • (::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.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/automl/v1beta1/tables.rb', line 90

class TablesDatasetMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::AutoML::V1beta1::CorrelationStats]
  class TargetColumnCorrelationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#target_column_correlations ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::AutoML::V1beta1::CorrelationStats}

Returns 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:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/automl/v1beta1/tables.rb', line 90

class TablesDatasetMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::AutoML::V1beta1::CorrelationStats]
  class TargetColumnCorrelationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#target_column_spec_id ⇒ ::String

Returns 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:

  • (::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.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/automl/v1beta1/tables.rb', line 90

class TablesDatasetMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::AutoML::V1beta1::CorrelationStats]
  class TargetColumnCorrelationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#weight_column_spec_id ⇒ ::String

Returns 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:

  • (::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.



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/automl/v1beta1/tables.rb', line 90

class TablesDatasetMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::AutoML::V1beta1::CorrelationStats]
  class TargetColumnCorrelationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end