From 404ae13de97aaebb271362c2c9474f1a86d494bf Mon Sep 17 00:00:00 2001 From: Jake Ireland Date: Sun, 6 Oct 2024 17:20:52 +1300 Subject: [PATCH] Add software citation source --- README.md | 6 +++++- citation.bib | 7 +++++++ 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 citation.bib diff --git a/README.md b/README.md index 6a76e0093..6af3ed9e0 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ In an over-simplified manner, the Viola-Jones algorithm has some four stages: - Stacking trains a learning algorithm to combine the predictions of several other learning algorithms. Despite this method being developed at the start of the century, it is blazingly fast compared to some machine learning algorithms, and still widely used. 4. Finally, this algorithm uses [Cascading Classifiers](https://en.wikipedia.org/wiki/Cascading_classifiers) to identify faces. (See page 12 of the original paper for the specific cascade). - + For a better explanation, read [the paper from 2001](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.10.6807), or see [the Wikipedia page](https://en.wikipedia.org/wiki/Viola%E2%80%93Jones_object_detection_framework) on this algorithm. ## Quick Start @@ -66,6 +66,10 @@ println((correct_non_faces / num_non_faces) * 100, "% of non-faces were identifi For more examples like this, see [`examples/`](examples/). +## Citation + +If your research depends on FaceDetection.jl, please consider giving us a formal citation: [`citation.bib`](./citation.bib). + ## Miscellaneous Notes ### Timeline of Progression diff --git a/citation.bib b/citation.bib new file mode 100644 index 000000000..e209eb0da --- /dev/null +++ b/citation.bib @@ -0,0 +1,7 @@ +@software{ireland2022facedetection, + title={{FaceDetection.jl}: {Julia} implementation of {Viola}--{Jones}' rapid object detection framework}, + author={Ireland, Jake W}, + year={2024}, + howpublished={\url{https://github.com/jakewilliami/FaceDetection.jl}}, + note={{Julia} package version 1.1.0} +} \ No newline at end of file