Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Schema::TrainingJob::Definition::AutoMlTablesInputs (v0.17.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Schema::TrainingJob::Definition::AutoMlTablesInputs.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#additional_experiments

def additional_experiments() -> ::Array<::String>
Returns
  • (::Array<::String>) — Additional experiment flags for the Tables training pipeline.

#additional_experiments=

def additional_experiments=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Additional experiment flags for the Tables training pipeline.
Returns
  • (::Array<::String>) — Additional experiment flags for the Tables training pipeline.

#disable_early_stopping

def disable_early_stopping() -> ::Boolean
Returns
  • (::Boolean) — 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.

#disable_early_stopping=

def disable_early_stopping=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#export_evaluated_data_items_config

def export_evaluated_data_items_config() -> ::Google::Cloud::AIPlatform::V1::Schema::TrainingJob::Definition::ExportEvaluatedDataItemsConfig
Returns

#export_evaluated_data_items_config=

def export_evaluated_data_items_config=(value) -> ::Google::Cloud::AIPlatform::V1::Schema::TrainingJob::Definition::ExportEvaluatedDataItemsConfig
Parameter
Returns

#optimization_objective

def optimization_objective() -> ::String
Returns
  • (::String) — 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).

#optimization_objective=

def optimization_objective=(value) -> ::String
Parameter
  • value (::String) — 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).

Returns
  • (::String) — 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).

#optimization_objective_precision_value

def optimization_objective_precision_value() -> ::Float
Returns
  • (::Float) — Required when optimization_objective is "maximize-recall-at-precision". Must be between 0 and 1, inclusive.

#optimization_objective_precision_value=

def optimization_objective_precision_value=(value) -> ::Float
Parameter
  • value (::Float) — Required when optimization_objective is "maximize-recall-at-precision". Must be between 0 and 1, inclusive.
Returns
  • (::Float) — Required when optimization_objective is "maximize-recall-at-precision". Must be between 0 and 1, inclusive.

#optimization_objective_recall_value

def optimization_objective_recall_value() -> ::Float
Returns
  • (::Float) — Required when optimization_objective is "maximize-precision-at-recall". Must be between 0 and 1, inclusive.

#optimization_objective_recall_value=

def optimization_objective_recall_value=(value) -> ::Float
Parameter
  • value (::Float) — Required when optimization_objective is "maximize-precision-at-recall". Must be between 0 and 1, inclusive.
Returns
  • (::Float) — Required when optimization_objective is "maximize-precision-at-recall". Must be between 0 and 1, inclusive.

#prediction_type

def prediction_type() -> ::String
Returns
  • (::String) — 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.

#prediction_type=

def prediction_type=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#target_column

def target_column() -> ::String
Returns
  • (::String) — The column name of the target column that the model is to predict.

#target_column=

def target_column=(value) -> ::String
Parameter
  • value (::String) — The column name of the target column that the model is to predict.
Returns
  • (::String) — The column name of the target column that the model is to predict.

#train_budget_milli_node_hours

def train_budget_milli_node_hours() -> ::Integer
Returns
  • (::Integer) — 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.

#train_budget_milli_node_hours=

def train_budget_milli_node_hours=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#transformations

def transformations() -> ::Array<::Google::Cloud::AIPlatform::V1::Schema::TrainingJob::Definition::AutoMlTablesInputs::Transformation>
Returns

#transformations=

def transformations=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::Schema::TrainingJob::Definition::AutoMlTablesInputs::Transformation>
Parameter
Returns

#weight_column_name

def weight_column_name() -> ::String
Returns
  • (::String) — 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.

#weight_column_name=

def weight_column_name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.