From 3c6b3fb8c4d9e5802997965add861705fa0dc08b Mon Sep 17 00:00:00 2001 From: LocoRichard Date: Thu, 21 Apr 2022 17:18:15 +0800 Subject: [PATCH] [DOC] Refine Readme Signed-off-by: LocoRichard --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1edafbb..8a698d8 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ This operator uses [PyTorch.yolov5](https://pytorch.org/hub/ultralytics_yolov5/) -Writing the pipeline in the simplified way +- Write the pipeline in the simplified way: ```Python import towhee @@ -37,7 +37,7 @@ towhee.glob('./test.png') \ results1 -Writing the same pipeline with explicitly specified inputs and outputs +- Write the same pipeline with explicitly specified inputs and outputs: ```Python import towhee @@ -60,7 +60,7 @@ towhee.glob['path']('./test.png') \ ## Factory Constructor -Create the operator via the following factory method +Create the operator via the following factory method: ***object_detection.yolov5()*** @@ -72,7 +72,7 @@ Create the operator via the following factory method ### Interface -The operator takes an image as input. It first detects the objects appeared in the image, and gives the bounding box of each object. +The operator takes an image as input. It first detects the objects appeared in the image, and generates a bounding box around each object. **Parameters:** @@ -84,5 +84,5 @@ The operator takes an image as input. It first detects the objects appeared in t **Return**: List[List[(int, int, int, int)], ...], List[str], List[float] -The return value is a tuple of (boxes, classes, scores). The *boxes* is a list of bounding boxes. Each bounding box is represented by the top-left and the bottom right points, i.e. (x1, y1, x2, y2). The *classes* is a list of prediction labels. The *scores* is a list of the confidence scores. +The return value is a tuple of (boxes, classes, scores). The *boxes* is a list of bounding boxes. Each bounding box is represented by the top-left and the bottom right points, i.e. (x1, y1, x2, y2). The *classes* is a list of prediction labels. The *scores* is a list of confidence scores.