Class Model (1.28.1)

Protocol buffer.

Required. Unique identifier for this model.

Output only. The time when this model was last modified, in millisecs since the epoch.

Optional. A descriptive name for this model.

Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.

Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage.

Output only. Information for all training runs in increasing order of start_time.

Output only. Label columns that were used to train this model. The output of the model will have a predicted\_ prefix to these columns.

Inheritance

builtins.object > google.protobuf.pyext._message.CMessage > builtins.object > google.protobuf.message.Message > Model

Classes

AggregateClassificationMetrics

Aggregate metrics for classification/classifier models. For multi- class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro- averaged, the metric is calculated globally by counting the total number of correctly predicted rows.

Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro- averaged metric.

Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.

Logarithmic Loss. For multiclass this is a macro-averaged metric.

BinaryClassificationMetrics

Evaluation metrics for binary classification/classifier models.

Binary confusion matrix at multiple thresholds.

Label representing the negative class.

ClusteringMetrics

Evaluation metrics for clustering models.

Mean of squared distances between each sample to its cluster centroid.

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.

Populated for binary classification/classifier models.

Populated for clustering models.

KmeansEnums

API documentation for bigquery_v2.types.Model.KmeansEnums class.

LabelsEntry

API documentation for bigquery_v2.types.Model.LabelsEntry class.

MultiClassClassificationMetrics

Evaluation metrics for multi-class classification/classifier models.

Confusion matrix at different thresholds.

RegressionMetrics

Evaluation metrics for regression and explicit feedback type matrix factorization models.

Mean squared error.

Median absolute error.

TrainingRun

Information about a single training query run for the model.

The start time of this training run.

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

Methods

ByteSize

Returns the size of the message in bytes.

Clear

Clears the message.

ClearExtension

Clears a message field.

ClearField

Clears a message field.

CopyFrom

Copies a protocol message into the current message.

DiscardUnknownFields

Discards the unknown fields.

FindInitializationErrors

Finds unset required fields.

FromString

Creates new method instance from given serialized data.

HasExtension

Checks if a message field is set.

HasField

Checks if a message field is set.

IsInitialized

Checks if all required fields of a protocol message are set.

ListFields

Lists all set fields of a message.

MergeFrom

Merges a protocol message into the current message.

MergeFromString

Merges a serialized message into the current message.

ParseFromString

Parses a serialized message into the current message.

RegisterExtension

Registers an extension with the current message.

SerializePartialToString

Serializes the message to a string, even if it isn't initialized.

SerializeToString

Serializes the message to a string, only for initialized messages.

SetInParent

Sets the has bit of the given field in its parent message.

UnknownFields

Parse unknown field set

WhichOneof

Returns the name of the field set inside a oneof, or None if no field is set.

__getstate__

__getstate__()

Support the pickle protocol.

__setstate__

__setstate__(state)

Support the pickle protocol.