From 8ed40626904b109bfac3e8273bbcf32bfafa5213 Mon Sep 17 00:00:00 2001 From: YixinKristy <48054808+YixinKristy@users.noreply.github.com> Date: Wed, 26 Aug 2020 10:33:40 +0800 Subject: [PATCH] update pr-curve (#770) * Update README-en.md * Update README.md * Update README.md * Update README.md * Update UserGuide-en.md * Update README-en.md * Update UserGuide-en.md * Update UserGuide-en.md * Update README-en.md * Update README.md * Update UserGuide-en.md --- docs/components/README.md | 2 ++ docs/components/UserGuide-en.md | 12 +++++++----- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/components/README.md b/docs/components/README.md index 3cfa6f49..aea6ff5a 100644 --- a/docs/components/README.md +++ b/docs/components/README.md @@ -558,6 +558,8 @@ add_pr_curve(tag, labels, predictions, step=None, num_thresholds=10) | predictions | numpy.ndarray or list | 以ndarray或list格式表示的预测类别 | | step | int | 记录的步数 | | num_thresholds | int | 阈值设置的个数，默认为10，最大值为127 | +| weights | float | 用于设置TP/FP/TN/FN在计算precision和recall时的权重 | +| walltime | int | 记录数据的时间戳，默认为当前时间戳 | ### Demo diff --git a/docs/components/UserGuide-en.md b/docs/components/UserGuide-en.md index 439bf836..9eb17545 100644 --- a/docs/components/UserGuide-en.md +++ b/docs/components/UserGuide-en.md @@ -555,11 +555,13 @@ The interface parameters are described as follows: | 参数 | 格式 | 含义 | | -------------- | --------------------- | ------------------------------------------- | -| tag | string | 记录指标的标志，如`train/loss`，不能含有`%` | -| values | numpy.ndarray or list | 以ndarray或list格式表示的实际类别 | -| predictions | numpy.ndarray or list | 以ndarray或list格式表示的预测类别 | -| step | int | 记录的步数 | -| num_thresholds | int | 阈值设置的个数，默认为10，最大值为127 | +| tag | string | Record the name of the image data，e.g.train/loss. Notice that the name cannot contain `%` | +| values | numpy.ndarray or list | Data is in ndarray or list format | +| predictions | numpy.ndarray or list | Prediction data is in ndarray or list format | +| step | int | Record the training steps | +| num_thresholds | int | Set the number of thresholds, default as 10, maximum as 127 | +| weights | float | Set the weights of TN/FN/TP/FP to calculate precision and recall | +| walltime | int | Record the time-stamp of the data, and the default is the current time-stamp | ### Demo -- GitLab