Package com.google.cloud.automl.v1beta1

Class TablesModelMetadata

  • All Implemented Interfaces:
    TablesModelMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TablesModelMetadata
extends com.google.protobuf.GeneratedMessageV3
implements TablesModelMetadataOrBuilder
     Model metadata specific to AutoML Tables.
    Protobuf type google.cloud.automl.v1beta1.TablesModelMetadata
    See Also:
    Serialized Form

    • Field Detail

      • OPTIMIZATION_OBJECTIVE_RECALL_VALUE_FIELD_NUMBER

        public static final int OPTIMIZATION_OBJECTIVE_RECALL_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPTIMIZATION_OBJECTIVE_PRECISION_VALUE_FIELD_NUMBER

        public static final int OPTIMIZATION_OBJECTIVE_PRECISION_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_COLUMN_SPEC_FIELD_NUMBER

        public static final int TARGET_COLUMN_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_FEATURE_COLUMN_SPECS_FIELD_NUMBER

        public static final int INPUT_FEATURE_COLUMN_SPECS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

        public static final int OPTIMIZATION_OBJECTIVE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TABLES_MODEL_COLUMN_INFO_FIELD_NUMBER

        public static final int TABLES_MODEL_COLUMN_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRAIN_BUDGET_MILLI_NODE_HOURS_FIELD_NUMBER

        public static final int TRAIN_BUDGET_MILLI_NODE_HOURS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRAIN_COST_MILLI_NODE_HOURS_FIELD_NUMBER

        public static final int TRAIN_COST_MILLI_NODE_HOURS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_EARLY_STOPPING_FIELD_NUMBER

        public static final int DISABLE_EARLY_STOPPING_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasOptimizationObjectiveRecallValue

        public boolean hasOptimizationObjectiveRecallValue()
         Required when optimization_objective is "MAXIMIZE_PRECISION_AT_RECALL".
 Must be between 0 and 1, inclusive.
        float optimization_objective_recall_value = 17;
        Specified by:
        hasOptimizationObjectiveRecallValue in interface TablesModelMetadataOrBuilder
        Returns:
        Whether the optimizationObjectiveRecallValue field is set.

      • getOptimizationObjectiveRecallValue

        public float getOptimizationObjectiveRecallValue()
         Required when optimization_objective is "MAXIMIZE_PRECISION_AT_RECALL".
 Must be between 0 and 1, inclusive.
        float optimization_objective_recall_value = 17;
        Specified by:
        getOptimizationObjectiveRecallValue in interface TablesModelMetadataOrBuilder
        Returns:
        The optimizationObjectiveRecallValue.

      • hasOptimizationObjectivePrecisionValue

        public boolean hasOptimizationObjectivePrecisionValue()
         Required when optimization_objective is "MAXIMIZE_RECALL_AT_PRECISION".
 Must be between 0 and 1, inclusive.
        float optimization_objective_precision_value = 18;
        Specified by:
        hasOptimizationObjectivePrecisionValue in interface TablesModelMetadataOrBuilder
        Returns:
        Whether the optimizationObjectivePrecisionValue field is set.

      • getOptimizationObjectivePrecisionValue

        public float getOptimizationObjectivePrecisionValue()
         Required when optimization_objective is "MAXIMIZE_RECALL_AT_PRECISION".
 Must be between 0 and 1, inclusive.
        float optimization_objective_precision_value = 18;
        Specified by:
        getOptimizationObjectivePrecisionValue in interface TablesModelMetadataOrBuilder
        Returns:
        The optimizationObjectivePrecisionValue.

      • hasTargetColumnSpec

        public boolean hasTargetColumnSpec()
         Column spec of the dataset's primary table's column the model is
 predicting. Snapshotted when model creation started.
 Only 3 fields are used:
 name - May be set on CreateModel, if it's not then the ColumnSpec
        corresponding to the current target_column_spec_id of the dataset
        the model is trained from is used.
        If neither is set, CreateModel will error.
 display_name - Output only.
 data_type - Output only.
        .google.cloud.automl.v1beta1.ColumnSpec target_column_spec = 2;
        Specified by:
        hasTargetColumnSpec in interface TablesModelMetadataOrBuilder
        Returns:
        Whether the targetColumnSpec field is set.

      • getTargetColumnSpec

        public ColumnSpec getTargetColumnSpec()
         Column spec of the dataset's primary table's column the model is
 predicting. Snapshotted when model creation started.
 Only 3 fields are used:
 name - May be set on CreateModel, if it's not then the ColumnSpec
        corresponding to the current target_column_spec_id of the dataset
        the model is trained from is used.
        If neither is set, CreateModel will error.
 display_name - Output only.
 data_type - Output only.
        .google.cloud.automl.v1beta1.ColumnSpec target_column_spec = 2;
        Specified by:
        getTargetColumnSpec in interface TablesModelMetadataOrBuilder
        Returns:
        The targetColumnSpec.

      • getTargetColumnSpecOrBuilder

        public ColumnSpecOrBuilder getTargetColumnSpecOrBuilder()
         Column spec of the dataset's primary table's column the model is
 predicting. Snapshotted when model creation started.
 Only 3 fields are used:
 name - May be set on CreateModel, if it's not then the ColumnSpec
        corresponding to the current target_column_spec_id of the dataset
        the model is trained from is used.
        If neither is set, CreateModel will error.
 display_name - Output only.
 data_type - Output only.
        .google.cloud.automl.v1beta1.ColumnSpec target_column_spec = 2;
        Specified by:
        getTargetColumnSpecOrBuilder in interface TablesModelMetadataOrBuilder

      • getInputFeatureColumnSpecsList

        public List<ColumnSpec> getInputFeatureColumnSpecsList()
         Column specs of the dataset's primary table's columns, on which
 the model is trained and which are used as the input for predictions.
 The

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec]
 as well as, according to dataset's state upon model creation,

 [weight_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.weight_column_spec_id],
 and

 [ml_use_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.ml_use_column_spec_id]
 must never be included here.

 Only 3 fields are used:

 * name - May be set on CreateModel, if set only the columns specified are
   used, otherwise all primary table's columns (except the ones listed
   above) are used for the training and prediction input.

 * display_name - Output only.

 * data_type - Output only.
        repeated .google.cloud.automl.v1beta1.ColumnSpec input_feature_column_specs = 3;
        Specified by:
        getInputFeatureColumnSpecsList in interface TablesModelMetadataOrBuilder

      • getInputFeatureColumnSpecsOrBuilderList

        public List<? extends ColumnSpecOrBuilder> getInputFeatureColumnSpecsOrBuilderList()
         Column specs of the dataset's primary table's columns, on which
 the model is trained and which are used as the input for predictions.
 The

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec]
 as well as, according to dataset's state upon model creation,

 [weight_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.weight_column_spec_id],
 and

 [ml_use_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.ml_use_column_spec_id]
 must never be included here.

 Only 3 fields are used:

 * name - May be set on CreateModel, if set only the columns specified are
   used, otherwise all primary table's columns (except the ones listed
   above) are used for the training and prediction input.

 * display_name - Output only.

 * data_type - Output only.
        repeated .google.cloud.automl.v1beta1.ColumnSpec input_feature_column_specs = 3;
        Specified by:
        getInputFeatureColumnSpecsOrBuilderList in interface TablesModelMetadataOrBuilder

      • getInputFeatureColumnSpecsCount

        public int getInputFeatureColumnSpecsCount()
         Column specs of the dataset's primary table's columns, on which
 the model is trained and which are used as the input for predictions.
 The

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec]
 as well as, according to dataset's state upon model creation,

 [weight_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.weight_column_spec_id],
 and

 [ml_use_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.ml_use_column_spec_id]
 must never be included here.

 Only 3 fields are used:

 * name - May be set on CreateModel, if set only the columns specified are
   used, otherwise all primary table's columns (except the ones listed
   above) are used for the training and prediction input.

 * display_name - Output only.

 * data_type - Output only.
        repeated .google.cloud.automl.v1beta1.ColumnSpec input_feature_column_specs = 3;
        Specified by:
        getInputFeatureColumnSpecsCount in interface TablesModelMetadataOrBuilder

      • getInputFeatureColumnSpecs

        public ColumnSpec getInputFeatureColumnSpecs​(int index)
         Column specs of the dataset's primary table's columns, on which
 the model is trained and which are used as the input for predictions.
 The

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec]
 as well as, according to dataset's state upon model creation,

 [weight_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.weight_column_spec_id],
 and

 [ml_use_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.ml_use_column_spec_id]
 must never be included here.

 Only 3 fields are used:

 * name - May be set on CreateModel, if set only the columns specified are
   used, otherwise all primary table's columns (except the ones listed
   above) are used for the training and prediction input.

 * display_name - Output only.

 * data_type - Output only.
        repeated .google.cloud.automl.v1beta1.ColumnSpec input_feature_column_specs = 3;
        Specified by:
        getInputFeatureColumnSpecs in interface TablesModelMetadataOrBuilder

      • getInputFeatureColumnSpecsOrBuilder

        public ColumnSpecOrBuilder getInputFeatureColumnSpecsOrBuilder​(int index)
         Column specs of the dataset's primary table's columns, on which
 the model is trained and which are used as the input for predictions.
 The

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec]
 as well as, according to dataset's state upon model creation,

 [weight_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.weight_column_spec_id],
 and

 [ml_use_column][google.cloud.automl.v1beta1.TablesDatasetMetadata.ml_use_column_spec_id]
 must never be included here.

 Only 3 fields are used:

 * name - May be set on CreateModel, if set only the columns specified are
   used, otherwise all primary table's columns (except the ones listed
   above) are used for the training and prediction input.

 * display_name - Output only.

 * data_type - Output only.
        repeated .google.cloud.automl.v1beta1.ColumnSpec input_feature_column_specs = 3;
        Specified by:
        getInputFeatureColumnSpecsOrBuilder in interface TablesModelMetadataOrBuilder

      • getOptimizationObjective

        public String getOptimizationObjective()
         Objective function the model is optimizing towards. The training process
 creates a model that maximizes/minimizes the value of the objective
 function over the validation set.

 The supported optimization objectives depend on the prediction type.
 If the field is not set, a default objective function is used.

 CLASSIFICATION_BINARY:
   "MAXIMIZE_AU_ROC" (default) - Maximize the area under the receiver
                                 operating characteristic (ROC) curve.
   "MINIMIZE_LOG_LOSS" - Minimize log loss.
   "MAXIMIZE_AU_PRC" - Maximize the area under the precision-recall curve.
   "MAXIMIZE_PRECISION_AT_RECALL" - Maximize precision for a specified
                                   recall value.
   "MAXIMIZE_RECALL_AT_PRECISION" - Maximize recall for a specified
                                    precision value.

 CLASSIFICATION_MULTI_CLASS :
   "MINIMIZE_LOG_LOSS" (default) - Minimize log loss.


 REGRESSION:
   "MINIMIZE_RMSE" (default) - Minimize root-mean-squared error (RMSE).
   "MINIMIZE_MAE" - Minimize mean-absolute error (MAE).
   "MINIMIZE_RMSLE" - Minimize root-mean-squared log error (RMSLE).
        string optimization_objective = 4;
        Specified by:
        getOptimizationObjective in interface TablesModelMetadataOrBuilder
        Returns:
        The optimizationObjective.

      • getOptimizationObjectiveBytes

        public com.google.protobuf.ByteString getOptimizationObjectiveBytes()
         Objective function the model is optimizing towards. The training process
 creates a model that maximizes/minimizes the value of the objective
 function over the validation set.

 The supported optimization objectives depend on the prediction type.
 If the field is not set, a default objective function is used.

 CLASSIFICATION_BINARY:
   "MAXIMIZE_AU_ROC" (default) - Maximize the area under the receiver
                                 operating characteristic (ROC) curve.
   "MINIMIZE_LOG_LOSS" - Minimize log loss.
   "MAXIMIZE_AU_PRC" - Maximize the area under the precision-recall curve.
   "MAXIMIZE_PRECISION_AT_RECALL" - Maximize precision for a specified
                                   recall value.
   "MAXIMIZE_RECALL_AT_PRECISION" - Maximize recall for a specified
                                    precision value.

 CLASSIFICATION_MULTI_CLASS :
   "MINIMIZE_LOG_LOSS" (default) - Minimize log loss.


 REGRESSION:
   "MINIMIZE_RMSE" (default) - Minimize root-mean-squared error (RMSE).
   "MINIMIZE_MAE" - Minimize mean-absolute error (MAE).
   "MINIMIZE_RMSLE" - Minimize root-mean-squared log error (RMSLE).
        string optimization_objective = 4;
        Specified by:
        getOptimizationObjectiveBytes in interface TablesModelMetadataOrBuilder
        Returns:
        The bytes for optimizationObjective.

      • getTablesModelColumnInfoCount

        public int getTablesModelColumnInfoCount()
         Output only. Auxiliary information for each of the
 input_feature_column_specs with respect to this particular model.
        repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 5;
        Specified by:
        getTablesModelColumnInfoCount in interface TablesModelMetadataOrBuilder

      • getTablesModelColumnInfo

        public TablesModelColumnInfo getTablesModelColumnInfo​(int index)
         Output only. Auxiliary information for each of the
 input_feature_column_specs with respect to this particular model.
        repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 5;
        Specified by:
        getTablesModelColumnInfo in interface TablesModelMetadataOrBuilder

      • getTrainBudgetMilliNodeHours

        public long getTrainBudgetMilliNodeHours()
         Required. The train budget of creating this model, expressed in milli node
 hours i.e. 1,000 value in this field means 1 node hour.

 The training cost of the model will not exceed this budget. The final cost
 will be attempted to be close to the budget, though may end up being (even)
 noticeably smaller - at the backend's discretion. This especially may
 happen when further model training ceases to provide any improvements.

 If the budget is set to a value known to be insufficient to train a
 model for the given dataset, the training won't be attempted and
 will error.

 The train budget must be between 1,000 and 72,000 milli node hours,
 inclusive.
        int64 train_budget_milli_node_hours = 6;
        Specified by:
        getTrainBudgetMilliNodeHours in interface TablesModelMetadataOrBuilder
        Returns:
        The trainBudgetMilliNodeHours.

      • getTrainCostMilliNodeHours

        public long getTrainCostMilliNodeHours()
         Output only. The actual training cost of the model, expressed in milli
 node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed
 to not exceed the train budget.
        int64 train_cost_milli_node_hours = 7;
        Specified by:
        getTrainCostMilliNodeHours in interface TablesModelMetadataOrBuilder
        Returns:
        The trainCostMilliNodeHours.

      • getDisableEarlyStopping

        public boolean getDisableEarlyStopping()
         Use the entire training budget. This disables the early stopping feature.
 By default, the early stopping feature is enabled, which means that AutoML
 Tables might stop training before the entire training budget has been used.
        bool disable_early_stopping = 12;
        Specified by:
        getDisableEarlyStopping in interface TablesModelMetadataOrBuilder
        Returns:
        The disableEarlyStopping.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TablesModelMetadata parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesModelMetadata parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesModelMetadata parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesModelMetadata parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesModelMetadata parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesModelMetadata parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesModelMetadata parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TablesModelMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TablesModelMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TablesModelMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<TablesModelMetadata> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TablesModelMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder