Skip to content

Commit f9bbcdb

Browse files
authored
add zenodo doi and citation into readme (#280)
* add zenodo doi and citation into readme * update version in citation * add citation.cff * Update CITATION.cff * Update README.md
1 parent a5cb9c2 commit f9bbcdb

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

CITATION.cff

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
cff-version: 1.2.0
2+
message: "If you use this package, please cite it as below."
3+
authors:
4+
- family-names: "Akyon"
5+
given-names: "Fatih Cagatay"
6+
- family-names: "Cengiz"
7+
given-names: "Cemil"
8+
- family-names: "Altinuc"
9+
given-names: "Sinan Onur"
10+
- family-names: "Cavusoglu"
11+
given-names: "Devrim"
12+
- family-names: "Sahin"
13+
given-names: "Kadir"
14+
- family-names: "Eryuksel"
15+
given-names: "Ogulcan"
16+
title: "SAHI: A lightweight vision library for performing large scale object detection and instance segmentation"
17+
doi: 10.5281/zenodo.5718950
18+
month: nov
19+
year: 2021
20+
publisher: Zenodo
21+
url: "https://doi.org/10.5281/zenodo.5718950"

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
<a href="https://badge.fury.io/py/sahi"><img src="https://badge.fury.io/py/sahi.svg" alt="pypi version"></a>
2020
<a href="https://anaconda.org/conda-forge/sahi"><img src="https://anaconda.org/conda-forge/sahi/badges/version.svg" alt="conda version"></a>
2121
<a href="https://github.com/obss/sahi/actions?query=event%3Apush+branch%3Amain+is%3Acompleted+workflow%3ACI"><img src="https://github.com/obss/sahi/workflows/CI/badge.svg" alt="ci"></a>
22+
<br>
23+
<a href="https://doi.org/10.5281/zenodo.5718950"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.5718950.svg" alt="ci"></a>
2224
</div>
2325
</div>
2426

@@ -422,6 +424,29 @@ mot_video.export(export_dir="mot_gt", type="gt")
422424

423425
<b>Find detailed info on MOT utilities (ground truth dataset creation, exporting tracker metrics in mot challenge format) at [MOT.md](docs/MOT.md).</b>
424426

427+
## <div align="center">Citation</div>
428+
429+
If you use this package in your work, please cite it as:
430+
431+
```
432+
@software{akyon2021sahi,
433+
author = {Akyon, Fatih Cagatay and
434+
Cengiz, Cemil and
435+
Altinuc, Sinan Onur and
436+
Cavusoglu, Devrim and
437+
Sahin, Kadir and
438+
Eryuksel, Ogulcan},
439+
title = {{SAHI: A lightweight vision library for performing
440+
large scale object detection and instance
441+
segmentation}},
442+
month = nov,
443+
year = 2021,
444+
publisher = {Zenodo},
445+
doi = {10.5281/zenodo.5718950},
446+
url = {https://doi.org/10.5281/zenodo.5718950}
447+
}
448+
```
449+
425450
## <div align="center">Contributing</div>
426451

427452
`sahi` library currently supports all [YOLOv5 models](https://github.com/ultralytics/yolov5/releases) and [MMDetection models](https://github.com/open-mmlab/mmdetection/blob/master/docs/model_zoo.md). Moreover, it is easy to add new frameworks.

0 commit comments

Comments
 (0)