# tfr.extension.premade.TFRBertModelBuilder

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/extension/premade/tfrbert_task.py#L133-L139) |

Model builder for TFR-BERT models.

Inherits From: [`ModelBuilder`](https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/ModelBuilder), [`ModelBuilderWithMask`](https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/ModelBuilderWithMask), [`AbstractModelBuilder`](https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/AbstractModelBuilder)

#### View aliases


**Main aliases**

[`tfr.extension.premade.tfrbert_task.TFRBertModelBuilder`](https://www.tensorflow.org/ranking/api_docs/python/tfr/extension/premade/TFRBertModelBuilder)

<br />

    tfr.extension.premade.TFRBertModelBuilder(
        input_creator: Callable[[], Tuple[TensorDict, TensorDict]],
        preprocessor: Callable[[TensorDict, TensorDict, tf.Tensor], Tuple[TensorDict, TensorDict]],
        scorer: Callable[[TensorDict, TensorDict, tf.Tensor], Union[TensorLike, TensorDict]],
        mask_feature_name: str,
        name: Optional[str] = None
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `input_creator` | A callable or a class like `InputCreator` to implement `create_inputs`. |
| `preprocessor` | A callable or a class like `Preprocessor` to implement `preprocess`. |
| `scorer` | A callable or a class like `Scorer` to implement `score`. |
| `mask_feature_name` | name of 2D mask boolean feature. |
| `name` | (optional) name of the Model. |

<br />

## Methods

### `build`

[View source](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/extension/premade/tfrbert_task.py#L136-L139)

    build() -> tf.keras.Model

Builds a Keras Model for Ranking Pipeline.

#### Example usage:

    model_builder = SimpleModelBuilder(
        {},
        {"example_feature_1": tf.io.FixedLenFeature(
            shape=(1,), dtype=tf.float32, default_value=0.0)},
        "list_mask", "model_builder")
    model = model_builder.build()

<br />

<br />

<br />

| Returns ||
|---|---|
| A [`tf.keras.Model`](https://www.tensorflow.org/api_docs/python/tf/keras/Model). ||

<br />

### `create_inputs`

[View source](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/python/keras/model.py#L372-L377)

    create_inputs() -> Tuple[https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict, https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict, tf.Tensor]

See `ModelBuilderWithMask`.

### `preprocess`

[View source](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/python/keras/model.py#L379-L386)

    preprocess(
        context_inputs: https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict,
        example_inputs: https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict,
        mask: tf.Tensor
    ) -> Tuple[https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict, https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict]

See `ModelBuilderWithMask`.

### `score`

[View source](https://github.com/tensorflow/ranking/blob/v0.5.3/tensorflow_ranking/python/keras/model.py#L388-L395)

    score(
        context_features: https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict,
        example_features: https://www.tensorflow.org/ranking/api_docs/python/tfr/keras/model/TensorDict,
        mask: tf.Tensor
    ) -> Union[TensorLike, TensorDict]

See `ModelBuilderWithMask`.