Merge pull request #883 from rizar/release-0.1

Release 0.1

.scrutinizer.yml

@@ -5,9 +5,9 @@ build:
   tests:
     override:
       - flake8 --filename=* bin
-      - flake8 blocks doctests tests examples
+      - flake8 blocks doctests tests
       - pep257 bin --numpy --ignore=D100,D101,D102,D103 --match='.*'
-      - pep257 blocks examples --numpy --ignore=D100,D101,D102,D103
+      - pep257 blocks --numpy --ignore=D100,D101,D102,D103
       - pep257 doctests tests --numpy --ignore=D100,D101,D102,D103 --match='.*\.py'
 checks:
     python:

.travis.yml

@@ -7,12 +7,20 @@ branches:
     - master
     - stable
 language: python
-python:
-  - "2.7"
-  - "3.4"
-env:
-  - TESTS=float32
-  - TESTS=float64
+matrix:
+  include:
+    - python: 2.7
+      env: TESTS=blocks FLOATX=float32
+    - python: 2.7
+      env: TESTS=blocks FLOATX=float32 DB=sqlite
+    - python: 3.4
+      env: TESTS=blocks FLOATX=float64
+    - python: 2.7
+      env: TESTS=blocks-examples FLOATX=float32
+    - python: 2.7
+      env: TESTS=blocks-examples FLOATX=float32 DB=sqlite
+    - python: 3.4
+      env: TESTS=blocks-examples FLOATX=float64
 before_install:
   - # Setup Python environment with BLAS libraries
   - wget -q http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
@@ -23,26 +31,34 @@ before_install:
   - export FUEL_DATA_PATH=$TRAVIS_BUILD_DIR/data
 install:
   # Install all Python dependencies
-  - conda install -q --yes python=$TRAVIS_PYTHON_VERSION mkl --file req-travis-conda.txt
+  - conda install -q --yes python=$TRAVIS_PYTHON_VERSION --file req-travis-conda.txt
   - pip install -q -r req-travis-pip.txt
 script:
-  - pip install . -r requirements.txt # Tests setup.py
-  - |
-      if [ ! -f $FUEL_DATA_PATH/mnist.hdf5 ]; then
-        cd $FUEL_DATA_PATH
-        fuel-download mnist
-        fuel-convert mnist
-        fuel-download --clear mnist
-        cd -
-      fi
+  - pip install -e . -r requirements.txt # Tests setup.py
+  - curl https://raw.githubusercontent.com/mila-udem/fuel/master/.travis-data.sh | bash -s -- mnist
   - # Must export environment variable so that the subprocess is aware of it
-  - export THEANO_FLAGS=floatX=$TESTS,optimizer=fast_compile
-  - export FUEL_FLOATX=$TESTS
-  - export BLOCKS_PROFILE=true
+  - export THEANO_FLAGS=floatX=$FLOATX,optimizer=fast_compile
+  - export FUEL_FLOATX=$FLOATX
+  - "if [[ $DB == 'sqlite' ]]; then echo 'log_backend: sqlite' > ~/.blocksrc; fi"
   - # Running nose2 within coverage makes imports count towards coverage
-  - bokeh-server &> /dev/null &
-  - coverage run -p --source=blocks -m nose2.__main__ -v doctests
-  - coverage run -p --source=blocks -m nose2.__main__ -v tests
+  - function fail { export FAILED=1; }
+  - |
+      if [[ $TESTS == 'blocks' ]]; then
+        coverage run -p --source=blocks -m nose2.__main__ -v doctests || fail
+        export THEANO_FLAGS=$THEANO_FLAGS,cxx=
+        coverage run -p --source=blocks -m nose2.__main__ -v tests || fail
+        return $FAILED
+      fi
+  - |
+      if [[ $TESTS == 'blocks-examples' ]]; then
+        cd $TRAVIS_BUILD_DIR
+        git clone https://github.com/mila-udem/blocks-examples.git
+        cd blocks-examples
+        nose2 tests
+      fi
 after_script:
-  - coverage combine
-  - coveralls
+  - |
+      if [[ $TESTS == 'blocks' ]]; then
+        coverage combine
+        coveralls
+      fi

CONTRIBUTING.rst

@@ -18,7 +18,7 @@ few steps to help you get started:
 
 GitHub crash course
   If you're new to GitHub, be sure to check out our `quick reference`_ to the
-  pull-request worklow, which will show you how to fork Blocks, create a new
+  pull-request workflow, which will show you how to fork Blocks, create a new
   branch, and make a pull-request of your changes.
 
 Writing documentation
@@ -34,6 +34,11 @@ Formatting guidelines
 Code guidelines
   If you're going to write a lot of code, have a read through our `coding
   guidelines`_.
+
+License
+  Blocks is licensed under the `MIT license`_, with portions licensed under
+  the 3-clause BSD license. By contributing you agree to license your
+  contributions under the MIT license.
 
 Questions about using Blocks?
 =============================
@@ -50,3 +55,4 @@ already.
 .. _PEP 8: https://www.python.org/dev/peps/pep-0008/
 .. _NumPy docstring standard: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
 .. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html
+.. _MIT license: https://raw.githubusercontent.com/mila-udem/blocks/master/LICENSE

README.rst

@@ -33,9 +33,25 @@ In the future we also hope to support:
 
 * Dimension, type and axes-checking
 
-Please see the documentation_ for more information.
-
-If you want to contribute, please make sure to read the `developer guidelines`_.
+See Also:
+   * `Fuel`_, the data processing engine developed primarily for Blocks.
+   * `Blocks-examples`_ for maintained examples of scripts using Blocks.
+   * `Blocks-extras`_ for semi-maintained additional Blocks components.
+
+Citing Blocks
+   If you use Blocks or Fuel in your work, we'd really appreciate it if you could cite the following paper:
+
+   Bart van Merriënboer, Dzmitry Bahdanau, Vincent Dumoulin, Dmitriy Serdyuk, David Warde-Farley, Jan Chorowski, and Yoshua Bengio, "`Blocks and Fuel: Frameworks for deep learning`_," *arXiv preprint arXiv:1506.00619 [cs.LG]*, 2015.
+
+Documentation
+   Please see the documentation_ for more information.
+
+Contributing
+   If you want to contribute, please make sure to read the `developer guidelines`_.
 
 .. _documentation: http://blocks.readthedocs.org
 .. _developer guidelines: http://blocks.readthedocs.org/en/latest/development/index.html
+.. _Blocks and Fuel\: Frameworks for deep learning: http://arxiv.org/abs/1506.00619
+.. _Blocks-examples: https://github.com/mila-udem/blocks-examples 
+.. _Blocks-extras: https://github.com/mila-udem/blocks-extras
+.. _Fuel: https://github.com/mila-udem/fuel

bin/blocks-continue

@@ -2,7 +2,7 @@
 import logging
 from argparse import ArgumentParser
 
-from blocks.scripts import continue_training
+from blocks.serialization import continue_training
 
 if __name__ == "__main__":
     logging.basicConfig()

blocks/__init__.py

@@ -1,4 +1,5 @@
 """The blocks library for parametrized Theano ops."""
 # Scary warning: Adding code to this file can break namespace packages
 # See https://pythonhosted.org/setuptools/setuptools.html#namespace-packages
+__import__("pkg_resources").declare_namespace(__name__)
 __version__ = '0.0.1'