Skip to content

Commit

Permalink
Add software citation source
Browse files Browse the repository at this point in the history
  • Loading branch information
jakewilliami committed Oct 6, 2024
1 parent 5c2b8cb commit 404ae13
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions citation.bib
Original file line number Diff line number Diff line change
@@ -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}
}

0 comments on commit 404ae13

Please sign in to comment.