Class EvaluationMetrics

Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
NameDescription
google.cloud.bigquery_v2.types.Model.RegressionMetricsregression_metrics
Populated for regression models and explicit feedback type matrix factorization models. This field is a member of `oneof`_ ``metrics``.
google.cloud.bigquery_v2.types.Model.BinaryClassificationMetricsbinary_classification_metrics
Populated for binary classification/classifier models. This field is a member of `oneof`_ ``metrics``.
google.cloud.bigquery_v2.types.Model.MultiClassClassificationMetricsmulti_class_classification_metrics
Populated for multi-class classification/classifier models. This field is a member of `oneof`_ ``metrics``.
google.cloud.bigquery_v2.types.Model.ClusteringMetricsclustering_metrics
Populated for clustering models. This field is a member of `oneof`_ ``metrics``.
google.cloud.bigquery_v2.types.Model.RankingMetricsranking_metrics
Populated for implicit feedback type matrix factorization models. This field is a member of `oneof`_ ``metrics``.
google.cloud.bigquery_v2.types.Model.ArimaForecastingMetricsarima_forecasting_metrics
Populated for ARIMA models. This field is a member of `oneof`_ ``metrics``.

Inheritance

builtins.object > proto.message.Message > EvaluationMetrics

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.