Class TensorFlowModel (1.9.0)

TensorFlowModel(
    model_path: str, *, session: typing.Optional[bigframes.session.Session] = None
)

Imported TensorFlow model.

Parameters

NameDescription
model_pathstr

Cloud Storage path that holds the model files.

sessionBigQuery Session

BQ session to create the model.

Methods

__repr__

__repr__()

Print the estimator's constructor with all non-default parameter values.

get_params

get_params(deep: bool = True) -> typing.Dict[str, typing.Any]

Get parameters for this estimator.

Parameter
NameDescription
deepbool, default True

Default True. If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns
TypeDescription
DictionaryA dictionary of parameter names mapped to their values.

predict

predict(
    X: typing.Union[bigframes.dataframe.DataFrame, bigframes.series.Series]
) -> bigframes.dataframe.DataFrame

Predict the result from input DataFrame.

Parameter
NameDescription
Xbigframes.dataframe.DataFrame

Input DataFrame. Schema is defined by the model.

Returns
TypeDescription
bigframes.dataframe.DataFrameOutput DataFrame. Schema is defined by the model.

register

register(vertex_ai_model_id: typing.Optional[str] = None) -> bigframes.ml.base._T

Register the model to Vertex AI.

After register, go to the Google Cloud console (https://console.cloud.google.com/vertex-ai/models) to manage the model registries. Refer to https://cloud.google.com/vertex-ai/docs/model-registry/introduction for more options.

Parameter
NameDescription
vertex_ai_model_idOptional[str], default None

Optional string id as model id in Vertex. If not set, will default to 'bigframes_{bq_model_id}'. Vertex Ai model id will be truncated to 63 characters due to its limitation.

to_gbq

to_gbq(
    model_name: str, replace: bool = False
) -> bigframes.ml.imported.TensorFlowModel

Save the model to BigQuery.

Parameters
NameDescription
model_namestr

The name of the model.

replacebool, default False

Default to False.

Returns
TypeDescription
TensorFlowModelSaved model.