Adding demo files

Author: mathinking

LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2019-2020, The MathWorks, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* In all cases, the software is, and all modifications and derivatives of the
+  software shall be, licensed to you solely for use in conjunction with
+  MathWorks products and service offerings.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,75 @@
+# FaceGenderAgeEmotionDetection 
+Demo for face, gender, age and emotion detection (all using Deep Learning), together with some Computer Vision features to enhance detection and tracking.
+
+Note all these networks have their origins in research. **Use preferably with a GPU.**
+
+## Requirements:
+### In MATLAB
+* [Deep Learning Toolbox Importer for Caffe Models](https://www.mathworks.com/matlabcentral/fileexchange/61735-deep-learning-toolbox-importer-for-caffe-models)
+* [MATLAB Support Package for USB Webcams](https://www.mathworks.com/matlabcentral/fileexchange/45182-matlab-support-package-for-usb-webcams)
+
+### Deployed on a Jetson
+* [Deep Learning Toolbox Importer for Caffe Models](https://www.mathworks.com/matlabcentral/fileexchange/61735-deep-learning-toolbox-importer-for-caffe-models)
+* [MATLAB Support Package for USB Webcams](https://www.mathworks.com/matlabcentral/fileexchange/45182-matlab-support-package-for-usb-webcams)
+* [GPU Coder Support Package for NVIDIA GPUs](https://mathworks.com/matlabcentral/fileexchange/68644-gpu-coder-support-package-for-nvidia-gpus)
+* [GPU Coder Interface for Deep Learning Libraries](https://mathworks.com/matlabcentral/fileexchange/68642-gpu-coder-interface-for-deep-learning-libraries)
+
+## Installation
+This demo uses pre-trained models in Caffe (requires downloading ~1.16GB). 
+
+Add folder to search path and check for Add-on requirements by running:
+```matlab 
+>> install
+```
+
+For downloading the models, run:
+```matlab 
+>> downloadAndSetupNetworks
+```
+
+## Usage
+### In MATLAB
+You may run face, age and emotion detection by running (gender detection is disabled by default):
+```matlab
+>> faceGenderAgeEmotionDetection
+```
+![Test Image](testImage.png)
+
+or choose which of the available models to use. For instance:
+```matlab
+>> faceGenderAgeEmotionDetection(true,true,true)
+```
+which runs gender, age and emotion detection. The demo uses binary gender detection, which may be consider inappropriate. Its use is not recommended in a public setting.
+
+You may also speed up perfomance by generating MEX files using GPU Coder for each of the predict functions:
+1. Make sure that your computer is setup correctly:
+```matlab
+>> coder.checkGpuInstall
+```
+2. Generate mex files:
+```matlab
+>> generateCode
+```
+
+### Deployed on a Jetson
+1. Make sure that your environment is setup correctly:
+```matlab
+>> coder.checkGpuInstall('tx2');
+```
+2. Open the codegen script
+```matlab
+>> edit generateCodeForJetson
+```
+3. Modify it to reflect your current configuration (e.g. IP address).
+4. Run the first section to generate CUDA code on the host, transfer it to the Jetson and compile it.
+5. Run the second section to launch the executable on the jetson. Please note that you can change the clock speed to maximise the performance.
+
+## References
+
+[1] Abars, Face Search VGG16, (2018). GitHub repository, https://github.com/abars/FaceSearchVGG16
+	
+[2] Rasmus Rothe, Radu Timofte and Luc Van Gool, (2016). Deep expectation of real and apparent age from a single image without facial landmarks. International Journal of Computer Vision (IJCV)
+	
+[3] Jia, Yangqing, et al., (2014). "Caffe: Convolutional architecture for fast feature embedding." Proceedings of the 22nd ACM international conference on Multimedia. ACM.
+
+[4] Gil Levi and Tal Hassner, (2015). Emotion Recognition in the Wild via Convolutional Neural Networks and Mapped Binary Patterns. Proc. ACM International Conference on Multimodal Interaction (ICMI).     https://osnathassner.github.io/talhassner/projects/cnn_emotions/project.html

install.m

@@ -0,0 +1,55 @@
+% Copyright 2019 The MathWorks, Inc.
+function install()   
+    thisPath = fileparts(mfilename('fullpath'));
+    
+    % Add folders to search path
+    addpath(fullfile(thisPath, 'src'));
+    
+    requiredAddOns = ["MATLAB Support Package for USB Webcams",...
+                      "Deep Learning Toolbox Importer for Caffe Models",...
+                      "GPU Coder Support Package for NVIDIA GPUs",...
+                      "GPU Coder Interface for Deep Learning Libraries"];
+    
+	% Checking for missing Add-Ons
+    missingAddOns = true(size(requiredAddOns));
+	installedAddOns = matlab.addons.installedAddons;
+    
+    addOnIdx = 1;
+    dashRepeats = 52;
+    while addOnIdx <= length(requiredAddOns)
+        if ~any(installedAddOns.Name ==  requiredAddOns(addOnIdx))
+            missingAddOns(addOnIdx) = true;
+        else
+            missingAddOns(addOnIdx) = false;
+        end
+        addOnIdx = addOnIdx + 1;
+    end
+
+    if all(~missingAddOns)
+        fprintf(1,[repmat('-',1,dashRepeats),'\n']);
+        fprintf(1,'All the required Add-Ons are successfully installed.\n');
+        fprintf(1,[repmat('-',1,dashRepeats),'\n']);
+    else
+        fprintf(1,[repmat('-',1,dashRepeats),'\n']);
+        fprintf(1,'The following support packages are missing.\nPlease, visit the Add-On Explorer from your HOME tab \nand install the following:\n');
+        for missingIdx = find(missingAddOns)
+            if ~(missingIdx == 3 || missingIdx == 4)
+                fprintf(1,'  - %s\n',requiredAddOns(missingIdx))
+            else
+                fprintf(1,'  - %s (*)\n',requiredAddOns(missingIdx))
+            end
+        end
+        if ismember([3,4],find(missingAddOns))
+            fprintf(1,'(*) only if using GPU Coder\n');
+        end
+        fprintf(1,[repmat('-',1,dashRepeats),'\n']);
+    end
+   
+    fprintf(1,'You may now download and configure the models \n(if you haven''t already).\n') 
+    fprintf(1,'To do so, run the script:\n''downloadAndSetupNetworks.m''.\n');
+    fprintf(1,[repmat('-',1,dashRepeats),'\n']);
+    fprintf(1,'Also, you may speed up detection by running:\n''generateCode.m''.\n(NVIDIA GPU and GPU support packages required).\n');
+    fprintf(1,[repmat('-',1,dashRepeats),'\n']);
+    
+    cd('src')
+end