Skip to content

Commit 15316bf

Browse files
committed
update readme
1 parent 90a3286 commit 15316bf

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414

1515
### Introduction
1616

17-
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.
17+
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.
1818

1919
### Installation
2020
```bash
2121
pip install torchyolo
2222
```
2323
### Usage
24-
First download the [default_config.yaml](https://github.com/kadirnar/torchyolo/releases/download/v0.0.5/default_config.yaml) file.
24+
First download the [default_config.yaml](https://github.com/kadirnar/torchyolo/releases/download/v1.0.0/default_config.yaml) file.
2525

2626
```python
2727
from torchyolo import YoloHub
@@ -33,7 +33,7 @@ model = YoloHub(
3333
)
3434
result = model.predict(
3535
source="test.mp4",
36-
tracker_type="NORFAIR",
36+
tracker_type="NORFAIR", # or False
3737
tracker_config_path="norfair_track.yaml"
3838
)
3939
```
@@ -112,6 +112,14 @@ A part of the code is borrowed from [SAHI](https://github.com/obss/sahi). Many t
112112
}
113113
```
114114
```bibtex
115+
@article{li2022yolov6,
116+
title={YOLOv6: A single-stage object detection framework for industrial applications},
117+
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},
118+
journal={arXiv preprint arXiv:2209.02976},
119+
year={2022}
120+
}
121+
```
122+
```bibtex
115123
@software{glenn_jocher_2020_4154370,
116124
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},
117125
title={{ultralytics/yolov5: v7.2 - Bug Fixes and

0 commit comments

Comments
 (0)