NSF Grant

.gitignore

@@ -16,7 +16,7 @@ downloads/
 eggs/
 .eggs/
 lib/
-lib64/
+lib64
 parts/
 sdist/
 var/
@@ -89,4 +89,20 @@ ENV/
 .ropeproject
 
 # Custom
-.idea/
+.idea/
+log.txt
+pids.txt
+
+# tensorflow model weights
+*.tar.gz
+
+*.dev.*
+*.master.*
+*.bak.*
+*.broke.*
+*.fixed.*
+*.works.*
+
+# Mac OSX
+.DS_Store
+

CONTRIBUTING.md

@@ -0,0 +1,76 @@
+## Style Guide
+
+The primary goal is to produce readable code.
+This means being consistent with patterns and style prefered by most python developers at corporations that build great stuff with python.
+
+
+### [PEP8](https://www.python.org/dev/peps/pep-0008/) with these exceptions
+
+Follow the [Hettinger interpretation of PEP8](https://www.youtube.com/watch?v=wf-BqAjZb8M) for beautiful, readable code.
+
+* max line length is "about" 120 chars (if you go a little over, don't worry about it)
+* max complexity: "mccabe_threshold": 12,  # McCabe complexity checker limits the number of conditional branches
+* type hints are a good idea on conditional branches that are rarely run, but duck-typing is preferred for mainline code
+
+Here's my Sublime Anaconda plugin configuration.
+
+
+```javascript
+{
+    // Maximum McCabe complexity (number of conditional branches within a function).
+    "mccabe_threshold": 7,
+
+    // Maximum line length
+    "pep8_max_line_length": 120
+}
+```
+
+
+### Documentation
+
+Markdown README.md files in any folder containing significant code.
+
+Use [Google/Numpy/Napolean/Markdown](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) docstring syntax, **not** the original ReST dosctring format.
+
+
+#### Example Dosstring
+
+
+```python
+def add(value, num=0):
+    """ Add a float to an integer
+
+    Args:
+        value (float): first number in the sum
+        num (int): the integer to be added
+
+    Returns:
+        float: the sum of `value + num`
+
+    >>> add(1., 2)
+    3.0
+    """
+    pass
+```
+
+
+### Workflow
+
+#### Branch off master
+
+whenever you begin a new feature/task:
+
+`git checkout master -b feature/my-awesome-new-feature`
+
+#### Commit often
+
+Mentioning the Jira ticket number in your, brief, active verb-tense comment (message)
+
+`git commit -am 'NSF-4 #start-review integrate location into description'`
+
+#### Transition your Jira Tickets
+
+Whenever you can, so save yourself the Jira GUI shuffle. But send it to "#start-review" (the QA stage) rather than #done:
+
+`git commit -am 'NSF-4 #start-review add color vectors'`
+

Jenkinsfile

@@ -0,0 +1,114 @@
+#!/usr/bin/env groovy
+
+pipeline {
+
+    /* Create instance (Agent) to run Jenkins pipeline on
+
+    Section creates a docker container with anaconda installed on it for jenkins pipeline to run on. Arguments work
+    as follows:
+        `-u 0` user ID, which has root value. Good reference about docker UID/GIDs (https://goo.gl/bYFxVh)
+        `--rm` If a docker container with the same name already exists, remove it
+        `--name ai-conda` Give this docker instance the name `ai-conda`
+        `-v _:_` map volumes. Specifically, map `passwd`, `group` and the conda packages volumes to the container
+    */
+    agent {
+        docker {
+            image 'continuumio/miniconda3'
+            args '-u 0 --rm --name ai-conda -v /etc/passwd:/etc/passwd -v /etc/group:/etc/group -v /home/jenkins/.conda3/pkgs:/home/jenkins/.conda/pkgs:rw,z'
+        }
+    }
+
+    stages {
+        stage('Checkout') {
+            steps {
+                checkout scm
+            }
+        }
+
+        stage('Test') {
+            environment {
+                CONDA_ENV = "${env.WORKSPACE}/test/${env.STAGE_NAME}"
+            }
+            steps {
+                /* Recreate a conda environment from the config file
+
+                    `-q` quite mode. Remove to see verbose output
+                    `--force` remove previously existing environment of the same name
+                    `-f FILE` environment definition file
+                    `-p PATH` Full path to environment prefix (replacing default)
+                 */
+                sh 'conda env create -q --force -f environment.yml -p $CONDA_ENV'
+
+                /*  Activate the environment and run unit tests
+
+                    `source ...` activate the environment
+                    `python -m pytest` run `pytest` as a module
+                    `python -m unittest...` run `unittest` on the `object_detection` directory, pattern matching all of
+                        the files that end in `_test.py`
+
+                 */
+                sh '''#!/bin/bash -ex
+                    source $CONDA_ENV/bin/activate $CONDA_ENV
+                    python -m pytest
+                    python -m unittest discover -s object_detection -p "*_test.py"
+                '''
+
+            }
+        }
+
+        /*
+        stage('Deploy - Staging'){
+            when {
+                expression {
+                    currentBuild.result == null || currentBuild.result == 'SUCCESS'
+                }
+            }
+            steps {
+                echo 'Placeholder: Deploying to staging/dev'
+            }
+        }
+
+        stage('Sanity check') {
+            steps {
+                input "Does the staging env look good? Good enough to deploy into production?"
+            }
+        }
+
+        stage('Deploy - Production') {
+            steps {
+                echo 'Placeholder: Deploying to prod'
+            }
+        }
+        */
+    }
+
+    /* TODO(Alex): Fix Slack Notifications. */
+    post {
+        always {
+            echo 'The job has finished.'
+            slackSend channel: '#ai-nsf-jenkins-jobs',
+                color: 'good',
+                message: "The pipeline ${currentBuild.fillDisplayName} completed."
+        }
+        success {
+            slackSend channel: '#ai-nsf-jenkins-jobs',
+                color: 'good',
+                message: "The pipeline ${currentBuild.fillDisplayName} completed successfully."
+        }
+        unstable {
+            slackSend channel: '#ai-nsf-jenkins-jobs',
+                color: 'warning',
+                message: "The pipeline ${currentBuild.fillDisplayName} is unstable. Check it out here: ${env.BUILD_URL}"
+        }
+        failure {
+            slackSend channel: '#ai-nsf-jenkins-jobs',
+                color: 'danger',
+                message: "@all The pipeline ${currentBuild.fillDisplayName} has failed! Check it out here: ${env.BUILD_URL}"
+        }
+        /*
+        changed {
+
+        }
+        */
+    }
+}

Makefile

@@ -0,0 +1,112 @@
+.PHONY: clean lint build
+
+#################################################################################
+# GLOBALS                                                                       #
+#################################################################################
+
+
+PROJECT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+PROJECT_NAME = object-detection
+PYTHON_INTERPRETER = python
+
+ifeq (,$(shell which conda))
+HAS_CONDA=False
+else
+HAS_CONDA=True
+endif
+
+
+#################################################################################
+# COMMANDS                                                                      #
+#################################################################################
+
+## Delete all compiled Python files
+clean:
+	find . -name "*.pyc" -exec rm {} \;
+
+## Lint using flake8
+lint:
+	$(PYTHON_INTERPRETER) -m flake8 --exclude=lib/,bin/,docs/conf.py --ignore F401,H301,E203,E241 .
+
+## Set up python interpreter environment
+create_env:
+ifeq (True,$(HAS_CONDA))
+		@echo ">>> Detected conda, creating conda environment."
+		conda env create -f environment.yml
+		@echo ">>> New conda env created. Activate with:\nsource activate $(PROJECT_NAME)"
+else
+		@echo "Error: Install conda"
+endif
+
+delete_env:
+	conda env remove -y -n object-detection
+
+
+## Build (Get interpreter running)
+## TODO
+
+## Run project tests
+test:
+	pytest -vs utils/
+	$(PYTHON_INTERPRETER) -m unittest discover -s object_detection -p "*_test.py"
+
+#################################################################################
+# Self Documenting Commands                                                     #
+#################################################################################
+
+.DEFAULT_GOAL := show-help
+
+# Inspired by <http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html>
+# sed script explained:
+# /^##/:
+# 	* save line in hold space
+# 	* purge line
+# 	* Loop:
+# 		* append newline + line to hold space
+# 		* go to next line
+# 		* if line starts with doc comment, strip comment character off and loop
+# 	* remove target prerequisites
+# 	* append hold space (+ newline) to line
+# 	* replace newline plus comments by `---`
+# 	* print line
+# Separate expressions are necessary because labels cannot be delimited by
+# semicolon; see <http://stackoverflow.com/a/11799865/1968>
+.PHONY: show-help
+show-help:
+	@echo "$$(tput bold)Available rules:$$(tput sgr0)"
+	@echo
+	@sed -n -e "/^## / { \
+		h; \
+		s/.*//; \
+		:doc" \
+		-e "H; \
+		n; \
+		s/^## //; \
+		t doc" \
+		-e "s/:.*//; \
+		G; \
+		s/\\n## /---/; \
+		s/\\n/ /g; \
+		p; \
+	}" ${MAKEFILE_LIST} \
+	| LC_ALL='C' sort --ignore-case \
+	| awk -F '---' \
+		-v ncol=$$(tput cols) \
+		-v indent=19 \
+		-v col_on="$$(tput setaf 6)" \
+		-v col_off="$$(tput sgr0)" \
+	'{ \
+		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
+		n = split($$2, words, " "); \
+		line_length = ncol - indent; \
+		for (i = 1; i <= n; i++) { \
+			line_length -= length(words[i]) + 1; \
+			if (line_length <= 0) { \
+				line_length = ncol - indent - length(words[i]) - 1; \
+				printf "\n%*s ", -indent, " "; \
+			} \
+			printf "%s ", words[i]; \
+		} \
+		printf "\n"; \
+	}' \
+| more $(shell test $(shell uname) = Darwin && echo '--no-init --raw-control-chars')