{"action":"created","comment":{"url":"https://api.github.com/repos/mila-udem/fuel/pulls/comments/35381029","id":35381029,"diff_hunk":"@@ -0,0 +1,106 @@\n+Installation\n+============\n+\n+The easiest way to install Fuel is using the Python package manager pip. Fuel\n+isn't listed yet on the Python Package Index (PyPI), so you will have to grab it\n+directly from GitHub.\n+\n+.. code-block:: bash\n+\n+   $ pip install git+git://github.com/mila-udem/fuel.git\n+\n+This will give you the cutting-edge development version. The latest stable\n+release is in the ``stable`` branch and can be installed as follows.\n+\n+.. code-block:: bash\n+\n+   $ pip install git+git://github.com/mila-udem/fuel.git@stable\n+\n+If you don't have administrative rights, add the ``--user`` switch to the\n+install commands to install the packages in your home folder. If you want to\n+update Fuel, simply repeat the first command with the ``--upgrade`` switch\n+added to pull the latest version from GitHub.\n+\n+.. warning::\n+\n+   Pip may try to install or update NumPy and SciPy if they are not present or\n+   outdated. However, pip's versions might not be linked to an optimized BLAS\n+   implementation. To prevent this from happening make sure you update NumPy\n+   and SciPy using your system's package manager (e.g.  ``apt-get`` or\n+   ``yum``), or use a Python distribution like Anaconda_, before installing\n+   Fuel. You can also pass the ``--no-deps`` switch and install all the\n+   requirements manually.\n+\n+   If the installation crashes with ``ImportError: No module named\n+   numpy.distutils.core``, install NumPy and try again again.\n+\n+\n+Requirements\n+------------\n+Fuel's requirements are\n+\n+* PyYAML_, to parse the configuration file\n+* six_, to support both Python 2 and 3 with a single codebase\n+* h5py_ and PyTables_ for the HDF5 storage back-end\n+* pillow_, providing PIL for image preprocessing\n+* Cython_, for fast extensions\n+* pyzmq_, to send data across processes\n+* picklable_itertools_, for picklable iterators\n+* SciPy_, to read from MatLab's .mat format\n+* requests_, to download canonical datasets\n+\n+.. _Anaconda: https://store.continuum.io/cshop/anaconda/\n+.. _nose2: https://nose2.readthedocs.org/","path":"docs/setup.rst","position":53,"original_position":53,"commit_id":"c8e4ef82cd7dba92c85cb8d115e4c7aaff162c4d","original_commit_id":"c8e4ef82cd7dba92c85cb8d115e4c7aaff162c4d","user":{"login":"dwf","id":60206,"avatar_url":"https://avatars.githubusercontent.com/u/60206?v=3","gravatar_id":"","url":"https://api.github.com/users/dwf","html_url":"https://github.com/dwf","followers_url":"https://api.github.com/users/dwf/followers","following_url":"https://api.github.com/users/dwf/following{/other_user}","gists_url":"https://api.github.com/users/dwf/gists{/gist_id}","starred_url":"https://api.github.com/users/dwf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dwf/subscriptions","organizations_url":"https://api.github.com/users/dwf/orgs","repos_url":"https://api.github.com/users/dwf/repos","events_url":"https://api.github.com/users/dwf/events{/privacy}","received_events_url":"https://api.github.com/users/dwf/received_events","type":"User","site_admin":false},"body":"You don't mention this anywhere. Probably best to say it's optional \"to run the tests\".","created_at":"2015-07-23T22:53:10Z","updated_at":"2015-07-23T22:53:10Z","html_url":"https://github.com/mila-udem/fuel/pull/200#discussion_r35381029","pull_request_url":"https://api.github.com/repos/mila-udem/fuel/pulls/200","_links":{"self":{"href":"https://api.github.com/repos/mila-udem/fuel/pulls/comments/35381029"},"html":{"href":"https://github.com/mila-udem/fuel/pull/200#discussion_r35381029"},"pull_request":{"href":"https://api.github.com/repos/mila-udem/fuel/pulls/200"}}},"pull_request":{"url":"https://api.github.com/repos/mila-udem/fuel/pulls/200","id":40621854,"html_url":"https://github.com/mila-udem/fuel/pull/200","diff_url":"https://github.com/mila-udem/fuel/pull/200.diff","patch_url":"https://github.com/mila-udem/fuel/pull/200.patch","issue_url":"https://api.github.com/repos/mila-udem/fuel/issues/200","number":200,"state":"open","locked":false,"title":"Add installation doc","user":{"login":"lamblin","id":178249,"avatar_url":"https://avatars.githubusercontent.com/u/178249?v=3","gravatar_id":"","url":"https://api.github.com/users/lamblin","html_url":"https://github.com/lamblin","followers_url":"https://api.github.com/users/lamblin/followers","following_url":"https://api.github.com/users/lamblin/following{/other_user}","gists_url":"https://api.github.com/users/lamblin/gists{/gist_id}","starred_url":"https://api.github.com/users/lamblin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lamblin/subscriptions","organizations_url":"https://api.github.com/users/lamblin/orgs","repos_url":"https://api.github.com/users/lamblin/repos","events_url":"https://api.github.com/users/lamblin/events{/privacy}","received_events_url":"https://api.github.com/users/lamblin/received_events","type":"User","site_admin":false},"body":"Should fix #104, at least in part.\r\n\r\nThese instructions will use the latest version of picklable-itertools on PyPI, rather than the latest GitHub one. This seems to work fine at the moment, but I can change that if needed.","created_at":"2015-07-22T23:06:36Z","updated_at":"2015-07-23T22:53:10Z","closed_at":null,"merged_at":null,"merge_commit_sha":"326f1301b35ad24b4c0c52dd865397c3de90010c","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/mila-udem/fuel/pulls/200/commits","review_comments_url":"https://api.github.com/repos/mila-udem/fuel/pulls/200/comments","review_comment_url":"https://api.github.com/repos/mila-udem/fuel/pulls/comments{/number}","comments_url":"https://api.github.com/repos/mila-udem/fuel/issues/200/comments","statuses_url":"https://api.github.com/repos/mila-udem/fuel/statuses/c8e4ef82cd7dba92c85cb8d115e4c7aaff162c4d","head":{"label":"lamblin:install_doc","ref":"install_doc","sha":"c8e4ef82cd7dba92c85cb8d115e4c7aaff162c4d","user":{"login":"lamblin","id":178249,"avatar_url":"https://avatars.githubusercontent.com/u/178249?v=3","gravatar_id":"","url":"https://api.github.com/users/lamblin","html_url":"https://github.com/lamblin","followers_url":"https://api.github.com/users/lamblin/followers","following_url":"https://api.github.com/users/lamblin/following{/other_user}","gists_url":"https://api.github.com/users/lamblin/gists{/gist_id}","starred_url":"https://api.github.com/users/lamblin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lamblin/subscriptions","organizations_url":"https://api.github.com/users/lamblin/orgs","repos_url":"https://api.github.com/users/lamblin/repos","events_url":"https://api.github.com/users/lamblin/events{/privacy}","received_events_url":"https://api.github.com/users/lamblin/received_events","type":"User","site_admin":false},"repo":{"id":36950735,"name":"fuel","full_name":"lamblin/fuel","owner":{"login":"lamblin","id":178249,"avatar_url":"https://avatars.githubusercontent.com/u/178249?v=3","gravatar_id":"","url":"https://api.github.com/users/lamblin","html_url":"https://github.com/lamblin","followers_url":"https://api.github.com/users/lamblin/followers","following_url":"https://api.github.com/users/lamblin/following{/other_user}","gists_url":"https://api.github.com/users/lamblin/gists{/gist_id}","starred_url":"https://api.github.com/users/lamblin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lamblin/subscriptions","organizations_url":"https://api.github.com/users/lamblin/orgs","repos_url":"https://api.github.com/users/lamblin/repos","events_url":"https://api.github.com/users/lamblin/events{/privacy}","received_events_url":"https://api.github.com/users/lamblin/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/lamblin/fuel","description":"A data pipeline framework for machine learning","fork":true,"url":"https://api.github.com/repos/lamblin/fuel","forks_url":"https://api.github.com/repos/lamblin/fuel/forks","keys_url":"https://api.github.com/repos/lamblin/fuel/keys{/key_id}","collaborators_url":"https://api.github.com/repos/lamblin/fuel/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/lamblin/fuel/teams","hooks_url":"https://api.github.com/repos/lamblin/fuel/hooks","issue_events_url":"https://api.github.com/repos/lamblin/fuel/issues/events{/number}","events_url":"https://api.github.com/repos/lamblin/fuel/events","assignees_url":"https://api.github.com/repos/lamblin/fuel/assignees{/user}","branches_url":"https://api.github.com/repos/lamblin/fuel/branches{/branch}","tags_url":"https://api.github.com/repos/lamblin/fuel/tags","blobs_url":"https://api.github.com/repos/lamblin/fuel/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/lamblin/fuel/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/lamblin/fuel/git/refs{/sha}","trees_url":"https://api.github.com/repos/lamblin/fuel/git/trees{/sha}","statuses_url":"https://api.github.com/repos/lamblin/fuel/statuses/{sha}","languages_url":"https://api.github.com/repos/lamblin/fuel/languages","stargazers_url":"https://api.github.com/repos/lamblin/fuel/stargazers","contributors_url":"https://api.github.com/repos/lamblin/fuel/contributors","subscribers_url":"https://api.github.com/repos/lamblin/fuel/subscribers","subscription_url":"https://api.github.com/repos/lamblin/fuel/subscription","commits_url":"https://api.github.com/repos/lamblin/fuel/commits{/sha}","git_commits_url":"https://api.github.com/repos/lamblin/fuel/git/commits{/sha}","comments_url":"https://api.github.com/repos/lamblin/fuel/comments{/number}","issue_comment_url":"https://api.github.com/repos/lamblin/fuel/issues/comments{/number}","contents_url":"https://api.github.com/repos/lamblin/fuel/contents/{+path}","compare_url":"https://api.github.com/repos/lamblin/fuel/compare/{base}...{head}","merges_url":"https://api.github.com/repos/lamblin/fuel/merges","archive_url":"https://api.github.com/repos/lamblin/fuel/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/lamblin/fuel/downloads","issues_url":"https://api.github.com/repos/lamblin/fuel/issues{/number}","pulls_url":"https://api.github.com/repos/lamblin/fuel/pulls{/number}","milestones_url":"https://api.github.com/repos/lamblin/fuel/milestones{/number}","notifications_url":"https://api.github.com/repos/lamblin/fuel/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/lamblin/fuel/labels{/name}","releases_url":"https://api.github.com/repos/lamblin/fuel/releases{/id}","created_at":"2015-06-05T19:13:43Z","updated_at":"2015-06-05T19:13:43Z","pushed_at":"2015-07-22T22:59:59Z","git_url":"git://github.com/lamblin/fuel.git","ssh_url":"git@github.com:lamblin/fuel.git","clone_url":"https://github.com/lamblin/fuel.git","svn_url":"https://github.com/lamblin/fuel","homepage":null,"size":812,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"mila-udem:master","ref":"master","sha":"a2ad1839fc3360876372fee73c073d5283350e5d","user":{"login":"mila-udem","id":11724251,"avatar_url":"https://avatars.githubusercontent.com/u/11724251?v=3","gravatar_id":"","url":"https://api.github.com/users/mila-udem","html_url":"https://github.com/mila-udem","followers_url":"https://api.github.com/users/mila-udem/followers","following_url":"https://api.github.com/users/mila-udem/following{/other_user}","gists_url":"https://api.github.com/users/mila-udem/gists{/gist_id}","starred_url":"https://api.github.com/users/mila-udem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mila-udem/subscriptions","organizations_url":"https://api.github.com/users/mila-udem/orgs","repos_url":"https://api.github.com/users/mila-udem/repos","events_url":"https://api.github.com/users/mila-udem/events{/privacy}","received_events_url":"https://api.github.com/users/mila-udem/received_events","type":"Organization","site_admin":false},"repo":{"id":30722866,"name":"fuel","full_name":"mila-udem/fuel","owner":{"login":"mila-udem","id":11724251,"avatar_url":"https://avatars.githubusercontent.com/u/11724251?v=3","gravatar_id":"","url":"https://api.github.com/users/mila-udem","html_url":"https://github.com/mila-udem","followers_url":"https://api.github.com/users/mila-udem/followers","following_url":"https://api.github.com/users/mila-udem/following{/other_user}","gists_url":"https://api.github.com/users/mila-udem/gists{/gist_id}","starred_url":"https://api.github.com/users/mila-udem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mila-udem/subscriptions","organizations_url":"https://api.github.com/users/mila-udem/orgs","repos_url":"https://api.github.com/users/mila-udem/repos","events_url":"https://api.github.com/users/mila-udem/events{/privacy}","received_events_url":"https://api.github.com/users/mila-udem/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mila-udem/fuel","description":"A data pipeline framework for machine learning","fork":false,"url":"https://api.github.com/repos/mila-udem/fuel","forks_url":"https://api.github.com/repos/mila-udem/fuel/forks","keys_url":"https://api.github.com/repos/mila-udem/fuel/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mila-udem/fuel/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mila-udem/fuel/teams","hooks_url":"https://api.github.com/repos/mila-udem/fuel/hooks","issue_events_url":"https://api.github.com/repos/mila-udem/fuel/issues/events{/number}","events_url":"https://api.github.com/repos/mila-udem/fuel/events","assignees_url":"https://api.github.com/repos/mila-udem/fuel/assignees{/user}","branches_url":"https://api.github.com/repos/mila-udem/fuel/branches{/branch}","tags_url":"https://api.github.com/repos/mila-udem/fuel/tags","blobs_url":"https://api.github.com/repos/mila-udem/fuel/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mila-udem/fuel/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mila-udem/fuel/git/refs{/sha}","trees_url":"https://api.github.com/repos/mila-udem/fuel/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mila-udem/fuel/statuses/{sha}","languages_url":"https://api.github.com/repos/mila-udem/fuel/languages","stargazers_url":"https://api.github.com/repos/mila-udem/fuel/stargazers","contributors_url":"https://api.github.com/repos/mila-udem/fuel/contributors","subscribers_url":"https://api.github.com/repos/mila-udem/fuel/subscribers","subscription_url":"https://api.github.com/repos/mila-udem/fuel/subscription","commits_url":"https://api.github.com/repos/mila-udem/fuel/commits{/sha}","git_commits_url":"https://api.github.com/repos/mila-udem/fuel/git/commits{/sha}","comments_url":"https://api.github.com/repos/mila-udem/fuel/comments{/number}","issue_comment_url":"https://api.github.com/repos/mila-udem/fuel/issues/comments{/number}","contents_url":"https://api.github.com/repos/mila-udem/fuel/contents/{+path}","compare_url":"https://api.github.com/repos/mila-udem/fuel/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mila-udem/fuel/merges","archive_url":"https://api.github.com/repos/mila-udem/fuel/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mila-udem/fuel/downloads","issues_url":"https://api.github.com/repos/mila-udem/fuel/issues{/number}","pulls_url":"https://api.github.com/repos/mila-udem/fuel/pulls{/number}","milestones_url":"https://api.github.com/repos/mila-udem/fuel/milestones{/number}","notifications_url":"https://api.github.com/repos/mila-udem/fuel/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mila-udem/fuel/labels{/name}","releases_url":"https://api.github.com/repos/mila-udem/fuel/releases{/id}","created_at":"2015-02-12T20:42:44Z","updated_at":"2015-07-23T09:51:52Z","pushed_at":"2015-07-23T05:31:52Z","git_url":"git://github.com/mila-udem/fuel.git","ssh_url":"git@github.com:mila-udem/fuel.git","clone_url":"https://github.com/mila-udem/fuel.git","svn_url":"https://github.com/mila-udem/fuel","homepage":null,"size":2754,"stargazers_count":126,"watchers_count":126,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":66,"mirror_url":null,"open_issues_count":41,"forks":66,"open_issues":41,"watchers":126,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/mila-udem/fuel/pulls/200"},"html":{"href":"https://github.com/mila-udem/fuel/pull/200"},"issue":{"href":"https://api.github.com/repos/mila-udem/fuel/issues/200"},"comments":{"href":"https://api.github.com/repos/mila-udem/fuel/issues/200/comments"},"review_comments":{"href":"https://api.github.com/repos/mila-udem/fuel/pulls/200/comments"},"review_comment":{"href":"https://api.github.com/repos/mila-udem/fuel/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/mila-udem/fuel/pulls/200/commits"},"statuses":{"href":"https://api.github.com/repos/mila-udem/fuel/statuses/c8e4ef82cd7dba92c85cb8d115e4c7aaff162c4d"}}}}