# tfr.keras.metrics.get

<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/python/keras/metrics.py#L69-L128) |

Factory method to get a list of ranking metrics.

    tfr.keras.metrics.get(
        key: str,
        name: Optional[str] = None,
        dtype: Optional[tf.dtypes.DType] = None,
        topn: Optional[int] = None,
        **kwargs
    ) -> tf.keras.metrics.Metric

#### Example Usage:

      metric = tfr.keras.metics.get(tfr.keras.metrics.RankingMetricKey.MRR)

to get Mean Reciprocal Rank.

      metric = tfr.keras.metics.get(tfr.keras.metrics.RankingMetricKey.MRR,
                                    topn=2)

to get MRR@2.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `key` | An attribute of `RankingMetricKey`, defining which metric objects to return. |
| `name` | Name of metrics. |
| `dtype` | Dtype of the metrics. |
| `topn` | Cutoff of how many items are considered in the metric. |
| `**kwargs` | Keyword arguments for the metric object. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A tf.keras.metrics.Metric. See `_RankingMetric` signature for more details. ||

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | If key is unsupported. |

<br />