From bb377aac51b9ac335b6e5be3098fca4ecc815b71 Mon Sep 17 00:00:00 2001
From: Brandon Amos <bamos@cs.cmu.edu>
Date: Thu, 1 Mar 2018 19:03:55 -0500
Subject: [PATCH] Mention inconsistencies between the pre-trained models and
 the model definitions for #351 and #349

---
 docs/index.md                 | 9 +++++++--
 docs/models-and-accuracies.md | 9 +++++++++
 docs/training-new-models.md   | 8 ++++++++
 3 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index ee5a9cb..e9da12e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -150,6 +150,11 @@ CMU-CS-16-118, CMU School of Computer Science, Tech. Rep., 2016.
 ```
 
 # Acknowledgements
++ Kenneth Jung noticed that the model definitions are slightly
+  different than the pre-trained models.
+  For more information, see issues
+  [#351](https://github.com/cmusatyalab/openface/issues/351) and
+  [#349](https://github.com/cmusatyalab/openface/issues/349).
 + The fantastic Torch ecosystem and community.
 + [Alfredo Canziani's](https://github.com/Atcold)
   implementation of FaceNet's loss function in
@@ -189,7 +194,7 @@ These portions are noted in the source files and are
 copyright their respective authors with
 the licenses listed.
 
-Project | Modified | License
----|---|---|
+| Project | Modified | License |
+|---|---|---|
 [Atcold/torch-TripletEmbedding](https://github.com/Atcold/torch-TripletEmbedding) | No | MIT
 [facebook/fbnn](https://github.com/facebook/fbnn) | Yes | BSD
diff --git a/docs/models-and-accuracies.md b/docs/models-and-accuracies.md
index ca74d8c..451d4fa 100644
--- a/docs/models-and-accuracies.md
+++ b/docs/models-and-accuracies.md
@@ -1,4 +1,13 @@
 # Models and Accuracies
+
+Note: Kenneth Jung noticed that the model definitions are slightly
+different than the pre-trained models.
+For more information, see issues
+[#351](https://github.com/cmusatyalab/openface/issues/351) and
+[#349](https://github.com/cmusatyalab/openface/issues/349).
+
+---
+
 This page overviews different OpenFace neural network models
 and is intended for advanced users.
 
diff --git a/docs/training-new-models.md b/docs/training-new-models.md
index c68a290..c8240d6 100644
--- a/docs/training-new-models.md
+++ b/docs/training-new-models.md
@@ -1,5 +1,13 @@
 # Training new neural network models
 
+Note: Kenneth Jung noticed that the model definitions are slightly
+different than the pre-trained models.
+For more information, see issues
+[#351](https://github.com/cmusatyalab/openface/issues/351) and
+[#349](https://github.com/cmusatyalab/openface/issues/349).
+
+---
+
 We have also released our deep neural network (DNN)
 training infrastructure to promote an open ecosystem and enable quicker
 bootstrapping for new research and development.