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

#include <bqml_training_run.h>

Inheritance diagram for google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions:

Public Member Functions

 BqmlTrainingRunTrainingOptions (const Json::Value &storage)
 
 BqmlTrainingRunTrainingOptions (Json::Value *storage)
 
virtual ~BqmlTrainingRunTrainingOptions ()
 
const StringPiece GetTypeName () const
 
bool has_early_stop () const
 
void clear_early_stop ()
 
bool get_early_stop () const
 
void set_early_stop (bool value)
 
bool has_l1_reg () const
 
void clear_l1_reg ()
 
double get_l1_reg () const
 
void set_l1_reg (double value)
 
bool has_l2_reg () const
 
void clear_l2_reg ()
 
double get_l2_reg () const
 
void set_l2_reg (double value)
 
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_line_search_init_learn_rate () const
 
void clear_line_search_init_learn_rate ()
 
double get_line_search_init_learn_rate () const
 
void set_line_search_init_learn_rate (double value)
 
bool has_max_iteration () const
 
void clear_max_iteration ()
 
int64 get_max_iteration () const
 
void set_max_iteration (int64 value)
 
bool has_min_rel_progress () const
 
void clear_min_rel_progress ()
 
double get_min_rel_progress () const
 
void set_min_rel_progress (double 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 BqmlTrainingRunTrainingOptionsNew ()
 

Detailed Description

[Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.

Constructor & Destructor Documentation

◆ BqmlTrainingRunTrainingOptions() [1/2]

google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::BqmlTrainingRunTrainingOptions ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ BqmlTrainingRunTrainingOptions() [2/2]

google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::BqmlTrainingRunTrainingOptions ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~BqmlTrainingRunTrainingOptions()

google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::~BqmlTrainingRunTrainingOptions ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_early_stop()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_early_stop ( )
inline

Clears the 'earlyStop' attribute.

◆ clear_l1_reg()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_l1_reg ( )
inline

Clears the 'l1Reg' attribute.

◆ clear_l2_reg()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_l2_reg ( )
inline

Clears the 'l2Reg' attribute.

◆ clear_learn_rate()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_learn_rate ( )
inline

Clears the 'learnRate' attribute.

◆ clear_learn_rate_strategy()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_learn_rate_strategy ( )
inline

Clears the 'learnRateStrategy' attribute.

◆ clear_line_search_init_learn_rate()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_line_search_init_learn_rate ( )
inline

Clears the 'lineSearchInitLearnRate' attribute.

◆ clear_max_iteration()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_max_iteration ( )
inline

Clears the 'maxIteration' attribute.

◆ clear_min_rel_progress()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_min_rel_progress ( )
inline

Clears the 'minRelProgress' attribute.

◆ clear_warm_start()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::clear_warm_start ( )
inline

Clears the 'warmStart' attribute.

◆ get_early_stop()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_early_stop ( ) const
inline

Get the value of the 'earlyStop' attribute.

◆ get_l1_reg()

double google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_l1_reg ( ) const
inline

Get the value of the 'l1Reg' attribute.

◆ get_l2_reg()

double google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_l2_reg ( ) const
inline

Get the value of the 'l2Reg' attribute.

◆ get_learn_rate()

double google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_learn_rate ( ) const
inline

Get the value of the 'learnRate' attribute.

◆ get_learn_rate_strategy()

const StringPiece google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_learn_rate_strategy ( ) const
inline

Get the value of the 'learnRateStrategy' attribute.

◆ get_line_search_init_learn_rate()

double google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_line_search_init_learn_rate ( ) const
inline

Get the value of the 'lineSearchInitLearnRate' attribute.

◆ get_max_iteration()

int64 google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_max_iteration ( ) const
inline

Get the value of the 'maxIteration' attribute.

◆ get_min_rel_progress()

double google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_min_rel_progress ( ) const
inline

Get the value of the 'minRelProgress' attribute.

◆ get_warm_start()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::get_warm_start ( ) const
inline

Get the value of the 'warmStart' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::BqmlTrainingRunTrainingOptions

◆ has_early_stop()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_early_stop ( ) const
inline

Determine if the 'earlyStop' attribute was set.

Returns
true if the 'earlyStop' attribute was set.

◆ has_l1_reg()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_l1_reg ( ) const
inline

Determine if the 'l1Reg' attribute was set.

Returns
true if the 'l1Reg' attribute was set.

◆ has_l2_reg()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_l2_reg ( ) const
inline

Determine if the 'l2Reg' attribute was set.

Returns
true if the 'l2Reg' attribute was set.

◆ has_learn_rate()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::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::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_learn_rate_strategy ( ) const
inline

Determine if the 'learnRateStrategy' attribute was set.

Returns
true if the 'learnRateStrategy' attribute was set.

◆ has_line_search_init_learn_rate()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_line_search_init_learn_rate ( ) const
inline

Determine if the 'lineSearchInitLearnRate' attribute was set.

Returns
true if the 'lineSearchInitLearnRate' attribute was set.

◆ has_max_iteration()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_max_iteration ( ) const
inline

Determine if the 'maxIteration' attribute was set.

Returns
true if the 'maxIteration' attribute was set.

◆ has_min_rel_progress()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_min_rel_progress ( ) const
inline

Determine if the 'minRelProgress' attribute was set.

Returns
true if the 'minRelProgress' attribute was set.

◆ has_warm_start()

bool google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::has_warm_start ( ) const
inline

Determine if the 'warmStart' attribute was set.

Returns
true if the 'warmStart' attribute was set.

◆ New()

BqmlTrainingRun::BqmlTrainingRunTrainingOptions * google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_early_stop()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_early_stop ( bool  value)
inline

Change the 'earlyStop' attribute.

Parameters
[in]valueThe new value.

◆ set_l1_reg()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_l1_reg ( double  value)
inline

Change the 'l1Reg' attribute.

Parameters
[in]valueThe new value.

◆ set_l2_reg()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_l2_reg ( double  value)
inline

Change the 'l2Reg' attribute.

Parameters
[in]valueThe new value.

◆ set_learn_rate()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_learn_rate ( double  value)
inline

Change the 'learnRate' attribute.

Parameters
[in]valueThe new value.

◆ set_learn_rate_strategy()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_learn_rate_strategy ( const StringPiece &  value)
inline

Change the 'learnRateStrategy' attribute.

Parameters
[in]valueThe new value.

◆ set_line_search_init_learn_rate()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_line_search_init_learn_rate ( double  value)
inline

Change the 'lineSearchInitLearnRate' attribute.

Parameters
[in]valueThe new value.

◆ set_max_iteration()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_max_iteration ( int64  value)
inline

Change the 'maxIteration' attribute.

Parameters
[in]valueThe new value.

◆ set_min_rel_progress()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_min_rel_progress ( double  value)
inline

Change the 'minRelProgress' attribute.

Parameters
[in]valueThe new value.

◆ set_warm_start()

void google_bigquery_api::BqmlTrainingRun::BqmlTrainingRunTrainingOptions::set_warm_start ( bool  value)
inline

Change the 'warmStart' attribute.

Parameters
[in]valueThe new value.

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