# tfrs.metrics.Factorized

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/metrics/factorized_top_k.py#L27-L49) |

Computes metrics across top K candidates surfaced by a retrieval model.

    tfrs.metrics.Factorized(
        trainable=True, name=None, dtype=None, dynamic=False, **kwargs
    )

## Methods

### `call`

    call(
        inputs, *args, **kwargs
    )

This is where the layer's logic lives.

The `call()` method may not create state (except in its first
invocation, wrapping the creation of variables or other resources in
[`tf.init_scope()`](https://www.tensorflow.org/api_docs/python/tf/init_scope)). It is recommended to create state, including
[`tf.Variable`](https://www.tensorflow.org/api_docs/python/tf/Variable) instances and nested `Layer` instances,
in `__init__()`, or in the `build()` method that is
called automatically before `call()` executes for the first time.

<br />

<br />

<br />

| Args ||
|---|---|
| `inputs` | Input tensor, or dict/list/tuple of input tensors. The first positional `inputs` argument is subject to special rules: <br /> - `inputs` must be explicitly passed. A layer cannot have zero arguments, and `inputs` cannot be provided via the default value of a keyword argument. - NumPy array or Python scalar values in `inputs` get cast as tensors. - Keras mask metadata is only collected from `inputs`. - Layers are built (`build(input_shape)` method) using shape info from `inputs` only. - `input_spec` compatibility is only checked against `inputs`. - Mixed precision input casting is only applied to `inputs`. If a layer has tensor arguments in `*args` or `**kwargs`, their casting behavior in mixed precision should be handled manually. - The SavedModel input specification is generated using `inputs` only. - Integration with various ecosystem packages like TFMOT, TFLite, TF.js, etc is only supported for `inputs` and not for tensors in positional and keyword arguments. |
| `*args` | Additional positional arguments. May contain tensors, although this is not recommended, for the reasons above. |
| `**kwargs` | Additional keyword arguments. May contain tensors, although this is not recommended, for the reasons above. The following optional keyword arguments are reserved: - `training`: Boolean scalar tensor of Python boolean indicating whether the `call` is meant for training or inference. - `mask`: Boolean input mask. If the layer's `call()` method takes a `mask` argument, its default value will be set to the mask generated for `inputs` by the previous layer (if `input` did come from a layer that generated a corresponding mask, i.e. if it came from a Keras layer with masking support). |

<br />

<br />

<br />

| Returns ||
|---|---|
| A tensor or list/tuple of tensors. ||

<br />

### `reset_states`

[View source](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/metrics/factorized_top_k.py#L40-L44)

    reset_states() -> None

Resets the metrics.

### `result`

[View source](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/metrics/factorized_top_k.py#L46-L49)

    result() -> List[tf.Tensor]

Returns a list of metric results.

### `update_state`

[View source](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/metrics/factorized_top_k.py#L30-L38)

    @abc.abstractmethod
    update_state(
        query_embeddings: tf.Tensor,
        true_candidate_embeddings: tf.Tensor,
        true_candidate_ids: Optional[tf.Tensor] = None
    ) -> tf.Operation