Merge pull request #258 from rizar/release-0.1

Release 0.1

.coveragerc

@@ -0,0 +1,3 @@
+[report]
+omit =
+    fuel/bin/*

.gitignore

@@ -52,3 +52,7 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# Editors
+*~
+*.sw[op]

.travis-data.sh

@@ -5,9 +5,9 @@ set -ev
 
 function download {
   if [ ! -f $FUEL_DATA_PATH/$1.hdf5 ]; then
-    fuel-download $1
-    fuel-convert $1
-    fuel-download $1 --clear
+    fuel-download $@
+    fuel-convert $@
+    fuel-download $@ --clear
   fi
 }
 

.travis.yml

@@ -26,29 +26,33 @@ install:
   - |
       if [[ $TESTS == 'blocks' ]]; then
         curl -O https://raw.githubusercontent.com/mila-udem/blocks/$TRAVIS_BRANCH/req-travis-conda.txt
-        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 -r https://raw.githubusercontent.com/mila-udem/blocks/$TRAVIS_BRANCH/req-travis-pip.txt
         pip install -e git+git://github.com/mila-udem/blocks.git@$TRAVIS_BRANCH#egg=blocks --src=$HOME -r https://raw.githubusercontent.com/mila-udem/blocks/$TRAVIS_BRANCH/requirements.txt
       fi
   - |
       if [[ $TESTS == 'fuel' ]]; then
-        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 -r req-travis-pip.txt
+        pip install . -r requirements.txt # Installs the fuel-download command needed by .travis-data.sh
+        python setup.py build_ext --inplace
       fi
 script:
-  - pip install . -r requirements.txt
-  - ./.travis-data.sh mnist binarized_mnist cifar10
+  - ./.travis-data.sh adult mnist binarized_mnist "caltech101_silhouettes 16" cifar10 cifar100 iris
+  - function fail { export FAILED=1; }
   - |
       if [[ $TESTS == 'blocks' ]]; then
         bokeh-server &> /dev/null &
-        nose2 tests --start-dir $HOME/blocks
-        nose2 doctests --start-dir $HOME/blocks
+        nose2 tests --start-dir $HOME/blocks || fail
+        nose2 doctests --start-dir $HOME/blocks || fail
+        return $FAILED
       fi
   - |
       if [[ $TESTS == 'fuel' ]]; then
         # Running nose2 within coverage makes imports count towards coverage
-        coverage run -p --source=fuel -m nose2.__main__ -v tests
-        coverage run -p --source=fuel -m nose2.__main__ -v doctests
+        coverage run -p --source=fuel -m nose2.__main__ -v tests || fail
+        coverage run -p --source=fuel -m nose2.__main__ -v doctests || fail
+        return $FAILED
       fi
 after_script:
   - |

README.rst

@@ -30,6 +30,17 @@ Fuel is developed primarily for use by Blocks_, a Theano toolkit that helps you
 
 If you have questions, don't hesitate to write to the `mailing list`_.
 
+Citing Fuel
+   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.
+
+
 .. _picklable_itertools: http://github.com/dwf/picklable_itertools
 .. _Blocks: http://github.com/mila-udem/blocks
 .. _mailing list: https://groups.google.com/d/forum/fuel-users
+.. _documentation: http://fuel.readthedocs.org/en/latest/
+.. _Blocks and Fuel\: Frameworks for deep learning: http://arxiv.org/abs/1506.00619

docs/api/converters.rst

@@ -0,0 +1,75 @@
+Converters
+==========
+
+Base classes
+------------
+
+.. automodule:: fuel.converters.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Adult
+-----
+
+.. automodule:: fuel.converters.adult
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+CalTech 101 Silhouettes
+-----------------------
+
+.. automodule:: fuel.converters.caltech101_silhouettes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Binarized MNIST
+---------------
+
+.. automodule:: fuel.converters.binarized_mnist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+CIFAR100
+--------
+
+.. automodule:: fuel.converters.cifar100
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+CIFAR10
+-------
+
+.. automodule:: fuel.converters.cifar10
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+IRIS
+----
+
+.. automodule:: fuel.converters.iris
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+MNIST
+-----
+
+.. automodule:: fuel.converters.mnist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+SVHN
+----
+
+.. automodule:: fuel.converters.svhn
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/api/toy-datasets.rst → docs/api/data_streams.rst

@@ -1,8 +1,7 @@
-Toy datasets 
+Data streams
 ============
 
-.. automodule:: fuel.datasets.toy
+.. automodule:: fuel.streams
     :members:
     :undoc-members:
     :show-inheritance:
-

docs/api/dataset.rst

@@ -0,0 +1,99 @@
+Datasets
+========
+
+Base classes
+------------
+
+.. automodule:: fuel.datasets.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Adult
+-----
+
+.. automodule:: fuel.datasets.adult
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+One Billion Word
+----------------
+
+.. automodule:: fuel.datasets.billion
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+CalTech 101 Silhouettes
+-----------------------
+
+.. automodule:: fuel.datasets.caltech101_silhouettes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Binarized MNIST
+---------------
+
+.. automodule:: fuel.datasets.binarized_mnist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+CIFAR100
+--------
+
+.. automodule:: fuel.datasets.cifar100
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+CIFAR10
+-------
+
+.. automodule:: fuel.datasets.cifar10
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+IRIS
+----
+
+.. automodule:: fuel.datasets.iris
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+MNIST
+-----
+
+.. automodule:: fuel.datasets.mnist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+SVHN
+----
+
+.. automodule:: fuel.datasets.svhn
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Text-based datasets
+-------------------
+
+.. automodule:: fuel.datasets.text
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Toy datasets
+------------
+
+.. automodule:: fuel.datasets.toy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+