Merge branch 'master' into TensorRT_PR

.github/generate_gh_pages.sh

@@ -0,0 +1,106 @@
+#!/bin/sh
+################################################################################
+# Title         : generate_gh_pages.sh
+# Date created  : 2016/02/22
+# Notes         :
+__AUTHOR__="openpose"
+# Preconditions:
+# - Packages doxygen doxygen-doc doxygen-latex doxygen-gui graphviz
+#   must be installed.
+# - Doxygen configuration file must have the destination directory empty and
+#   source code directory with a $(TRAVIS_BUILD_DIR) prefix.
+# - An gh-pages branch should already exist. See below for mor info on hoe to
+#   create a gh-pages branch.
+#
+# Required global variables:
+# - TRAVIS_BUILD_NUMBER : The number of the current build.
+# - TRAVIS_COMMIT       : The commit that the current build is testing.
+# - DOXYFILE            : The Doxygen configuration file.
+# - GH_REPO_NAME        : The name of the repository.
+# - GH_REPO_REF         : The GitHub reference to the repository.
+# - GH_REPO_TOKEN       : Secure token to the github repository.
+#
+# For information on how to encrypt variables for Travis CI please go to
+# https://docs.travis-ci.com/user/environment-variables/#Encrypted-Variables
+# or https://gist.github.com/vidavidorra/7ed6166a46c537d3cbd2
+# For information on how to create a clean gh-pages branch from the master
+# branch, please go to https://gist.github.com/vidavidorra/846a2fc7dd51f4fe56a0
+#
+# This script will generate Doxygen documentation and push the documentation to
+# the gh-pages branch of a repository specified by GH_REPO_REF.
+# Before this script is used there should already be a gh-pages branch in the
+# repository.
+# 
+################################################################################
+
+################################################################################
+##### Setup this script and get the current gh-pages branch.               #####
+echo 'Setting up the script...'
+# Exit with nonzero exit code if anything fails
+set -e
+
+# Create a clean working directory for this script.
+mkdir code_docs
+cd code_docs
+
+# Get the current gh-pages branch
+git clone -b gh-pages https://git@$GH_REPO_REF
+cd $GH_REPO_NAME
+
+##### Configure git.
+# Set the push default to simple i.e. push only the current branch.
+git config --global push.default simple
+# Pretend to be an user called Travis CI.
+git config user.name "Travis CI"
+git config user.email "[email protected]"
+
+# Remove everything currently in the gh-pages branch.
+# GitHub is smart enough to know which files have changed and which files have
+# stayed the same and will only update the changed files. So the gh-pages branch
+# can be safely cleaned, and it is sure that everything pushed later is the new
+# documentation.
+rm -rf *
+
+# Need to create a .nojekyll file to allow filenames starting with an underscore
+# to be seen on the gh-pages site. Therefore creating an empty .nojekyll file.
+# Presumably this is only needed when the SHORT_NAMES option in Doxygen is set
+# to NO, which it is by default. So creating the file just in case.
+echo "" > .nojekyll
+
+################################################################################
+##### Generate the Doxygen code documentation and log the output.          #####
+echo 'Generating Doxygen code documentation...'
+# Redirect both stderr and stdout to the log file AND the console.
+echo "INPUT                  = ${TRAVIS_BUILD_DIR}/README.md ${TRAVIS_BUILD_DIR}/include/openpose/" >> $DOXYFILE
+echo "USE_MDFILE_AS_MAINPAGE = ${TRAVIS_BUILD_DIR}/README.md" >> $DOXYFILE
+echo "OUTPUT_DIRECTORY       = " >> $DOXYFILE
+doxygen $DOXYFILE 2>&1 | tee doxygen.log
+
+################################################################################
+##### Upload the documentation to the gh-pages branch of the repository.   #####
+# Only upload if Doxygen successfully created the documentation.
+# Check this by verifying that the html directory and the file html/index.html
+# both exist. This is a good indication that Doxygen did it's work.
+if [ -d "html" ] && [ -f "html/index.html" ]; then
+
+    echo 'Uploading documentation to the gh-pages branch...'
+    # Add everything in this directory (the Doxygen code documentation) to the
+    # gh-pages branch.
+    # GitHub is smart enough to know which files have changed and which files have
+    # stayed the same and will only update the changed files.
+    git add --all
+
+    # Commit the added files with a title and description containing the Travis CI
+    # build number and the GitHub commit reference that issued this build.
+    git commit -m "Deploy code docs to GitHub Pages Travis build: ${TRAVIS_BUILD_NUMBER}" -m "Commit: ${TRAVIS_COMMIT}"
+
+    # Force push to the remote gh-pages branch.
+    # The ouput is redirected to /dev/null to hide any sensitive credential data
+    # that might otherwise be exposed.
+    git push --force "https://${GH_REPO_TOKEN}@${GH_REPO_REF}" > /dev/null 2>&1
+else
+    echo '' >&2
+    echo 'Warning: No documentation (html) files have been found!' >&2
+    echo 'Warning: Not going to push the documentation to GitHub!' >&2
+    exit 1
+fi

.github/issue_template.md

@@ -1,27 +1,29 @@
 ### Posting rules
-1. **Add** the **system configuration (all of it!), command and output** if you have some kind of error or performance question.
-2. **No duplicated** posts.
-3. **No** posts about **questions already answered / clearly explained in** the **documentation** (e.g. **no more low-speed nor out-of-memory questions**).
-4. Set a **proper issue title**: add the Ubuntu/Windows word and be specific (e.g. do not simple call it: `Compile error`).
-5. Only English comments.
-Issues/comments that do not follow this will be **ignored or removed** with no further clarification.
+1. **No** questions about **training**. OpenPose only implements testing.
+2. **No** questions about **Caffe installation errors/issues**. Check [Caffe](http://caffe.berkeleyvision.org) documentation and help for those errors.
+3. **Fill** the **Your System Configuration section (all of it!)** if you have some kind of error or performance question.
+4. **No duplicated** posts.
+5. **No** posts about **questions already answered / clearly explained in** the **documentation** (e.g. **no more low-speed nor out-of-memory questions**).
+6. Set a **proper issue title**: add the Ubuntu/Windows word and be specific (e.g. do not simple call it: `Compile error`).
+7. Only English comments.
+Issues/comments which do not follow these rules will be **ignored or removed** with no further clarification.
 
 
 
-### Issue summary
+### Issue Summary
 
 
 
-### Executed command (if any)
+### Executed Command (if any)
 Note: add `--logging_level 0` to get higher debug information.
 
 
 
-### OpenPose output (if any)
+### OpenPose Output (if any)
 
 
 
-### Type of issue
+### Type of Issue
 You might select multiple topics, delete the rest:
 - Compilation/installation error
 - Execution error
@@ -32,12 +34,12 @@ You might select multiple topics, delete the rest:
 
 
 
-### Your system configuration
+### Your System Configuration
 **Operating system** (`lsb_release -a` in Ubuntu):
+**Installation mode**: CMake, sh script, or manual Makefile installation (Ubuntu); VS2015, VS2017, CMake, ... (Windows)
 **CUDA version** (`cat /usr/local/cuda/version.txt` in most cases):
 **cuDNN version**:
 **GPU model** (`nvidia-smi` in Ubuntu):
 **Caffe version**: Default from OpenPose or custom version.
-**OpenCV version**: installed with `apt-get install libopencv-dev` (Ubuntu) or default from OpenPose (Windows) or OpenCV 2.X or OpenCV 3.X. Especify **full version** (e.g. 3.1 or 2.4.9)
-Generation mode (only for Ubuntu): Makefile + Makefile.config (default, Ubuntu) or CMake (Ubuntu, Windows) or Visual Studio (Windows).
+**OpenCV version**: pre-compiled `apt-get install libopencv-dev` (only Ubuntu); OpenPose default (only Windows); compiled from source: 2.4.9, 2.4.12, 3.1, 3.2, ...
 Compiler (`gcc --version` in Ubuntu):

.gitignore

@@ -58,6 +58,12 @@ MANIFEST-*
 # OSX dir files
 .DS_Store
 
+# Vim files
+cscope.*
+tags
+.clang_complete
+.vim
+
 ######################### Windows (Visual Studio) Files #########################
 *.db
 *.deps
@@ -83,7 +89,8 @@ Makefile.config
 # Data and models are either
 	# 1. reference, and not casually committed
 	# 2. custom, and live on their own unless they're deliberated contributed
-3rdparty/caffe/.*
+3rdparty/caffe/.git
+3rdparty/caffe/.github
 distribute/
 .build_release/
 .build_debug/

.travis.yml

@@ -0,0 +1,46 @@
+# This will run on Travis' 'new' container-based infrastructure
+
+# Blacklist
+branches:
+  only:
+    - master
+
+# OS
+dist: trusty 
+sudo: required
+
+# Environment variables
+env:
+  global:
+    - GH_REPO_NAME: openpose
+    - DOXYFILE: $TRAVIS_BUILD_DIR/doc/doc_autogeneration.doxygen
+    # Set this in Environment Variables on travis-ci.org
+    # - GH_REPO_REF: github.com/<user_name>/openpose.git
+
+# Install dependencies
+addons:
+  apt:
+    packages:
+      - doxygen
+      - doxygen-doc
+      - doxygen-latex
+      - doxygen-gui
+      - graphviz
+
+# Build your code e.g. by calling make
+script:
+  - ./ubuntu/install_cmake.sh
+  - sudo apt-get -y install libatlas-base-dev
+  - sudo apt-get -y install libopencv-dev
+  - pip install --upgrade numpy
+  - mkdir build
+  - cd build
+  - cmake -DBUILD_CAFFE=ON -DDOWNLOAD_COCO_MODEL=OFF -DDOWNLOAD_FACE_MODEL=OFF -DDOWNLOAD_HAND_MODEL=OFF -DDOWNLOAD_MPI_MODEL=OFF ..
+  - no_cores=`cat /proc/cpuinfo | grep processor | wc -l`
+  - make -j${no_cores}
+
+# Generate and deploy documentation
+after_success:
+  - cd $TRAVIS_BUILD_DIR
+  - chmod +x .github/generate_gh_pages.sh
+  - ./.github/generate_gh_pages.sh

3rdparty/Versions.txt

@@ -1,6 +1,6 @@
 Unix:
     - Caffe:
-        - Version 1.0.0, extracted from GitHub on 08/20/2017 from the current master branch.
+        - Version 1.0.0, extracted from GitHub on 09/30/2017 from the current master branch.
         - Link: https://github.com/BVLC/caffe
 
 Windows: