Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jamjamjon authored Jul 11, 2024
1 parent 8badc41 commit 44739cd
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions examples/yolo/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<h1 align='center'>YOLO-Series</h1>


| Detection | Instance Segmentation | Pose |
Expand All @@ -20,7 +21,7 @@



### Quick Start
## Quick Start
```Shell

# Classify
Expand Down Expand Up @@ -49,8 +50,10 @@ cargo run -r --example yolo -- --task segment --version v8 --model FastSAM-s-dyn
cargo run -r --example yolo -- --task obb --version v8 # YOLOv8-Obb
```

**Some other options**
`--source` to specify the input images
<details close>
<summary>other options</summary>

`--source` to specify the input images
`--model` to specify the ONNX model
`--width --height` to specify the input resolution
`--nc` to specify the number of model's classes
Expand All @@ -59,20 +62,26 @@ cargo run -r --example yolo -- --task obb --version v8 # YOLOv8-Obb
`--cuda --trt --coreml --device_id` to select device
`--half` to use float16 when using TensorRT EP

</details>


## YOLOs configs with `Options`

**Use `YOLOVersion` and `YOLOTask`**
<details open>
<summary>Use official YOLO Models</summary>

```Rust
let options = Options::default()
.with_yolo_version(YOLOVersion::V5) // YOLOVersion: V5, V6, V7, V8, V9, V10, RTDETR
.with_yolo_task(YOLOTask::Classify) // YOLOTask: Classify, Detect, Pose, Segment, Obb
.with_model("xxxx.onnx")?;

```
</details>

<details open>
<summary>Cutomized your own YOLO model</summary>

**Cutomized your YOLOs model**
```Rust
// This config is for YOLOv8-Segment
use usls::{AnchorsPosition, BoxType, ClssType, YOLOPreds};
Expand All @@ -89,7 +98,7 @@ let options = Options::default()
)
.with_model("xxxx.onnx")?;
```

</details>

## Other YOLOv8 Solution Models

Expand Down

0 comments on commit 44739cd

Please sign in to comment.