Package com.google.cloud.aiplatform.v1.schema.trainingjob.definition

Class AutoMlTablesInputs

  • All Implemented Interfaces:
    AutoMlTablesInputsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AutoMlTablesInputs
extends com.google.protobuf.GeneratedMessageV3
implements AutoMlTablesInputsOrBuilder
    Protobuf type google.cloud.aiplatform.v1.schema.trainingjob.definition.AutoMlTablesInputs
    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

      • PREDICTION_TYPE_FIELD_NUMBER

        public static final int PREDICTION_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_COLUMN_FIELD_NUMBER

        public static final int TARGET_COLUMN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSFORMATIONS_FIELD_NUMBER

        public static final int TRANSFORMATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

        public static final int OPTIMIZATION_OBJECTIVE_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

      • DISABLE_EARLY_STOPPING_FIELD_NUMBER

        public static final int DISABLE_EARLY_STOPPING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEIGHT_COLUMN_NAME_FIELD_NUMBER

        public static final int WEIGHT_COLUMN_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPORT_EVALUATED_DATA_ITEMS_CONFIG_FIELD_NUMBER

        public static final int EXPORT_EVALUATED_DATA_ITEMS_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDITIONAL_EXPERIMENTS_FIELD_NUMBER

        public static final int ADDITIONAL_EXPERIMENTS_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 = 5;
        Specified by:
        hasOptimizationObjectiveRecallValue in interface AutoMlTablesInputsOrBuilder
        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 = 5;
        Specified by:
        getOptimizationObjectiveRecallValue in interface AutoMlTablesInputsOrBuilder
        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 = 6;
        Specified by:
        hasOptimizationObjectivePrecisionValue in interface AutoMlTablesInputsOrBuilder
        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 = 6;
        Specified by:
        getOptimizationObjectivePrecisionValue in interface AutoMlTablesInputsOrBuilder
        Returns:
        The optimizationObjectivePrecisionValue.

      • getPredictionType

        public String getPredictionType()
         The type of prediction the Model is to produce.
   "classification" - Predict one out of multiple target values is
                      picked for each row.
   "regression" - Predict a value based on its relation to other values.
                  This type is available only to columns that contain
                  semantically numeric values, i.e. integers or floating
                  point number, even if stored as e.g. strings.
        string prediction_type = 1;
        Specified by:
        getPredictionType in interface AutoMlTablesInputsOrBuilder
        Returns:
        The predictionType.

      • getPredictionTypeBytes

        public com.google.protobuf.ByteString getPredictionTypeBytes()
         The type of prediction the Model is to produce.
   "classification" - Predict one out of multiple target values is
                      picked for each row.
   "regression" - Predict a value based on its relation to other values.
                  This type is available only to columns that contain
                  semantically numeric values, i.e. integers or floating
                  point number, even if stored as e.g. strings.
        string prediction_type = 1;
        Specified by:
        getPredictionTypeBytes in interface AutoMlTablesInputsOrBuilder
        Returns:
        The bytes for predictionType.

      • getTargetColumn

        public String getTargetColumn()
         The column name of the target column that the model is to predict.
        string target_column = 2;
        Specified by:
        getTargetColumn in interface AutoMlTablesInputsOrBuilder
        Returns:
        The targetColumn.

      • getTargetColumnBytes

        public com.google.protobuf.ByteString getTargetColumnBytes()
         The column name of the target column that the model is to predict.
        string target_column = 2;
        Specified by:
        getTargetColumnBytes in interface AutoMlTablesInputsOrBuilder
        Returns:
        The bytes for targetColumn.

      • getTransformationsList

        public List<AutoMlTablesInputs.Transformation> getTransformationsList()
         Each transformation will apply transform function to given input column.
 And the result will be used for training.
 When creating transformation for BigQuery Struct column, the column should
 be flattened using "." as the delimiter.
        repeated .google.cloud.aiplatform.v1.schema.trainingjob.definition.AutoMlTablesInputs.Transformation transformations = 3;
        Specified by:
        getTransformationsList in interface AutoMlTablesInputsOrBuilder

      • getTransformationsOrBuilderList

        public List<? extends AutoMlTablesInputs.TransformationOrBuilder> getTransformationsOrBuilderList()
         Each transformation will apply transform function to given input column.
 And the result will be used for training.
 When creating transformation for BigQuery Struct column, the column should
 be flattened using "." as the delimiter.
        repeated .google.cloud.aiplatform.v1.schema.trainingjob.definition.AutoMlTablesInputs.Transformation transformations = 3;
        Specified by:
        getTransformationsOrBuilderList in interface AutoMlTablesInputsOrBuilder

      • getTransformationsCount

        public int getTransformationsCount()
         Each transformation will apply transform function to given input column.
 And the result will be used for training.
 When creating transformation for BigQuery Struct column, the column should
 be flattened using "." as the delimiter.
        repeated .google.cloud.aiplatform.v1.schema.trainingjob.definition.AutoMlTablesInputs.Transformation transformations = 3;
        Specified by:
        getTransformationsCount in interface AutoMlTablesInputsOrBuilder

      • getTransformations

        public AutoMlTablesInputs.Transformation getTransformations​(int index)
         Each transformation will apply transform function to given input column.
 And the result will be used for training.
 When creating transformation for BigQuery Struct column, the column should
 be flattened using "." as the delimiter.
        repeated .google.cloud.aiplatform.v1.schema.trainingjob.definition.AutoMlTablesInputs.Transformation transformations = 3;
        Specified by:
        getTransformations in interface AutoMlTablesInputsOrBuilder

      • getTransformationsOrBuilder

        public AutoMlTablesInputs.TransformationOrBuilder getTransformationsOrBuilder​(int index)
         Each transformation will apply transform function to given input column.
 And the result will be used for training.
 When creating transformation for BigQuery Struct column, the column should
 be flattened using "." as the delimiter.
        repeated .google.cloud.aiplatform.v1.schema.trainingjob.definition.AutoMlTablesInputs.Transformation transformations = 3;
        Specified by:
        getTransformationsOrBuilder in interface AutoMlTablesInputsOrBuilder

      • 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 AutoMlTablesInputsOrBuilder
        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 AutoMlTablesInputsOrBuilder
        Returns:
        The bytes for optimizationObjective.

      • 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 = 7;
        Specified by:
        getTrainBudgetMilliNodeHours in interface AutoMlTablesInputsOrBuilder
        Returns:
        The trainBudgetMilliNodeHours.

      • 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 = 8;
        Specified by:
        getDisableEarlyStopping in interface AutoMlTablesInputsOrBuilder
        Returns:
        The disableEarlyStopping.

      • getWeightColumnName

        public String getWeightColumnName()
         Column name that should be used as the weight column.
 Higher values in this column give more importance to the row
 during model training. The column must have numeric values between 0 and
 10000 inclusively; 0 means the row is ignored for training. If weight
 column field is not set, then all rows are assumed to have equal weight
 of 1.
        string weight_column_name = 9;
        Specified by:
        getWeightColumnName in interface AutoMlTablesInputsOrBuilder
        Returns:
        The weightColumnName.

      • getWeightColumnNameBytes

        public com.google.protobuf.ByteString getWeightColumnNameBytes()
         Column name that should be used as the weight column.
 Higher values in this column give more importance to the row
 during model training. The column must have numeric values between 0 and
 10000 inclusively; 0 means the row is ignored for training. If weight
 column field is not set, then all rows are assumed to have equal weight
 of 1.
        string weight_column_name = 9;
        Specified by:
        getWeightColumnNameBytes in interface AutoMlTablesInputsOrBuilder
        Returns:
        The bytes for weightColumnName.

      • hasExportEvaluatedDataItemsConfig

        public boolean hasExportEvaluatedDataItemsConfig()
         Configuration for exporting test set predictions to a BigQuery table. If
 this configuration is absent, then the export is not performed.
        .google.cloud.aiplatform.v1.schema.trainingjob.definition.ExportEvaluatedDataItemsConfig export_evaluated_data_items_config = 10;
        Specified by:
        hasExportEvaluatedDataItemsConfig in interface AutoMlTablesInputsOrBuilder
        Returns:
        Whether the exportEvaluatedDataItemsConfig field is set.

      • getExportEvaluatedDataItemsConfig

        public ExportEvaluatedDataItemsConfig getExportEvaluatedDataItemsConfig()
         Configuration for exporting test set predictions to a BigQuery table. If
 this configuration is absent, then the export is not performed.
        .google.cloud.aiplatform.v1.schema.trainingjob.definition.ExportEvaluatedDataItemsConfig export_evaluated_data_items_config = 10;
        Specified by:
        getExportEvaluatedDataItemsConfig in interface AutoMlTablesInputsOrBuilder
        Returns:
        The exportEvaluatedDataItemsConfig.

      • getAdditionalExperimentsList

        public com.google.protobuf.ProtocolStringList getAdditionalExperimentsList()
         Additional experiment flags for the Tables training pipeline.
        repeated string additional_experiments = 11;
        Specified by:
        getAdditionalExperimentsList in interface AutoMlTablesInputsOrBuilder
        Returns:
        A list containing the additionalExperiments.

      • getAdditionalExperimentsCount

        public int getAdditionalExperimentsCount()
         Additional experiment flags for the Tables training pipeline.
        repeated string additional_experiments = 11;
        Specified by:
        getAdditionalExperimentsCount in interface AutoMlTablesInputsOrBuilder
        Returns:
        The count of additionalExperiments.

      • getAdditionalExperiments

        public String getAdditionalExperiments​(int index)
         Additional experiment flags for the Tables training pipeline.
        repeated string additional_experiments = 11;
        Specified by:
        getAdditionalExperiments in interface AutoMlTablesInputsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The additionalExperiments at the given index.

      • getAdditionalExperimentsBytes

        public com.google.protobuf.ByteString getAdditionalExperimentsBytes​(int index)
         Additional experiment flags for the Tables training pipeline.
        repeated string additional_experiments = 11;
        Specified by:
        getAdditionalExperimentsBytes in interface AutoMlTablesInputsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the additionalExperiments at the given index.

      • 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 AutoMlTablesInputs parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<AutoMlTablesInputs> 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 AutoMlTablesInputs getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder