Skip to content

Commit

Permalink
Update docs for YOLOv5
Browse files Browse the repository at this point in the history
  • Loading branch information
furiosamg committed May 29, 2024
1 parent 57ea8de commit 9f3c279
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
14 changes: 7 additions & 7 deletions docs/models/yolov5l.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,28 +33,28 @@ The input is a 3-channel image of 640, 640 (height, width).
* Optimal Batch Size (minimum: 1): <= 2

## Outputs
The outputs are 3 `numpy.float32` tensors in various shapes as the following.
The outputs are 3 `numpy.float32` tensors in various shapes as the following.
You can refer to `postprocess()` function to learn how to decode boxes, classes, and confidence scores.

| Tensor | Shape | Data Type | Data Type | Description |
|--------|-------------------|-----------|-----------|-------------|
| 0 | (1, 45, 80, 80) | float32 | NCHW | |
| 1 | (1, 45, 40, 40) | float32 | NCHW | |
| 2 | (1, 45, 20, 20) | float32 | NCHW | |


## Pre/Postprocessing
`furiosa.models.vision.YOLOv5l` class provides `preprocess` and `postprocess` methods.
`preprocess` method converts input images to input tensors, and `postprocess` method converts
model output tensors to a list of bounding boxes, scores and labels.
`preprocess` method converts input images to input tensors, and `postprocess` method converts
model output tensors to a list of bounding boxes, scores and labels.
You can find examples at [YOLOv5l Usage](#YOLOv5l_Usage).

### `furiosa.models.vision.YOLOv5l.preprocess`
::: furiosa.models.vision.yolov5.core.YOLOv5PreProcessor.__call__
options:
show_source: false

### `furiosa.models.vision.YOLOv5l.postprocess`
::: furiosa.models.vision.yolov5.core.YOLOv5PostProcessor.__call__
::: furiosa.models.vision.yolov5.core.YOLOv5PythonPostProcessor.__call__
options:
show_source: false
12 changes: 6 additions & 6 deletions docs/models/yolov5m.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The input is a 3-channel image of 640, 640 (height, width).
* Optimal Batch Size (minimum: 1): <= 4

## Outputs
The outputs are 3 `numpy.float32` tensors in various shapes as the following.
The outputs are 3 `numpy.float32` tensors in various shapes as the following.
You can refer to `postprocess()` function to learn how to decode boxes, classes, and confidence scores.

| Tensor | Shape | Data Type | Data Type | Description |
Expand All @@ -44,17 +44,17 @@ You can refer to `postprocess()` function to learn how to decode boxes, classes,

## Pre/Postprocessing
`furiosa.models.vision.YOLOv5m` class provides `preprocess` and `postprocess` methods.
`preprocess` method converts input images to input tensors, and `postprocess` method converts
model output tensors to a list of bounding boxes, scores and labels.
`preprocess` method converts input images to input tensors, and `postprocess` method converts
model output tensors to a list of bounding boxes, scores and labels.
You can find examples at [YOLOv5m Usage](#YOLOv5m_Usage).

### `furiosa.models.vision.YOLOv5m.preprocess`
::: furiosa.models.vision.yolov5.core.YOLOv5PreProcessor.__call__
options:
show_source: false

### `furiosa.models.vision.YOLOv5m.postprocess`
::: furiosa.models.vision.yolov5.core.YOLOv5PostProcessor.__call__
::: furiosa.models.vision.yolov5.core.YOLOv5PythonPostProcessor.__call__
options:
show_source: false

0 comments on commit 9f3c279

Please sign in to comment.