Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kadirnar committed Jan 22, 2023
1 parent 90a3286 commit 15316bf
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@

### Introduction

The TorchYolo library aims to support YOLO models(like YOLOv5, YOLOv7, YOLOv8) and Tracker Algorithm(Sort, StrongSort, ByteTrack, OcSort and Norfair) and provide a unified interface for training and inference. The library is based on PyTorch and is designed to be easy to use and extend.
The TorchYolo library aims to support YOLO models(like YOLOv5, YOLOv6, YOLOv7, YOLOv8) and Tracker Algorithm(Sort, StrongSort, ByteTrack, OcSort and Norfair) and provide a unified interface for training and inference. The library is based on PyTorch and is designed to be easy to use and extend.

### Installation
```bash
pip install torchyolo
```
### Usage
First download the [default_config.yaml](https://github.com/kadirnar/torchyolo/releases/download/v0.0.5/default_config.yaml) file.
First download the [default_config.yaml](https://github.com/kadirnar/torchyolo/releases/download/v1.0.0/default_config.yaml) file.

```python
from torchyolo import YoloHub
Expand All @@ -33,7 +33,7 @@ model = YoloHub(
)
result = model.predict(
source="test.mp4",
tracker_type="NORFAIR",
tracker_type="NORFAIR", # or False
tracker_config_path="norfair_track.yaml"
)
```
Expand Down Expand Up @@ -112,6 +112,14 @@ A part of the code is borrowed from [SAHI](https://github.com/obss/sahi). Many t
}
```
```bibtex
@article{li2022yolov6,
title={YOLOv6: A single-stage object detection framework for industrial applications},
author={Li, Chuyi and Li, Lulu and Jiang, Hongliang and Weng, Kaiheng and Geng, Yifei and Li, Liang and Ke, Zaidan and Li, Qingyuan and Cheng, Meng and Nie, Weiqiang and others},
journal={arXiv preprint arXiv:2209.02976},
year={2022}
}
```
```bibtex
@software{glenn_jocher_2020_4154370,
author = {Glenn Jocher and,Alex Stoken and,Jirka Borovec and,NanoCode012 and,ChristopherSTAN and,Liu Changyu and,Laughing and,tkianai and,Adam Hogan and,lorenzomammana and,yxNONG and,AlexWang1900 and,Laurentiu Diaconu and,Marc and,wanghaoyang0106 and,ml5ah and,Doug and,Francisco Ingham and,Frederik and,Guilhen and,Hatovix and,Jake Poznanski and,Jiacong Fang and,Lijun Yu 于力军 and,changyu98 and,Mingyu Wang and,Naman Gupta and,Osama Akhtar and,PetrDvoracek and,Prashant Rai},
title={{ultralytics/yolov5: v7.2 - Bug Fixes and
Expand Down

0 comments on commit 15316bf

Please sign in to comment.