Class TrainingRun

Information about a single training query run for the model.

Attributes
NameDescription
google.cloud.bigquery_v2.types.Model.TrainingRun.TrainingOptionstraining_options
Options that were used for this training run, includes user specified and default options that were used.
google.protobuf.timestamp_pb2.Timestampstart_time
The start time of this training run.
Sequence[google.cloud.bigquery_v2.types.Model.TrainingRun.IterationResult]results
Output of each iteration run, results.size() <=>
google.cloud.bigquery_v2.types.Model.EvaluationMetricsevaluation_metrics
The evaluation metrics over training/eval data that were computed at the end of training.
google.cloud.bigquery_v2.types.Model.DataSplitResultdata_split_result
Data split result of the training run. Only set when the input data is actually split.
Sequence[google.cloud.bigquery_v2.types.Model.GlobalExplanation]global_explanations
Global explanations for important features of the model. For multi-class models, there is one entry for each label class. For other models, there is only one entry in the list.

Inheritance

builtins.object > proto.message.Message > TrainingRun

Classes

IterationResult

IterationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information about a single iteration of the training run.

TrainingOptions

TrainingOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Options used in model training.

Methods

__bool__

__bool__()

Return True if any field is truthy, False otherwise.

__contains__

__contains__(key)

Return True if this field was set to something non-zero on the wire.

In most cases, this method will return True when __getattr__ would return a truthy value and False when it would return a falsy value, so explicitly calling this is not useful.

The exception case is empty messages explicitly set on the wire, which are falsy from __getattr__. This method allows to distinguish between an explicitly provided empty message and the absence of that message, which is useful in some edge cases.

The most common edge case is the use of google.protobuf.BoolValue to get a boolean that distinguishes between False and None (or the same for a string, int, etc.). This library transparently handles that case for you, but this method remains available to accommodate cases not automatically covered.

Parameter
NameDescription
key str

The name of the field.

Returns
TypeDescription
boolWhether the field's value corresponds to a non-empty wire serialization.

__delattr__

__delattr__(key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

__eq__

__eq__(other)

Return True if the messages are equal, False otherwise.

__getattr__

__getattr__(key)

Retrieve the given field's value.

In protocol buffers, the presence of a field on a message is sufficient for it to always be "present".

For primitives, a value of the correct type will always be returned (the "falsy" values in protocol buffers consistently match those in Python). For repeated fields, the falsy value is always an empty sequence.

For messages, protocol buffers does distinguish between an empty message and absence, but this distinction is subtle and rarely relevant. Therefore, this method always returns an empty message (following the official implementation). To check for message presence, use key in self (in other words, __contains__).

.. note::

Some well-known protocol buffer types
(e.g. ``google.protobuf.Timestamp``) will be converted to
their Python equivalents. See the ``marshal`` module for
more details.

__ne__

__ne__(other)

Return True if the messages are unequal, False otherwise.

__setattr__

__setattr__(key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.