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 12, 2024
1 parent 978b7ee commit 9f40387
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,23 +43,23 @@ A Rust library integrated with **ONNXRuntime**, providing a collection of **Comp

## Installation

Refer to **[ort guide](https://ort.pyke.io/setup/linking)**
Refer to [ort docs](https://ort.pyke.io/setup/linking)

<details close>
<summary>For Linux or MacOS users</summary>

- Firstly, download from latest release from [ONNXRuntime Releases](https://github.com/microsoft/onnxruntime/releases)
- Download from [ONNXRuntime Releases](https://github.com/microsoft/onnxruntime/releases)
- Then linking
```Shell
export ORT_DYLIB_PATH=/Users/qweasd/Desktop/onnxruntime-osx-arm64-1.17.1/lib/libonnxruntime.1.17.1.dylib
```

</details>

## Demo
## Quick Start

```Shell
cargo run -r --example yolov8 # yolov10, blip, clip, yolop, svtr, db, ...
cargo run -r --example yolo # blip, clip, yolop, svtr, db, ...
```

## Integrate into your own project
Expand All @@ -76,7 +76,7 @@ Or you can use specific commit
usls = { git = "https://github.com/jamjamjon/usls", rev = "???sha???"}
```
### 2. Set `Options` and build model
### 2. Build model
```Rust
let options = Options::default()
Expand Down Expand Up @@ -109,7 +109,7 @@ let mut model = YOLO::new(options)?;
```
- Go check [Options](src/core/options.rs) for more model options.
#### 3. Prepare inputs, and then you're ready to go
#### 3. Load images
- Build `DataLoader` to load images
Expand All @@ -130,7 +130,7 @@ let x = vec![DataLoader::try_read("./assets/bus.jpg")?];
let y = model.run(&x)?;
```
#### 4. Annotate and save results
#### 4. Annotate and save
```Rust
let annotator = Annotator::default().with_saveout("YOLO");
Expand Down

0 comments on commit 9f40387

Please sign in to comment.