From 69586648e6cad47b5b89de17d222b8f9c26d61cc Mon Sep 17 00:00:00 2001
From: Brandon Amos <bdamos@vt.edu>
Date: Fri, 9 Oct 2015 10:48:06 -0400
Subject: [PATCH] Refactor: facenet->openface.

---
 batch-represent/opts.lua                       |  4 ++--
 cloc.sh                                        |  2 +-
 demos/compare.py                               | 18 +++++++++---------
 demos/web/create-unknown-vectors.py            | 12 ++++++------
 demos/web/index.html                           |  2 +-
 .../js/{facenet-demo.js => openface-demo.js}   |  0
 demos/web/server.py                            | 14 +++++++-------
 evaluation/lfw.py                              |  4 ++--
 models/get-models.sh                           | 10 +++++-----
 models/{facenet => openface}/nn1.def.lua       |  0
 models/{facenet => openface}/nn4.def.lua       |  0
 {facenet => openface}/__init__.py              | 10 +++++-----
 {facenet => openface}/alignment/__init__.py    |  0
 {facenet => openface}/alignment/naive_dlib.py  |  0
 {facenet => openface}/data.py                  |  0
 {facenet => openface}/helper.py                |  0
 .../openface_server.lua                        |  6 +++---
 .../{FaceNetOptim.lua => OpenFaceOptim.lua}    |  6 +++---
 training/dataset.lua                           |  2 +-
 training/opts.lua                              |  6 +++---
 training/train.lua                             |  4 ++--
 util/align-dlib.py                             | 14 +++++++-------
 22 files changed, 57 insertions(+), 57 deletions(-)
 rename demos/web/js/{facenet-demo.js => openface-demo.js} (100%)
 rename models/{facenet => openface}/nn1.def.lua (100%)
 rename models/{facenet => openface}/nn4.def.lua (100%)
 rename {facenet => openface}/__init__.py (82%)
 rename {facenet => openface}/alignment/__init__.py (100%)
 rename {facenet => openface}/alignment/naive_dlib.py (100%)
 rename {facenet => openface}/data.py (100%)
 rename {facenet => openface}/helper.py (100%)
 rename facenet/facenet_server.lua => openface/openface_server.lua (91%)
 rename training/{FaceNetOptim.lua => OpenFaceOptim.lua} (91%)

diff --git a/batch-represent/opts.lua b/batch-represent/opts.lua
index f2f5a7177..f8588b367 100644
--- a/batch-represent/opts.lua
+++ b/batch-represent/opts.lua
@@ -11,7 +11,7 @@ end
 function M.parse(arg)
    local cmd = torch.CmdLine()
    cmd:text()
-   cmd:text('FaceNet')
+   cmd:text('OpenFace')
    cmd:text()
    cmd:text('Options:')
 
@@ -21,7 +21,7 @@ function M.parse(arg)
               paths.concat(script_path(), '..', 'data', 'lfw', 'dlib-affine-sz:96'),
               'Home of dataset')
    cmd:option('-model',
-              paths.concat(script_path(), '..', 'models', 'facenet', 'nn4.v1.t7'),
+              paths.concat(script_path(), '..', 'models', 'openface', 'nn4.v1.t7'),
               'Path to model to use.')
    cmd:option('-imgDim', 96, 'Image dimension. nn1=224, nn4=96')
    cmd:option('-batchSize',       50,   'mini-batch size')
diff --git a/cloc.sh b/cloc.sh
index 60ba76a52..89a720798 100755
--- a/cloc.sh
+++ b/cloc.sh
@@ -1,4 +1,4 @@
 #!/bin/bash
 
-cloc batch-represent evaluation facenet models training util \
+cloc batch-represent evaluation openface models training util \
   examples/web/{*.{py,html,sh},js,css}
diff --git a/demos/compare.py b/demos/compare.py
index ea2b6223b..242d7c836 100755
--- a/demos/compare.py
+++ b/demos/compare.py
@@ -33,13 +33,13 @@
 fileDir = os.path.dirname(os.path.realpath(__file__))
 sys.path.append(os.path.join(fileDir, ".."))
 
-import facenet
-import facenet.helper
-from facenet.data import iterImgs
+import openface
+import openface.helper
+from openface.data import iterImgs
 
 modelDir = os.path.join(fileDir, '..', 'models')
 dlibModelDir = os.path.join(modelDir, 'dlib')
-facenetModelDir = os.path.join(modelDir, 'facenet')
+openfaceModelDir = os.path.join(modelDir, 'openface')
 
 parser = argparse.ArgumentParser()
 
@@ -52,7 +52,7 @@
                     default=os.path.expanduser("~/src/dlib-18.16/python_examples"),
                     help="dlib directory with the dlib.so Python library.")
 parser.add_argument('--networkModel', type=str, help="Path to Torch network model.",
-                    default=os.path.join(facenetModelDir, 'nn4.v1.t7'))
+                    default=os.path.join(openfaceModelDir, 'nn4.v1.t7'))
 parser.add_argument('--imgDim', type=int, help="Default image dimension.", default=96)
 parser.add_argument('--cuda', action='store_true')
 parser.add_argument('--verbose', action='store_true')
@@ -62,15 +62,15 @@
 sys.path.append(args.dlibRoot)
 import dlib
 
-from facenet.alignment import NaiveDlib # Depends on dlib.
+from openface.alignment import NaiveDlib # Depends on dlib.
 if args.verbose:
     print("Argument parsing and loading libraries took {} seconds.".format(time.time()-start))
 
 start = time.time()
 align = NaiveDlib(args.dlibFaceMean, args.dlibFacePredictor)
-net = facenet.TorchWrap(args.networkModel, imgDim=args.imgDim, cuda=args.cuda)
+net = openface.TorchWrap(args.networkModel, imgDim=args.imgDim, cuda=args.cuda)
 if args.verbose:
-    print("Loading the dlib and FaceNet models took {} seconds.".format(time.time()-start))
+    print("Loading the dlib and OpenFace models took {} seconds.".format(time.time()-start))
 
 def getRep(imgPath):
     if args.verbose:
@@ -98,7 +98,7 @@ def getRep(imgPath):
     start = time.time()
     rep = net.forwardImage(alignedFace)
     if args.verbose:
-        print("  + FaceNet forward pass took {} seconds.".format(time.time()-start))
+        print("  + OpenFace forward pass took {} seconds.".format(time.time()-start))
         print("Representation:")
         print(rep)
         print("-----\n")
diff --git a/demos/web/create-unknown-vectors.py b/demos/web/create-unknown-vectors.py
index 2af3accdd..97c2d5691 100755
--- a/demos/web/create-unknown-vectors.py
+++ b/demos/web/create-unknown-vectors.py
@@ -27,16 +27,16 @@
 
 from skimage import io
 
-import facenet
-from facenet.alignment import NaiveDlib
-from facenet.data import iterImgs
+import openface
+from openface.alignment import NaiveDlib
+from openface.data import iterImgs
 
 if __name__ == '__main__':
     parser = argparse.ArgumentParser()
     parser.add_argument('imgDir', type=str, help="Input image directory.")
     parser.add_argument('--numImages', type=int, default=1000)
     parser.add_argument('--model', type=str, help="TODO",
-                        default="./models/facenet/nn4.v1.t7")
+                        default="./models/openface/nn4.v1.t7")
     parser.add_argument('--outputFile', type=str,
                         help="Output file, stored in numpy serialized format.",
                         default="./unknown.npy")
@@ -46,14 +46,14 @@
 
     align = NaiveDlib("models/dlib/",
                       "shape_predictor_68_face_landmarks.dat")
-    facenet = facenet.TorchWrap(args.model, imgDim=args.imgDim, cuda=False)
+    openface = openface.TorchWrap(args.model, imgDim=args.imgDim, cuda=False)
 
     allImgs = list(iterImgs(args.imgDir))
     imgObjs = random.sample(allImgs, args.numImages)
 
     reps = []
     for imgObj in imgObjs:
-        rep = facenet.forward(imgObj.path)
+        rep = openface.forward(imgObj.path)
         rep = np.array(rep)
         reps.append(rep)
 
diff --git a/demos/web/index.html b/demos/web/index.html
index a974077b2..f9361674b 100644
--- a/demos/web/index.html
+++ b/demos/web/index.html
@@ -167,7 +167,7 @@ <h2>Training
     <script src="vendor/js/handlebars.min.js"></script>
     <script src="vendor/js/jstat.min.js"></script>
     <script src="js/utils.js"></script>
-    <script src="js/facenet-demo.js"></script>
+    <script src="js/openface-demo.js"></script>
     <script type="text/javascript">
      registerHbarsHelpers();
 
diff --git a/demos/web/js/facenet-demo.js b/demos/web/js/openface-demo.js
similarity index 100%
rename from demos/web/js/facenet-demo.js
rename to demos/web/js/openface-demo.js
diff --git a/demos/web/server.py b/demos/web/server.py
index 51e232962..3cec6a484 100755
--- a/demos/web/server.py
+++ b/demos/web/server.py
@@ -42,13 +42,13 @@
 import matplotlib.pyplot as plt
 import matplotlib.cm as cm
 
-import facenet
+import openface
 
 import tempfile
 
 modelDir = os.path.join(fileDir, '..', '..', 'models')
 dlibModelDir = os.path.join(modelDir, 'dlib')
-facenetModelDir = os.path.join(modelDir, 'facenet')
+openfaceModelDir = os.path.join(modelDir, 'openface')
 
 parser = argparse.ArgumentParser()
 parser.add_argument('--dlibFaceMean', type=str, help="Path to dlib's face predictor.",
@@ -59,7 +59,7 @@
                     default=os.path.expanduser("~/src/dlib-18.15/python_examples"),
                     help="dlib directory with the dlib.so Python library.")
 parser.add_argument('--networkModel', type=str, help="Path to Torch network model.",
-                    default=os.path.join(facenetModelDir, 'nn4.v1.t7'))
+                    default=os.path.join(openfaceModelDir, 'nn4.v1.t7'))
 parser.add_argument('--imgDim', type=int, help="Default image dimension.", default=96)
 parser.add_argument('--cuda', type=bool, default=False)
 parser.add_argument('--unknown', type=bool, default=False, help='Try to predict unknown people')
@@ -68,10 +68,10 @@
 
 sys.path.append(args.dlibRoot)
 import dlib
-from facenet.alignment import NaiveDlib # Depends on dlib.
+from openface.alignment import NaiveDlib # Depends on dlib.
 
 align = NaiveDlib(args.dlibFaceMean, args.dlibFacePredictor)
-net = facenet.TorchWrap(args.networkModel, imgDim=args.imgDim, cuda=args.cuda)
+net = openface.TorchWrap(args.networkModel, imgDim=args.imgDim, cuda=args.cuda)
 
 class Face:
     def __init__(self, rep, identity):
@@ -84,7 +84,7 @@ def __repr__(self):
             self.rep[0:5]
         )
 
-class FaceNetServerProtocol(WebSocketServerProtocol):
+class OpenFaceServerProtocol(WebSocketServerProtocol):
     def __init__(self):
         self.images = {}
         self.training = True
@@ -337,7 +337,7 @@ def processFrame(self, dataURL, identity):
     log.startLogging(sys.stdout)
 
     factory = WebSocketServerFactory("ws://localhost:9000", debug=False)
-    factory.protocol = FaceNetServerProtocol
+    factory.protocol = OpenFaceServerProtocol
 
     reactor.listenTCP(9000, factory)
     reactor.run()
diff --git a/evaluation/lfw.py b/evaluation/lfw.py
index e17d0bf52..054e23622 100755
--- a/evaluation/lfw.py
+++ b/evaluation/lfw.py
@@ -222,8 +222,8 @@ def plotClassifyExp(workDir):
                'DeepFace Ensemble [{:.2f}]'.format(deepfaceAUC),
                'OpenBR v1.1.0 [{:.2f}]'.format(brAUC),
                'Eigenfaces (img-restrict) [{:.2f}]'.format(eigAUC),
-               'CMU FaceNet nn4.v1 [{:.2f}]'.format(fnAUC),
-               'CMU FaceNet nn4.v1 folds'],
+               'OpenFace nn4.v1 [{:.2f}]'.format(fnAUC),
+               'OpenFace nn4.v1 folds'],
               loc='lower right')
 
     plt.plot([0,1], color='k', linestyle='dashed')
diff --git a/models/get-models.sh b/models/get-models.sh
index 28fd35938..a21ab1a66 100755
--- a/models/get-models.sh
+++ b/models/get-models.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 #
-# Download FaceNet models.
+# Download OpenFace models.
 
 cd "$(dirname "$0")"
 
@@ -13,10 +13,10 @@ if [ ! -f dlib/shape_predictor_68_face_landmarks.dat ]; then
   bunzip2 dlib/shape_predictor_68_face_landmarks.dat.bz2
 fi
 
-exit -1 # TODO - Add FaceNet nn4.v1 URL below
+exit -1 # TODO - Add OpenFace nn4.v1 URL below
 
-mkdir -p facenet
-if [ ! -f facenet/nn4.v1.t7 ]; then
+mkdir -p openface
+if [ ! -f openface/nn4.v1.t7 ]; then
   wget TODO \
-    -O facenet/nn4.v1.t7
+    -O openface/nn4.v1.t7
 fi
diff --git a/models/facenet/nn1.def.lua b/models/openface/nn1.def.lua
similarity index 100%
rename from models/facenet/nn1.def.lua
rename to models/openface/nn1.def.lua
diff --git a/models/facenet/nn4.def.lua b/models/openface/nn4.def.lua
similarity index 100%
rename from models/facenet/nn4.def.lua
rename to models/openface/nn4.def.lua
diff --git a/facenet/__init__.py b/openface/__init__.py
similarity index 82%
rename from facenet/__init__.py
rename to openface/__init__.py
index cbba702c8..de0122680 100644
--- a/facenet/__init__.py
+++ b/openface/__init__.py
@@ -26,11 +26,11 @@
 class TorchWrap:
     # Warning: This is very unstable!
     # Please join us in improving it at:
-    #   https://github.com/cmusatyalab/facenet/issues/1
-    #   https://github.com/cmusatyalab/facenet/issues/4
-    def __init__(self, model=os.path.join(myDir, '..', 'models', 'facenet', 'nn4.v1.t7'),
+    #   https://github.com/cmusatyalab/openface/issues/1
+    #   https://github.com/cmusatyalab/openface/issues/4
+    def __init__(self, model=os.path.join(myDir, '..', 'models', 'openface', 'nn4.v1.t7'),
                  imgDim=96, cuda=False):
-        cmd = ['/usr/bin/env', 'th', os.path.join(myDir,'facenet_server.lua'),
+        cmd = ['/usr/bin/env', 'th', os.path.join(myDir,'openface_server.lua'),
                '-model', model, '-imgDim', str(imgDim)]
         if cuda:
             cmd.append('-cuda')
@@ -42,7 +42,7 @@ def forwardPath(self, imgPath):
         return [float(x) for x in self.p.stdout.readline().strip().split(',')]
 
     def forwardImage(self, rgb):
-        t = '/tmp/facenet-torchwrap-{}.png'.format(binascii.b2a_hex(os.urandom(8)))
+        t = '/tmp/openface-torchwrap-{}.png'.format(binascii.b2a_hex(os.urandom(8)))
         cv2.imwrite(t, rgb)
         rep = np.array(self.forwardPath(t))
         os.remove(t)
diff --git a/facenet/alignment/__init__.py b/openface/alignment/__init__.py
similarity index 100%
rename from facenet/alignment/__init__.py
rename to openface/alignment/__init__.py
diff --git a/facenet/alignment/naive_dlib.py b/openface/alignment/naive_dlib.py
similarity index 100%
rename from facenet/alignment/naive_dlib.py
rename to openface/alignment/naive_dlib.py
diff --git a/facenet/data.py b/openface/data.py
similarity index 100%
rename from facenet/data.py
rename to openface/data.py
diff --git a/facenet/helper.py b/openface/helper.py
similarity index 100%
rename from facenet/helper.py
rename to openface/helper.py
diff --git a/facenet/facenet_server.lua b/openface/openface_server.lua
similarity index 91%
rename from facenet/facenet_server.lua
rename to openface/openface_server.lua
index 6d6d79d96..fad394ad2 100644
--- a/facenet/facenet_server.lua
+++ b/openface/openface_server.lua
@@ -17,8 +17,8 @@
 
 -- Warning: This is very unstable!
 -- Please join us in improving it at:
---   https://github.com/cmusatyalab/facenet/issues/1
---   https://github.com/cmusatyalab/facenet/issues/4
+--   https://github.com/cmusatyalab/openface/issues/1
+--   https://github.com/cmusatyalab/openface/issues/4
 
 require 'torch'
 require 'nn'
@@ -34,7 +34,7 @@ cmd:text('Face recognition server.')
 cmd:text()
 cmd:text('Options:')
 
-cmd:option('-model', './models/facenet/nn4.v1.t7', 'Path to model.')
+cmd:option('-model', './models/openface/nn4.v1.t7', 'Path to model.')
 cmd:option('-imgDim', 96, 'Image dimension. nn1=224, nn4=96')
 cmd:option('-cuda', false)
 cmd:text()
diff --git a/training/FaceNetOptim.lua b/training/OpenFaceOptim.lua
similarity index 91%
rename from training/FaceNetOptim.lua
rename to training/OpenFaceOptim.lua
index b46a839e4..c8e5675dc 100644
--- a/training/FaceNetOptim.lua
+++ b/training/OpenFaceOptim.lua
@@ -2,9 +2,9 @@
 
 local pl = require('pl.import_into')()
 
-local FaceNetOptim, parent = torch.class('FaceNetOptim', 'nn.Optim')
+local OpenFaceOptim, parent = torch.class('OpenFaceOptim', 'nn.Optim')
 
-function FaceNetOptim:__init(model, optState, checkpoint_data)
+function OpenFaceOptim:__init(model, optState, checkpoint_data)
    parent.__init(self, model, optState, checkpoint_data)
 end
 
@@ -31,7 +31,7 @@ local function on_device_for_module(mod, f)
     return f()
 end
 
-function FaceNetOptim:optimizeTriplet(optimMethod, inputs, criterion)
+function OpenFaceOptim:optimizeTriplet(optimMethod, inputs, criterion)
    assert(optimMethod)
    assert(inputs)
    assert(criterion)
diff --git a/training/dataset.lua b/training/dataset.lua
index 5e59abd08..34df6636e 100644
--- a/training/dataset.lua
+++ b/training/dataset.lua
@@ -1,5 +1,5 @@
 -- Source: https://github.com/facebook/fbcunn/blob/master/examples/imagenet/dataset.lua
--- Modified by Brandon Amos in Sept 2015 for FaceNet by adding
+-- Modified by Brandon Amos in Sept 2015 for OpenFace by adding
 -- `samplePeople` and `sampleTriplet`.
 
 require 'torch'
diff --git a/training/opts.lua b/training/opts.lua
index 6e145aa48..0f399e942 100644
--- a/training/opts.lua
+++ b/training/opts.lua
@@ -12,7 +12,7 @@ function M.parse(arg)
 
    local cmd = torch.CmdLine()
    cmd:text()
-   cmd:text('FaceNet')
+   cmd:text('OpenFace')
    cmd:text()
    cmd:text('Options:')
 
@@ -21,7 +21,7 @@ function M.parse(arg)
               paths.concat(script_path(), 'work'),
               'subdirectory in which to save/log experiments')
    cmd:option('-data',
-              paths.concat(os.getenv('HOME'), 'facenet', 'data',
+              paths.concat(os.getenv('HOME'), 'openface', 'data',
                            'casia-facescrub',
                            'dlib-affine-sz:96'),
                            -- 'dlib-affine-224-split'),
@@ -42,7 +42,7 @@ function M.parse(arg)
 
    ---------- Model options ----------------------------------
    cmd:option('-retrain',     'none', 'provide path to model to retrain with')
-   cmd:option('-modelDef', '../models/facenet/nn4.def.lua', 'path to model definiton')
+   cmd:option('-modelDef', '../models/openface/nn4.def.lua', 'path to model definiton')
    cmd:option('-imgDim', 96, 'Image dimension. nn1=224, nn4=96')
    cmd:text()
 
diff --git a/training/train.lua b/training/train.lua
index c9df6e283..41822f974 100644
--- a/training/train.lua
+++ b/training/train.lua
@@ -16,12 +16,12 @@ require 'optim'
 require 'fbnn'
 require 'image'
 
-paths.dofile("FaceNetOptim.lua")
+paths.dofile("OpenFaceOptim.lua")
 
 
 local optimMethod = optim.adadelta
 local optimState = {} -- Use for other algorithms like SGD
-local optimator = FaceNetOptim(model, optimState)
+local optimator = OpenFaceOptim(model, optimState)
 
 trainLogger = optim.Logger(paths.concat(opt.save, 'train.log'))
 
diff --git a/util/align-dlib.py b/util/align-dlib.py
index 2c7498489..0e1c844aa 100755
--- a/util/align-dlib.py
+++ b/util/align-dlib.py
@@ -70,21 +70,21 @@ def computeMeanMain(args):
 
 
 def alignMain(args):
-    facenet.helper.mkdirP(args.outputDir)
+    openface.helper.mkdirP(args.outputDir)
 
     imgs = list(iterImgs(args.inputDir))
 
     # Shuffle so multiple versions can be run at once.
     random.shuffle(imgs)
 
-    dlibAlign = facenet.alignment.NaiveDlib(args.modelDir,
+    dlibAlign = openface.alignment.NaiveDlib(args.modelDir,
                                             args.facePredictorName)
 
     nFallbacks = 0
     for imgObject in imgs:
         outDir = os.path.join(args.outputDir, imgObject.cls)
         imgName = "{}/{}.png".format(outDir, imgObject.name)
-        facenet.helper.mkdirP(outDir)
+        openface.helper.mkdirP(outDir)
         if not os.path.isfile(imgName):
             rgb = imgObject.getRGB(cache=False)
             out = dlibAlign.alignImg(args.method, args.size, rgb)
@@ -133,10 +133,10 @@ def alignMain(args):
     args = parser.parse_args()
 
     sys.path.append(args.dlibRoot)
-    import facenet
-    import facenet.helper
-    from facenet.data import iterImgs
-    from facenet.alignment import NaiveDlib
+    import openface
+    import openface.helper
+    from openface.data import iterImgs
+    from openface.alignment import NaiveDlib
 
     if args.mode == 'computeMean':
         computeMeanMain(args)