bigquery  v2
Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::TrainingOptions Class Reference

#include <training_options.h>

Inheritance diagram for google_bigquery_api::TrainingOptions:

Public Member Functions

 TrainingOptions (const Json::Value &storage)
 
 TrainingOptions (Json::Value *storage)
 
virtual ~TrainingOptions ()
 
const StringPiece GetTypeName () const
 
bool has_data_split_column () const
 
void clear_data_split_column ()
 
const StringPiece get_data_split_column () const
 
void set_data_split_column (const StringPiece &value)
 
bool has_data_split_eval_fraction () const
 
void clear_data_split_eval_fraction ()
 
double get_data_split_eval_fraction () const
 
void set_data_split_eval_fraction (double value)
 
bool has_data_split_method () const
 
void clear_data_split_method ()
 
const StringPiece get_data_split_method () const
 
void set_data_split_method (const StringPiece &value)
 
bool has_distance_type () const
 
void clear_distance_type ()
 
const StringPiece get_distance_type () const
 
void set_distance_type (const StringPiece &value)
 
bool has_early_stop () const
 
void clear_early_stop ()
 
bool get_early_stop () const
 
void set_early_stop (bool value)
 
bool has_initial_learn_rate () const
 
void clear_initial_learn_rate ()
 
double get_initial_learn_rate () const
 
void set_initial_learn_rate (double value)
 
bool has_input_label_columns () const
 
void clear_input_label_columns ()
 
const client::JsonCppArray< string > get_input_label_columns () const
 
client::JsonCppArray< string > mutable_inputLabelColumns ()
 
bool has_kmeans_initialization_column () const
 
void clear_kmeans_initialization_column ()
 
const StringPiece get_kmeans_initialization_column () const
 
void set_kmeans_initialization_column (const StringPiece &value)
 
bool has_kmeans_initialization_method () const
 
void clear_kmeans_initialization_method ()
 
const StringPiece get_kmeans_initialization_method () const
 
void set_kmeans_initialization_method (const StringPiece &value)
 
bool has_l1_regularization () const
 
void clear_l1_regularization ()
 
double get_l1_regularization () const
 
void set_l1_regularization (double value)
 
bool has_l2_regularization () const
 
void clear_l2_regularization ()
 
double get_l2_regularization () const
 
void set_l2_regularization (double value)
 
bool has_label_class_weights () const
 
void clear_label_class_weights ()
 
const client::JsonCppAssociativeArray< double > get_label_class_weights () const
 
client::JsonCppAssociativeArray< double > mutable_labelClassWeights ()
 
bool has_learn_rate () const
 
void clear_learn_rate ()
 
double get_learn_rate () const
 
void set_learn_rate (double value)
 
bool has_learn_rate_strategy () const
 
void clear_learn_rate_strategy ()
 
const StringPiece get_learn_rate_strategy () const
 
void set_learn_rate_strategy (const StringPiece &value)
 
bool has_loss_type () const
 
void clear_loss_type ()
 
const StringPiece get_loss_type () const
 
void set_loss_type (const StringPiece &value)
 
bool has_max_iterations () const
 
void clear_max_iterations ()
 
int64 get_max_iterations () const
 
void set_max_iterations (int64 value)
 
bool has_min_relative_progress () const
 
void clear_min_relative_progress ()
 
double get_min_relative_progress () const
 
void set_min_relative_progress (double value)
 
bool has_model_uri () const
 
void clear_model_uri ()
 
const StringPiece get_model_uri () const
 
void set_model_uri (const StringPiece &value)
 
bool has_num_clusters () const
 
void clear_num_clusters ()
 
int64 get_num_clusters () const
 
void set_num_clusters (int64 value)
 
bool has_optimization_strategy () const
 
void clear_optimization_strategy ()
 
const StringPiece get_optimization_strategy () const
 
void set_optimization_strategy (const StringPiece &value)
 
bool has_warm_start () const
 
void clear_warm_start ()
 
bool get_warm_start () const
 
void set_warm_start (bool value)
 

Static Public Member Functions

static TrainingOptionsNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ TrainingOptions() [1/2]

google_bigquery_api::TrainingOptions::TrainingOptions ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ TrainingOptions() [2/2]

google_bigquery_api::TrainingOptions::TrainingOptions ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~TrainingOptions()

google_bigquery_api::TrainingOptions::~TrainingOptions ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_data_split_column()

void google_bigquery_api::TrainingOptions::clear_data_split_column ( )
inline

Clears the 'dataSplitColumn' attribute.

◆ clear_data_split_eval_fraction()

void google_bigquery_api::TrainingOptions::clear_data_split_eval_fraction ( )
inline

Clears the 'dataSplitEvalFraction' attribute.

◆ clear_data_split_method()

void google_bigquery_api::TrainingOptions::clear_data_split_method ( )
inline

Clears the 'dataSplitMethod' attribute.

◆ clear_distance_type()

void google_bigquery_api::TrainingOptions::clear_distance_type ( )
inline

Clears the 'distanceType' attribute.

◆ clear_early_stop()

void google_bigquery_api::TrainingOptions::clear_early_stop ( )
inline

Clears the 'earlyStop' attribute.

◆ clear_initial_learn_rate()

void google_bigquery_api::TrainingOptions::clear_initial_learn_rate ( )
inline

Clears the 'initialLearnRate' attribute.

◆ clear_input_label_columns()

void google_bigquery_api::TrainingOptions::clear_input_label_columns ( )
inline

Clears the 'inputLabelColumns' attribute.

◆ clear_kmeans_initialization_column()

void google_bigquery_api::TrainingOptions::clear_kmeans_initialization_column ( )
inline

Clears the 'kmeansInitializationColumn' attribute.

◆ clear_kmeans_initialization_method()

void google_bigquery_api::TrainingOptions::clear_kmeans_initialization_method ( )
inline

Clears the 'kmeansInitializationMethod' attribute.

◆ clear_l1_regularization()

void google_bigquery_api::TrainingOptions::clear_l1_regularization ( )
inline

Clears the 'l1Regularization' attribute.

◆ clear_l2_regularization()

void google_bigquery_api::TrainingOptions::clear_l2_regularization ( )
inline

Clears the 'l2Regularization' attribute.

◆ clear_label_class_weights()

void google_bigquery_api::TrainingOptions::clear_label_class_weights ( )
inline

Clears the 'labelClassWeights' attribute.

◆ clear_learn_rate()

void google_bigquery_api::TrainingOptions::clear_learn_rate ( )
inline

Clears the 'learnRate' attribute.

◆ clear_learn_rate_strategy()

void google_bigquery_api::TrainingOptions::clear_learn_rate_strategy ( )
inline

Clears the 'learnRateStrategy' attribute.

◆ clear_loss_type()

void google_bigquery_api::TrainingOptions::clear_loss_type ( )
inline

Clears the 'lossType' attribute.

◆ clear_max_iterations()

void google_bigquery_api::TrainingOptions::clear_max_iterations ( )
inline

Clears the 'maxIterations' attribute.

◆ clear_min_relative_progress()

void google_bigquery_api::TrainingOptions::clear_min_relative_progress ( )
inline

Clears the 'minRelativeProgress' attribute.

◆ clear_model_uri()

void google_bigquery_api::TrainingOptions::clear_model_uri ( )
inline

Clears the 'modelUri' attribute.

◆ clear_num_clusters()

void google_bigquery_api::TrainingOptions::clear_num_clusters ( )
inline

Clears the 'numClusters' attribute.

◆ clear_optimization_strategy()

void google_bigquery_api::TrainingOptions::clear_optimization_strategy ( )
inline

Clears the 'optimizationStrategy' attribute.

◆ clear_warm_start()

void google_bigquery_api::TrainingOptions::clear_warm_start ( )
inline

Clears the 'warmStart' attribute.

◆ get_data_split_column()

const StringPiece google_bigquery_api::TrainingOptions::get_data_split_column ( ) const
inline

Get the value of the 'dataSplitColumn' attribute.

◆ get_data_split_eval_fraction()

double google_bigquery_api::TrainingOptions::get_data_split_eval_fraction ( ) const
inline

Get the value of the 'dataSplitEvalFraction' attribute.

◆ get_data_split_method()

const StringPiece google_bigquery_api::TrainingOptions::get_data_split_method ( ) const
inline

Get the value of the 'dataSplitMethod' attribute.

◆ get_distance_type()

const StringPiece google_bigquery_api::TrainingOptions::get_distance_type ( ) const
inline

Get the value of the 'distanceType' attribute.

◆ get_early_stop()

bool google_bigquery_api::TrainingOptions::get_early_stop ( ) const
inline

Get the value of the 'earlyStop' attribute.

◆ get_initial_learn_rate()

double google_bigquery_api::TrainingOptions::get_initial_learn_rate ( ) const
inline

Get the value of the 'initialLearnRate' attribute.

◆ get_input_label_columns()

const client::JsonCppArray<string > google_bigquery_api::TrainingOptions::get_input_label_columns ( ) const
inline

Get a reference to the value of the 'inputLabelColumns' attribute.

◆ get_kmeans_initialization_column()

const StringPiece google_bigquery_api::TrainingOptions::get_kmeans_initialization_column ( ) const
inline

Get the value of the 'kmeansInitializationColumn' attribute.

◆ get_kmeans_initialization_method()

const StringPiece google_bigquery_api::TrainingOptions::get_kmeans_initialization_method ( ) const
inline

Get the value of the 'kmeansInitializationMethod' attribute.

◆ get_l1_regularization()

double google_bigquery_api::TrainingOptions::get_l1_regularization ( ) const
inline

Get the value of the 'l1Regularization' attribute.

◆ get_l2_regularization()

double google_bigquery_api::TrainingOptions::get_l2_regularization ( ) const
inline

Get the value of the 'l2Regularization' attribute.

◆ get_label_class_weights()

const client::JsonCppAssociativeArray<double > google_bigquery_api::TrainingOptions::get_label_class_weights ( ) const
inline

Get a reference to the value of the 'labelClassWeights' attribute.

◆ get_learn_rate()

double google_bigquery_api::TrainingOptions::get_learn_rate ( ) const
inline

Get the value of the 'learnRate' attribute.

◆ get_learn_rate_strategy()

const StringPiece google_bigquery_api::TrainingOptions::get_learn_rate_strategy ( ) const
inline

Get the value of the 'learnRateStrategy' attribute.

◆ get_loss_type()

const StringPiece google_bigquery_api::TrainingOptions::get_loss_type ( ) const
inline

Get the value of the 'lossType' attribute.

◆ get_max_iterations()

int64 google_bigquery_api::TrainingOptions::get_max_iterations ( ) const
inline

Get the value of the 'maxIterations' attribute.

◆ get_min_relative_progress()

double google_bigquery_api::TrainingOptions::get_min_relative_progress ( ) const
inline

Get the value of the 'minRelativeProgress' attribute.

◆ get_model_uri()

const StringPiece google_bigquery_api::TrainingOptions::get_model_uri ( ) const
inline

Get the value of the 'modelUri' attribute.

◆ get_num_clusters()

int64 google_bigquery_api::TrainingOptions::get_num_clusters ( ) const
inline

Get the value of the 'numClusters' attribute.

◆ get_optimization_strategy()

const StringPiece google_bigquery_api::TrainingOptions::get_optimization_strategy ( ) const
inline

Get the value of the 'optimizationStrategy' attribute.

◆ get_warm_start()

bool google_bigquery_api::TrainingOptions::get_warm_start ( ) const
inline

Get the value of the 'warmStart' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::TrainingOptions::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::TrainingOptions

◆ has_data_split_column()

bool google_bigquery_api::TrainingOptions::has_data_split_column ( ) const
inline

Determine if the 'dataSplitColumn' attribute was set.

Returns
true if the 'dataSplitColumn' attribute was set.

◆ has_data_split_eval_fraction()

bool google_bigquery_api::TrainingOptions::has_data_split_eval_fraction ( ) const
inline

Determine if the 'dataSplitEvalFraction' attribute was set.

Returns
true if the 'dataSplitEvalFraction' attribute was set.

◆ has_data_split_method()

bool google_bigquery_api::TrainingOptions::has_data_split_method ( ) const
inline

Determine if the 'dataSplitMethod' attribute was set.

Returns
true if the 'dataSplitMethod' attribute was set.

◆ has_distance_type()

bool google_bigquery_api::TrainingOptions::has_distance_type ( ) const
inline

Determine if the 'distanceType' attribute was set.

Returns
true if the 'distanceType' attribute was set.

◆ has_early_stop()

bool google_bigquery_api::TrainingOptions::has_early_stop ( ) const
inline

Determine if the 'earlyStop' attribute was set.

Returns
true if the 'earlyStop' attribute was set.

◆ has_initial_learn_rate()

bool google_bigquery_api::TrainingOptions::has_initial_learn_rate ( ) const
inline

Determine if the 'initialLearnRate' attribute was set.

Returns
true if the 'initialLearnRate' attribute was set.

◆ has_input_label_columns()

bool google_bigquery_api::TrainingOptions::has_input_label_columns ( ) const
inline

Determine if the 'inputLabelColumns' attribute was set.

Returns
true if the 'inputLabelColumns' attribute was set.

◆ has_kmeans_initialization_column()

bool google_bigquery_api::TrainingOptions::has_kmeans_initialization_column ( ) const
inline

Determine if the 'kmeansInitializationColumn' attribute was set.

Returns
true if the 'kmeansInitializationColumn' attribute was set.

◆ has_kmeans_initialization_method()

bool google_bigquery_api::TrainingOptions::has_kmeans_initialization_method ( ) const
inline

Determine if the 'kmeansInitializationMethod' attribute was set.

Returns
true if the 'kmeansInitializationMethod' attribute was set.

◆ has_l1_regularization()

bool google_bigquery_api::TrainingOptions::has_l1_regularization ( ) const
inline

Determine if the 'l1Regularization' attribute was set.

Returns
true if the 'l1Regularization' attribute was set.

◆ has_l2_regularization()

bool google_bigquery_api::TrainingOptions::has_l2_regularization ( ) const
inline

Determine if the 'l2Regularization' attribute was set.

Returns
true if the 'l2Regularization' attribute was set.

◆ has_label_class_weights()

bool google_bigquery_api::TrainingOptions::has_label_class_weights ( ) const
inline

Determine if the 'labelClassWeights' attribute was set.

Returns
true if the 'labelClassWeights' attribute was set.

◆ has_learn_rate()

bool google_bigquery_api::TrainingOptions::has_learn_rate ( ) const
inline

Determine if the 'learnRate' attribute was set.

Returns
true if the 'learnRate' attribute was set.

◆ has_learn_rate_strategy()

bool google_bigquery_api::TrainingOptions::has_learn_rate_strategy ( ) const
inline

Determine if the 'learnRateStrategy' attribute was set.

Returns
true if the 'learnRateStrategy' attribute was set.

◆ has_loss_type()

bool google_bigquery_api::TrainingOptions::has_loss_type ( ) const
inline

Determine if the 'lossType' attribute was set.

Returns
true if the 'lossType' attribute was set.

◆ has_max_iterations()

bool google_bigquery_api::TrainingOptions::has_max_iterations ( ) const
inline

Determine if the 'maxIterations' attribute was set.

Returns
true if the 'maxIterations' attribute was set.

◆ has_min_relative_progress()

bool google_bigquery_api::TrainingOptions::has_min_relative_progress ( ) const
inline

Determine if the 'minRelativeProgress' attribute was set.

Returns
true if the 'minRelativeProgress' attribute was set.

◆ has_model_uri()

bool google_bigquery_api::TrainingOptions::has_model_uri ( ) const
inline

Determine if the 'modelUri' attribute was set.

Returns
true if the 'modelUri' attribute was set.

◆ has_num_clusters()

bool google_bigquery_api::TrainingOptions::has_num_clusters ( ) const
inline

Determine if the 'numClusters' attribute was set.

Returns
true if the 'numClusters' attribute was set.

◆ has_optimization_strategy()

bool google_bigquery_api::TrainingOptions::has_optimization_strategy ( ) const
inline

Determine if the 'optimizationStrategy' attribute was set.

Returns
true if the 'optimizationStrategy' attribute was set.

◆ has_warm_start()

bool google_bigquery_api::TrainingOptions::has_warm_start ( ) const
inline

Determine if the 'warmStart' attribute was set.

Returns
true if the 'warmStart' attribute was set.

◆ mutable_inputLabelColumns()

client::JsonCppArray<string > google_bigquery_api::TrainingOptions::mutable_inputLabelColumns ( )
inline

Gets a reference to a mutable value of the 'inputLabelColumns' property.

Name of input label columns in training data.

Returns
The result can be modified to change the attribute value.

◆ mutable_labelClassWeights()

client::JsonCppAssociativeArray<double > google_bigquery_api::TrainingOptions::mutable_labelClassWeights ( )
inline

Gets a reference to a mutable value of the 'labelClassWeights' property.

Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.

Returns
The result can be modified to change the attribute value.

◆ New()

TrainingOptions * google_bigquery_api::TrainingOptions::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_data_split_column()

void google_bigquery_api::TrainingOptions::set_data_split_column ( const StringPiece &  value)
inline

Change the 'dataSplitColumn' attribute.

The column to split data with. This column won't be used as a feature.

  1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data.
  2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types #data-type-properties.
Parameters
[in]valueThe new value.

◆ set_data_split_eval_fraction()

void google_bigquery_api::TrainingOptions::set_data_split_eval_fraction ( double  value)
inline

Change the 'dataSplitEvalFraction' attribute.

The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.

Parameters
[in]valueThe new value.

◆ set_data_split_method()

void google_bigquery_api::TrainingOptions::set_data_split_method ( const StringPiece &  value)
inline

Change the 'dataSplitMethod' attribute.

The data split type for training and evaluation, e.g. RANDOM.

Parameters
[in]valueThe new value.

◆ set_distance_type()

void google_bigquery_api::TrainingOptions::set_distance_type ( const StringPiece &  value)
inline

Change the 'distanceType' attribute.

Distance type for clustering models.

Parameters
[in]valueThe new value.

◆ set_early_stop()

void google_bigquery_api::TrainingOptions::set_early_stop ( bool  value)
inline

Change the 'earlyStop' attribute.

Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.

Parameters
[in]valueThe new value.

◆ set_initial_learn_rate()

void google_bigquery_api::TrainingOptions::set_initial_learn_rate ( double  value)
inline

Change the 'initialLearnRate' attribute.

Specifies the initial learning rate for the line search learn rate strategy.

Parameters
[in]valueThe new value.

◆ set_kmeans_initialization_column()

void google_bigquery_api::TrainingOptions::set_kmeans_initialization_column ( const StringPiece &  value)
inline

Change the 'kmeansInitializationColumn' attribute.

The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.

Parameters
[in]valueThe new value.

◆ set_kmeans_initialization_method()

void google_bigquery_api::TrainingOptions::set_kmeans_initialization_method ( const StringPiece &  value)
inline

Change the 'kmeansInitializationMethod' attribute.

The method used to initialize the centroids for kmeans algorithm.

Parameters
[in]valueThe new value.

◆ set_l1_regularization()

void google_bigquery_api::TrainingOptions::set_l1_regularization ( double  value)
inline

Change the 'l1Regularization' attribute.

L1 regularization coefficient.

Parameters
[in]valueThe new value.

◆ set_l2_regularization()

void google_bigquery_api::TrainingOptions::set_l2_regularization ( double  value)
inline

Change the 'l2Regularization' attribute.

L2 regularization coefficient.

Parameters
[in]valueThe new value.

◆ set_learn_rate()

void google_bigquery_api::TrainingOptions::set_learn_rate ( double  value)
inline

Change the 'learnRate' attribute.

Learning rate in training. Used only for iterative training algorithms.

Parameters
[in]valueThe new value.

◆ set_learn_rate_strategy()

void google_bigquery_api::TrainingOptions::set_learn_rate_strategy ( const StringPiece &  value)
inline

Change the 'learnRateStrategy' attribute.

The strategy to determine learn rate for the current iteration.

Parameters
[in]valueThe new value.

◆ set_loss_type()

void google_bigquery_api::TrainingOptions::set_loss_type ( const StringPiece &  value)
inline

Change the 'lossType' attribute.

Type of loss function used during training run.

Parameters
[in]valueThe new value.

◆ set_max_iterations()

void google_bigquery_api::TrainingOptions::set_max_iterations ( int64  value)
inline

Change the 'maxIterations' attribute.

The maximum number of iterations in training. Used only for iterative training algorithms.

Parameters
[in]valueThe new value.

◆ set_min_relative_progress()

void google_bigquery_api::TrainingOptions::set_min_relative_progress ( double  value)
inline

Change the 'minRelativeProgress' attribute.

When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.

Parameters
[in]valueThe new value.

◆ set_model_uri()

void google_bigquery_api::TrainingOptions::set_model_uri ( const StringPiece &  value)
inline

Change the 'modelUri' attribute.

[Beta] Google Cloud Storage URI from which the model was imported. Only applicable for imported models.

Parameters
[in]valueThe new value.

◆ set_num_clusters()

void google_bigquery_api::TrainingOptions::set_num_clusters ( int64  value)
inline

Change the 'numClusters' attribute.

Number of clusters for clustering models.

Parameters
[in]valueThe new value.

◆ set_optimization_strategy()

void google_bigquery_api::TrainingOptions::set_optimization_strategy ( const StringPiece &  value)
inline

Change the 'optimizationStrategy' attribute.

Optimization strategy for training linear regression models.

Parameters
[in]valueThe new value.

◆ set_warm_start()

void google_bigquery_api::TrainingOptions::set_warm_start ( bool  value)
inline

Change the 'warmStart' attribute.

Whether to train a model from the last checkpoint.

Parameters
[in]valueThe new value.

The documentation for this class was generated from the following files: