Makefile

# ----------------------------------------------------------------------------
# Copyright 2014 Nervana Systems Inc.  All rights reserved
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ----------------------------------------------------------------------------
# Top-level control of the building/installation/cleaning of various targets

# these variables control the type of build, use -e to override their default
# values, which are defined in setup.cfg
DEV := $(strip $(shell grep -i '^ *DEV *=' setup.cfg | cut -f 2 -d '='))
CPU := $(strip $(shell grep -i '^ *CPU *=' setup.cfg | cut -f 2 -d '='))
GPU := $(strip $(shell grep -i '^ *GPU *=' setup.cfg | cut -f 2 -d '='))

# get release version info
RELEASE := $(strip $(shell grep '^VERSION *=' setup.py | cut -f 2 -d '=' \
	                   | tr -d "\'"))

# these variables control where we publish Sphinx docs to (additional ones
# are assumed to be set in the environment)
DOC_DIR := doc
DOC_PUB_RELEASE_PATH := $(DOC_PUB_PATH)/$(RELEASE)

# these control test options and attribute filters
NOSE_FLAGS := ""  # --pdb --pdb-failures
NOSE_ATTRS := -a '!slow'

# ensure a cuda capable GPU is installed
ifeq ($(GPU), 1)
  override GPU := cudanet
endif
ifneq ($(GPU), 0)
  ifeq ($(shell uname -s), Darwin)
    ifneq ($(shell kextstat | grep -i cuda > /dev/null 2>&1; echo $$?), 0)
      $(info No CUDA capable GPU installed on OSX.  Forcing GPU=0)
      override GPU := 0
    endif
  else
    # we assume a Linux-like OS
    ifneq ($(shell nvcc --version > /dev/null 2>&1; echo $$?), 0)
      $(info No CUDA capable GPU installed.  Forcing GPU=0)
      override GPU := 0
    endif
  endif
endif

# update options based on build type
INSTALL_REQUIRES :=
ifeq ($(DEV), 0)
  NOSE_ATTRS := $(NOSE_ATTRS),'!dev'
else
  INSTALL_REQUIRES := $(INSTALL_REQUIRES) 'nose>=1.3.0' 'Pillow>=2.5.0' \
    'flake8>=2.2.2' 'pep8-naming>=0.2.2' 'sphinx>=1.2.2' 'posix_ipc>=1.0.0' \
    'sphinxcontrib-napoleon>=0.2.8' 'scikit-learn>=0.15.2' 'matplotlib>=1.4.0' \
		'pika>=0.9.14' \
    'git+https://github.com/NervanaSystems/imgworker.git\#egg=imgworker>=0.2.5'
endif
ifeq ($(GPU), 0)
  NOSE_ATTRS := $(NOSE_ATTRS),'!cuda'
else
  ifeq ($(GPU), cudanet)
    INSTALL_REQUIRES := $(INSTALL_REQUIRES) \
      'git+https://github.com/NervanaSystems/cuda-convnet2.git\#egg=cudanet>=0.2.7' \
      'pycuda>=2015.1'
  endif
  ifeq ($(GPU), nervanagpu)
    INSTALL_REQUIRES := $(INSTALL_REQUIRES) \
      'git+https://github.com/NervanaSystems/nervanagpu.git\#egg=nervanagpu>=0.3.3'
  endif
endif

.PHONY: default build develop install uninstall test test_all sanity speed \
	      grad all clean_pyc clean doc html style lint bench dist publish_doc \
	      release serialize integration

default: build

build: clean_pyc
	@echo "Running build(DEV=$(DEV) CPU=$(CPU) GPU=$(GPU))..."
	@python setup.py neon --dev $(DEV) --cpu $(CPU) --gpu $(GPU) build

pip_check:
ifeq (, $(shell which pip))
  ifeq ($(shell uname -s), Darwin)
		$(error pip command not found.  On OSX we recommend separately installing \
			python 2.7.9 or later which includes pip. See \
			https://www.python.org/downloads/)
  else
		$(error pip command not found.  Please ensure pip is installed. \
			Ubuntu/Debian Linux: sudo apt-get install python-pip \
			RedHat/CentOS Linux: sudo yum install python-pip)
  endif
endif

# unfortunately there is no way to communicate custom commands into pip
# install, hence having to specify installation requirements twice (once
# above, and once inside setup.py). Ugly kludge, but seems like the only way
# to support both python setup.py install and pip install.
# Since numpy is required for building some of the other dependent packages
# we need to separately install it first
deps_install: clean_pyc pip_check
	@pip install 'numpy>=1.8.1' 'PyYAML>=3.11'
ifdef INSTALL_REQUIRES
	@pip install $(INSTALL_REQUIRES)
endif

develop: deps_install
	@echo "Running develop(DEV=$(DEV) CPU=$(CPU) GPU=$(GPU))..."
	@pip install -e .

install: deps_install
	@echo "Running install(DEV=$(DEV) CPU=$(CPU) GPU=$(GPU))..."
	@pip install .

uninstall: pip_check
	@echo "Running uninstall..."
	@pip uninstall -y neon

test: build
	@echo "Running unit tests..."
	nosetests $(NOSE_ATTRS) $(NOSE_FLAGS) neon

test_all:
	@echo "Running test_all..."
	@tox -- -e CPU=$(CPU) GPU=$(GPU)

integration: build
	@echo "Running integration checks (this may take 10-20 minutes)..."
	@examples/run_integration_tests.sh

serialize: build
	@echo "Running serialize checks..."
	nosetests neon/tests/test_serialize.py
    
sanity: build
	@echo "Running sanity checks..."
	@PYTHONPATH=${PYTHONPATH}:./ python neon/tests/sanity_check.py \
		--cpu $(CPU) --gpu $(GPU)

speed: build
	@echo "Running speed checks..."
	@PYTHONPATH=${PYTHONPATH}:./ python neon/tests/speed_check.py \
		--cpu $(CPU) --gpu $(GPU)

grad: build
	@echo "Running gradient checks..."
ifeq ($(CPU), 1)
	@echo "CPU:"
	@PYTHONPATH=${PYTHONPATH}:./ bin/grad \
		examples/convnet/synthetic-sanity_check.yaml
endif
ifneq ($(GPU), 0)
	@echo "GPU:"
	@PYTHONPATH=${PYTHONPATH}:./ bin/grad --gpu $(GPU) \
		examples/convnet/synthetic-sanity_check.yaml
endif

all: style test sanity grad speed

clean_pyc:
	@-find . -name '*.py[co]' -exec rm {} \;

clean:
	-python setup.py clean

doc: build
	$(MAKE) -C $(DOC_DIR) clean
	$(MAKE) -C $(DOC_DIR) html

html: doc

style:
	@-flake8 --exclude=.tox,build,dist,src .

lint:
	@-pylint --output-format=colorized neon

bench: build
	@PYTHONPATH="." benchmarks/run_benchmarks.py

dist:
	@python setup.py sdist

publish_doc: doc
ifneq (,$(DOC_PUB_HOST))
	@-cd $(DOC_DIR)/build/html && \
		rsync -avz -essh --perms --chmod=ugo+rX . \
		$(DOC_PUB_USER)@$(DOC_PUB_HOST):$(DOC_PUB_RELEASE_PATH)
	@-ssh $(DOC_PUB_USER)@$(DOC_PUB_HOST) \
		'rm -f $(DOC_PUB_PATH)/latest && \
		 ln -sf $(DOC_PUB_RELEASE_PATH) $(DOC_PUB_PATH)/latest'
else
	@echo "Can't publish.  Ensure DOC_PUB_HOST, DOC_PUB_USER, DOC_PUB_PATH set"
endif

release: publish_doc
	@gitchangelog > ChangeLog