Skip to content

Commit 4cba043

Browse files
authored
Add Fidan as co-authors for great contributions on ORT (#231)
* Add Fidan as co-authors for great contributions on ONNXRuntime * Add emoji
1 parent 2193ccd commit 4cba043

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ ______________________________________________________________________
3232

3333
</div>
3434

35-
## :hugs: Introduction
35+
## 🤗 Introduction
3636

3737
**What it is.** Yet another implementation of Ultralytics's [YOLOv5](https://github.com/ultralytics/yolov5). `yolort` aims to make the training and inference of the object detection integrate more seamlessly together. `yolort` now adopts the same model structure as the official YOLOv5. The significant difference is that we adopt the dynamic shape mechanism, and within this, we can embed both pre-processing (`letterbox`) and post-processing (`nms`) into the model graph, which simplifies the deployment strategy. In this sense, `yolort` makes it possible to be deployed more friendly on `LibTorch`, `ONNXRuntime`, `TVM` and so on.
3838

@@ -44,7 +44,7 @@ ______________________________________________________________________
4444

4545
<a href="notebooks/assets/zidane.jpg"><img src="notebooks/assets/zidane.jpg" alt="YOLO inference demo" width="500"/></a>
4646

47-
## :new: What's New
47+
## 🆕 What's New
4848

4949
- *Sep. 24, 2021*. Add `ONNXRuntime` C++ interface example. Thanks to [itsnine](https://github.com/itsnine).
5050
- *Feb. 5, 2021*. Add `TVM` compile and inference notebooks.
@@ -54,7 +54,7 @@ ______________________________________________________________________
5454
- *Nov. 4, 2020*. Add `LibTorch` C++ inference example.
5555
- *Oct. 8, 2020*. Support exporting to `TorchScript` model.
5656

57-
## :hammer_and_wrench: Usage
57+
## 🛠️ Usage
5858

5959
There are no extra compiled components in `yolort` and package dependencies are minimal, so the code is very simple to use.
6060

@@ -135,17 +135,30 @@ We provide a [notebook](notebooks/inference-pytorch-export-libtorch.ipynb) to de
135135

136136
On the `ONNXRuntime` front you can use the [C++ example](deployment/onnxruntime), and we also provide a tutorial [export-onnx-inference-onnxruntime](notebooks/export-onnx-inference-onnxruntime.ipynb) for using the `ONNXRuntime`.
137137

138-
## :art: Model Graph Visualization
138+
## 🎨 Model Graph Visualization
139139

140140
Now, `yolort` can draw the model graph directly, checkout our [model-graph-visualization](notebooks/model-graph-visualization.ipynb) notebook to see how to use and visualize the model graph.
141141

142142
<a href="notebooks/assets/yolov5_graph_visualize.svg"><img src="notebooks/assets/yolov5_graph_visualize.svg" alt="YOLO model visualize" width="500"/></a>
143143

144-
## :mortar_board: Acknowledgement
144+
## 🎓 Acknowledgement
145145

146146
- The implementation of `yolov5` borrow the code from [ultralytics](https://github.com/ultralytics/yolov5).
147147
- This repo borrows the architecture design and part of the code from [torchvision](https://github.com/pytorch/vision).
148148

149-
## :+1: Contributing
149+
## 📖 Citing yolort
150+
151+
If you use yolort in your publication, please cite it by using the following BibTeX entry.
152+
153+
```bibtex
154+
@Misc{yolort2021,
155+
author = {Zhiqiang Wang, Fidan Kharrasov},
156+
title = {yolort: A runtime stack for object detection on specialized accelerators},
157+
howpublished = {\url{https://github.com/zhiqwang/yolov5-rt-stack}},
158+
year = {2021}
159+
}
160+
```
161+
162+
## 👋 Contributing
150163

151164
See the [CONTRIBUTING](.github/CONTRIBUTING.md) file for how to help out. BTW, leave a :star2: if you liked it, and this is the easiest way to support us :)

0 commit comments

Comments
 (0)