Recall

class paddle.metric. Recall [源代码]

召回率Recall(也称为敏感度)是指得到的相关实例数占相关实例总数的比例。https://en.wikipedia.org/wiki/Precision_and_recall 该类管理二分类任务的召回率。

注意:这个metric只能用来评估二分类。

参数

  • name (str,可选) – metric实例的名字,默认是'recall'。

代码示例:

独立使用示例:

import numpy as np
import paddle

x = np.array([0.1, 0.5, 0.6, 0.7])
y = np.array([1, 0, 1, 1])

m = paddle.metric.Recall()
m.update(x, y)
res = m.accumulate()
print(res) # 2.0 / 3.0

在Model API中的示例:

import numpy as np

import paddle
import paddle.nn as nn

class Data(paddle.io.Dataset):
    def __init__(self):
        super(Data, self).__init__()
        self.n = 1024
        self.x = np.random.randn(self.n, 10).astype('float32')
        self.y = np.random.randint(2, size=(self.n, 1)).astype('float32')

    def __getitem__(self, idx):
        return self.x[idx], self.y[idx]

    def __len__(self):
        return self.n

model = paddle.Model(nn.Sequential(
    nn.Linear(10, 1),
    nn.Sigmoid()
))
optim = paddle.optimizer.Adam(
    learning_rate=0.001, parameters=model.parameters())
model.prepare(
    optim,
    loss=nn.BCELoss(),
    metrics=[paddle.metric.Precision(), paddle.metric.Recall()])

data = Data()
model.fit(data, batch_size=16)
update ( preds, labels, *args )

更新Recall的状态。

参数:

  • preds (numpy.array | Tensor): 预测输出结果通常是sigmoid函数的输出,是一个数据类型为float64或float32的向量。

  • labels (numpy.array | Tensor): 真实标签的shape和:code: preds 相同,数据类型为int32或int64。

返回: 无。

reset ( )

清空状态和计算结果。

返回:无

accumulate ( )

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

返回:precision值,一个标量。

name ( )

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

返回: 评估的名字,string类型。