Update docs.

This commit is contained in:
Brandon Amos 2015-11-02 17:30:14 -05:00
parent 3139fad63f
commit 1e966337eb
9 changed files with 53 additions and 28 deletions

View File

@ -10,7 +10,7 @@ We obtain a mean accuracy of 0.8483 ± 0.0172 with an AUC of 0.923.
For comparison, training with Google-scale data results in an
accuracy of .9963 ± 0.009.
![](../images/nn4.v1.lfw.roc.png)
![](https://raw.githubusercontent.com/cmusatyalab/openface/master/images/nn4.v1.lfw.roc.png)
This can be generated with the following commands from the root `openface`
directory, assuming you have downloaded and placed the raw and

21
docs/css/extra.css Normal file
View File

@ -0,0 +1,21 @@
div.col-md-9 h1:first-of-type {
text-align: center;
font-size: 60px;
font-weight: 300;
}
/* div.col-md-9 p:first-of-type { */
/* text-align: center; */
/* } */
/* div.col-md-9 p.admonition-title:first-of-type { */
/* text-align: left; */
/* } */
/* div.col-md-9 h1:first-of-type .headerlink { */
/* display: none; */
/* } */
code.no-highlight {
color: black;
}

View File

@ -5,7 +5,7 @@ for face recognition.
The source is available in [demos/web](https://github.com/cmusatyalab/openface/blob/master/demos/web).
<a href='https://www.youtube.com/watch?v=LZJOTRkjZA4'><img src='../../images/youtube-web.gif'></img></a>
<a href='https://www.youtube.com/watch?v=LZJOTRkjZA4'><img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/youtube-web.gif'></img></a>
This demo does the full face recognition pipeline on every frame.
In practice, object tracking

View File

@ -11,7 +11,7 @@ Eric Clapton were generated with
| Lennon 1 | Lennon 2 | Clapton 1 | Clapton 2 |
|---|---|---|---|
| <img src='../../images/examples/lennon-1.jpg' width='200px'></img> | <img src='../../images/examples/lennon-2.jpg' width='200px'></img> | <img src='../../images/examples/clapton-1.jpg' width='200px'></img> | <img src='../../images/examples/clapton-2.jpg' width='200px'></img> |
| <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/lennon-1.jpg' width='200px'></img> | <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/lennon-2.jpg' width='200px'></img> | <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/clapton-1.jpg' width='200px'></img> | <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/clapton-2.jpg' width='200px'></img> |
The following table shows that a distance threshold of `0.5` would
distinguish these two people.

View File

@ -41,7 +41,7 @@ Run the classifier on your images with:
| Person | Image | Prediction | Confidence |
|---|---|---|---|
| Carell | <img src='../../images/examples/carell.jpg' width='200px'></img> | SteveCarell | 0.78 |
| Adams | <img src='../../images/examples/adams.jpg' width='200px'></img> | AmyAdams | 0.87 |
| Lennon 1 (Unknown) | <img src='../../images/examples/lennon-1.jpg' width='200px'></img> | DavidBoreanaz | 0.28 |
| Lennon 2 (Unknown) | <img src='../../images/examples/lennon-2.jpg' width='200px'></img> | DavidBoreanaz | 0.56 |
| Carell | <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/carell.jpg' width='200px'></img> | SteveCarell | 0.78 |
| Adams | <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/adams.jpg' width='200px'></img> | AmyAdams | 0.87 |
| Lennon 1 (Unknown) | <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/lennon-1.jpg' width='200px'></img> | DavidBoreanaz | 0.28 |
| Lennon 2 (Unknown) | <img src='https://raw.githubusercontent.com/cmusatyalab/openface/master/images/examples/lennon-2.jpg' width='200px'></img> | DavidBoreanaz | 0.56 |

View File

@ -1,6 +1,9 @@
# OpenFace
# OpenFace <iframe src="https://ghbtns.com/github-btn.html?user=cmusatyalab&repo=openface&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
<iframe src="https://ghbtns.com/github-btn.html?user=cmusatyalab&repo=openface&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
<center>
*Free and open source face recognition with
Google's FaceNet deep neural network.*
</center>
---
@ -82,7 +85,7 @@ image of Sylvestor Stallone from the publicly available
See below for our examples for classification and
similarity detection, including an online web demo.
![](../images/summary.jpg)
![](https://raw.githubusercontent.com/cmusatyalab/openface/master/images/summary.jpg)
# What's in this repository?
+ [batch-represent](https://github.com/cmusatyalab/openface/tree/master/batch-represent): Generate representations from

View File

@ -34,4 +34,4 @@ Our `nn4.v1` model is from epoch 177.
The LFW section above shows that this model obtains a mean
accuracy of 0.8483 &plusmn; 0.0172 with an AUC of 0.923.
![](../images/nn4.v1.loss.png)
![](https://raw.githubusercontent.com/cmusatyalab/openface/master/images/nn4.v1.loss.png)

View File

@ -7,11 +7,11 @@ in the training and testing dataset with the most images.
**Training**
![](../images/train-tsne.png)
![](https://raw.githubusercontent.com/cmusatyalab/openface/master/images/train-tsne.png)
**Testing**
![](../images/val-tsne.png)
![](https://raw.githubusercontent.com/cmusatyalab/openface/master/images/val-tsne.png)
These can be generated with the following commands from the root
`openface` directory.
@ -37,5 +37,5 @@ The following shows the first 39 filters of the
first convolutional layer on two images
of John Lennon.
![](../images/nn4.v1.conv1.lennon-1.png)
![](../images/nn4.v1.conv1.lennon-2.png)
![](https://raw.githubusercontent.com/cmusatyalab/openface/master/images/nn4.v1.conv1.lennon-1.png)
![](https://raw.githubusercontent.com/cmusatyalab/openface/master/images/nn4.v1.conv1.lennon-2.png)

View File

@ -1,18 +1,19 @@
site_name: OpenFace
docs_dir: '.'
site_dir: /tmp/openfacesite
repo_url: https://github.com/cmusatyalab/openface
theme: readthedocs
#theme: readthedocs
copyright: 'Crafted by <a href="http://bamos.github.io">Brandon Amos</a> at Carnegie Mellon University'
theme: simplex
extra_css:
- css/extra.css
pages:
- Home: docs/index.md
- Home: index.md
- Demos:
- 1 - Real-time Web: docs/demo-1-web.md
- 2 - Comparison: docs/demo-2-comparison.md
- 3 - Classifier: docs/demo-3-classifier.md
- Accuracy: docs/accuracy.md
- Usage: docs/usage.md
- Models: docs/models.md
- DNN Training: docs/training-new-models.md
- Visualizations: docs/visualizations.md
- Setup: docs/setup.md
- 1 - Real-time Web: demo-1-web.md
- 2 - Comparison: demo-2-comparison.md
- 3 - Classifier: demo-3-classifier.md
- Accuracy: accuracy.md
- Usage: usage.md
- Models: models.md
- DNN Training: training-new-models.md
- Visualizations: visualizations.md
- Setup: setup.md