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

#include <training_run.h>

Inheritance diagram for google_bigquery_api::TrainingRun:

Public Member Functions

 TrainingRun (const Json::Value &storage)
 
 TrainingRun (Json::Value *storage)
 
virtual ~TrainingRun ()
 
const StringPiece GetTypeName () const
 
bool has_data_split_result () const
 
void clear_data_split_result ()
 
const DataSplitResult get_data_split_result () const
 
DataSplitResult mutable_dataSplitResult ()
 
bool has_evaluation_metrics () const
 
void clear_evaluation_metrics ()
 
const EvaluationMetrics get_evaluation_metrics () const
 
EvaluationMetrics mutable_evaluationMetrics ()
 
bool has_results () const
 
void clear_results ()
 
const client::JsonCppArray< IterationResult > get_results () const
 
client::JsonCppArray< IterationResult > mutable_results ()
 
bool has_start_time () const
 
void clear_start_time ()
 
const StringPiece get_start_time () const
 
void set_start_time (const StringPiece &value)
 
bool has_training_options () const
 
void clear_training_options ()
 
const TrainingOptions get_training_options () const
 
TrainingOptions mutable_trainingOptions ()
 

Static Public Member Functions

static TrainingRun * New ()
 

Detailed Description

Information about a single training query run for the model.

Constructor & Destructor Documentation

◆ TrainingRun() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ TrainingRun() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~TrainingRun()

google_bigquery_api::TrainingRun::~TrainingRun ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_data_split_result()

void google_bigquery_api::TrainingRun::clear_data_split_result ( )
inline

Clears the 'dataSplitResult' attribute.

◆ clear_evaluation_metrics()

void google_bigquery_api::TrainingRun::clear_evaluation_metrics ( )
inline

Clears the 'evaluationMetrics' attribute.

◆ clear_results()

void google_bigquery_api::TrainingRun::clear_results ( )
inline

Clears the 'results' attribute.

◆ clear_start_time()

void google_bigquery_api::TrainingRun::clear_start_time ( )
inline

Clears the 'startTime' attribute.

◆ clear_training_options()

void google_bigquery_api::TrainingRun::clear_training_options ( )
inline

Clears the 'trainingOptions' attribute.

◆ get_data_split_result()

const DataSplitResult google_bigquery_api::TrainingRun::get_data_split_result ( ) const

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

◆ get_evaluation_metrics()

const EvaluationMetrics google_bigquery_api::TrainingRun::get_evaluation_metrics ( ) const

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

◆ get_results()

const client::JsonCppArray<IterationResult > google_bigquery_api::TrainingRun::get_results ( ) const

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

◆ get_start_time()

const StringPiece google_bigquery_api::TrainingRun::get_start_time ( ) const
inline

Get the value of the 'startTime' attribute.

◆ get_training_options()

const TrainingOptions google_bigquery_api::TrainingRun::get_training_options ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::TrainingRun

◆ has_data_split_result()

bool google_bigquery_api::TrainingRun::has_data_split_result ( ) const
inline

Determine if the 'dataSplitResult' attribute was set.

Returns
true if the 'dataSplitResult' attribute was set.

◆ has_evaluation_metrics()

bool google_bigquery_api::TrainingRun::has_evaluation_metrics ( ) const
inline

Determine if the 'evaluationMetrics' attribute was set.

Returns
true if the 'evaluationMetrics' attribute was set.

◆ has_results()

bool google_bigquery_api::TrainingRun::has_results ( ) const
inline

Determine if the 'results' attribute was set.

Returns
true if the 'results' attribute was set.

◆ has_start_time()

bool google_bigquery_api::TrainingRun::has_start_time ( ) const
inline

Determine if the 'startTime' attribute was set.

Returns
true if the 'startTime' attribute was set.

◆ has_training_options()

bool google_bigquery_api::TrainingRun::has_training_options ( ) const
inline

Determine if the 'trainingOptions' attribute was set.

Returns
true if the 'trainingOptions' attribute was set.

◆ mutable_dataSplitResult()

DataSplitResult google_bigquery_api::TrainingRun::mutable_dataSplitResult ( )

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

Data split result of the training run. Only set when the input data is actually split.

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

◆ mutable_evaluationMetrics()

EvaluationMetrics google_bigquery_api::TrainingRun::mutable_evaluationMetrics ( )

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

The evaluation metrics over training/eval data that were computed at the end of training.

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

◆ mutable_results()

client::JsonCppArray<IterationResult > google_bigquery_api::TrainingRun::mutable_results ( )

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

Output of each iteration run, results.size() <= max_iterations.

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

◆ mutable_trainingOptions()

TrainingOptions google_bigquery_api::TrainingRun::mutable_trainingOptions ( )

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

Options that were used for this training run, includes user specified and default options that were used.

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

◆ New()

TrainingRun * google_bigquery_api::TrainingRun::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_start_time()

void google_bigquery_api::TrainingRun::set_start_time ( const StringPiece &  value)
inline

Change the 'startTime' attribute.

The start time of this training run.

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