bigquery  v2
Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::BqmlIterationResult Class Reference
BigQuery API Data Objects

#include <bqml_iteration_result.h>

Inheritance diagram for google_bigquery_api::BqmlIterationResult:

Public Member Functions

 BqmlIterationResult (const Json::Value &storage)
 
 BqmlIterationResult (Json::Value *storage)
 
virtual ~BqmlIterationResult ()
 
const StringPiece GetTypeName () const
 
bool has_duration_ms () const
 
void clear_duration_ms ()
 
int64 get_duration_ms () const
 
void set_duration_ms (int64 value)
 
bool has_eval_loss () const
 
void clear_eval_loss ()
 
double get_eval_loss () const
 
void set_eval_loss (double value)
 
bool has_index () const
 
void clear_index ()
 
int32 get_index () const
 
void set_index (int32 value)
 
bool has_learn_rate () const
 
void clear_learn_rate ()
 
double get_learn_rate () const
 
void set_learn_rate (double value)
 
bool has_training_loss () const
 
void clear_training_loss ()
 
double get_training_loss () const
 
void set_training_loss (double value)
 

Static Public Member Functions

static BqmlIterationResult * New ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ BqmlIterationResult() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ BqmlIterationResult() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~BqmlIterationResult()

google_bigquery_api::BqmlIterationResult::~BqmlIterationResult ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_duration_ms()

void google_bigquery_api::BqmlIterationResult::clear_duration_ms ( )
inline

Clears the 'durationMs' attribute.

◆ clear_eval_loss()

void google_bigquery_api::BqmlIterationResult::clear_eval_loss ( )
inline

Clears the 'evalLoss' attribute.

◆ clear_index()

void google_bigquery_api::BqmlIterationResult::clear_index ( )
inline

Clears the 'index' attribute.

◆ clear_learn_rate()

void google_bigquery_api::BqmlIterationResult::clear_learn_rate ( )
inline

Clears the 'learnRate' attribute.

◆ clear_training_loss()

void google_bigquery_api::BqmlIterationResult::clear_training_loss ( )
inline

Clears the 'trainingLoss' attribute.

◆ get_duration_ms()

int64 google_bigquery_api::BqmlIterationResult::get_duration_ms ( ) const
inline

Get the value of the 'durationMs' attribute.

◆ get_eval_loss()

double google_bigquery_api::BqmlIterationResult::get_eval_loss ( ) const
inline

Get the value of the 'evalLoss' attribute.

◆ get_index()

int32 google_bigquery_api::BqmlIterationResult::get_index ( ) const
inline

Get the value of the 'index' attribute.

◆ get_learn_rate()

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

Get the value of the 'learnRate' attribute.

◆ get_training_loss()

double google_bigquery_api::BqmlIterationResult::get_training_loss ( ) const
inline

Get the value of the 'trainingLoss' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::BqmlIterationResult

◆ has_duration_ms()

bool google_bigquery_api::BqmlIterationResult::has_duration_ms ( ) const
inline

Determine if the 'durationMs' attribute was set.

Returns
true if the 'durationMs' attribute was set.

◆ has_eval_loss()

bool google_bigquery_api::BqmlIterationResult::has_eval_loss ( ) const
inline

Determine if the 'evalLoss' attribute was set.

Returns
true if the 'evalLoss' attribute was set.

◆ has_index()

bool google_bigquery_api::BqmlIterationResult::has_index ( ) const
inline

Determine if the 'index' attribute was set.

Returns
true if the 'index' attribute was set.

◆ has_learn_rate()

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

Determine if the 'learnRate' attribute was set.

Returns
true if the 'learnRate' attribute was set.

◆ has_training_loss()

bool google_bigquery_api::BqmlIterationResult::has_training_loss ( ) const
inline

Determine if the 'trainingLoss' attribute was set.

Returns
true if the 'trainingLoss' attribute was set.

◆ New()

BqmlIterationResult * google_bigquery_api::BqmlIterationResult::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_duration_ms()

void google_bigquery_api::BqmlIterationResult::set_duration_ms ( int64  value)
inline

Change the 'durationMs' attribute.

[Output-only, Beta] Time taken to run the training iteration in milliseconds.

Parameters
[in]valueThe new value.

◆ set_eval_loss()

void google_bigquery_api::BqmlIterationResult::set_eval_loss ( double  value)
inline

Change the 'evalLoss' attribute.

[Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.

Parameters
[in]valueThe new value.

◆ set_index()

void google_bigquery_api::BqmlIterationResult::set_index ( int32  value)
inline

Change the 'index' attribute.

[Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

Parameters
[in]valueThe new value.

◆ set_learn_rate()

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

Change the 'learnRate' attribute.

[Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

Parameters
[in]valueThe new value.

◆ set_training_loss()

void google_bigquery_api::BqmlIterationResult::set_training_loss ( double  value)
inline

Change the 'trainingLoss' attribute.

[Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: