.. _cn_api_paddle_metric_Recall:

Recall
-------------------------------

.. py:class:: paddle.metric.Recall()


召回率 Recall（也称为敏感度）是指得到的相关实例数占相关实例总数的比例。该类管理二分类任务的召回率。

相关链接：https://en.wikipedia.org/wiki/Precision_and_recall

.. note::
    这个 metric 只能用来评估二分类。


参数
::::::::::::

    - **name** (str，可选) – metric 实例的名字，默认是'recall'。


代码示例 1
::::::::::::

独立使用示例

COPY-FROM: paddle.metric.Recall:code-standalone-example

代码示例 2
::::::::::::
在 Model API 中的示例

COPY-FROM: paddle.metric.Recall:code-model-api-example

方法
::::::::::::
update(preds, labels, *args)
'''''''''

更新 Recall 的状态。

**参数**

    - **preds** (numpy.array | Tensor)：预测输出结果通常是 sigmoid 函数的输出，是一个数据类型为 float64 或 float32 的向量。
    - **labels** (numpy.array | Tensor)：真实标签的 shape 和：code: `preds` 相同，数据类型为 int32 或 int64。

**返回**

 无。


reset()
'''''''''

清空状态和计算结果。

**返回**

 无。


accumulate()
'''''''''

累积的统计指标，计算和返回 recall 值。

**返回**

recall 值，一个标量。


name()
'''''''''

返回 Metric 实例的名字，参考上述的 name，默认是'recall'。

**返回**

 评估的名字，string 类型。
