Developer Start Guide¶
You want to contribute to Theano? That is great! This page explain our workflow and some resource for doing so.
Looking for an idea for a first contribution? Check the github issues with a label
easy fix. They are good starter. It is recommanded that you write on the issue you want to work on it. This help make sure it is up to date and see if nobody else is working on it. Also, we can sometimes provides more information about it. There is also the label NeedSomeoneToFinish that is interresting to check. The difficulty level is variable.
To get up to speed, you’ll need to
Requirements for Quality Contributions¶
- All the code should be properly tested.
- The code should be compatible with Python 2.7 and above, as well as Python 3.3 and above (using six if needed).
- All the code should respect the PEP8 Code Style Guide.
- The docstrings of all the classes and functions should respect the PEP257 rules and follow the Numpy docstring standard.
Each point will be referred to more in detail in the following.
When you submit a pull request, your changes will automatically be tested via Travis-CI. This will post the results of the tests with a little icon next to your commit. A yellow circle means the tests are running. A red X means the tests failed and a green circle means the tests passed.
Just because the tests run automatically does not mean you shouldn’t run them yourself to make sure everything is all right. You can run only the portion you are modifying to go faster and have travis to make sure there are no global impacts.
Also, if you are changing GPU code, travis doesn’t test that, because there are no GPUs on the test nodes.
To run the test suite with the default options, see How to test that Theano works properly.
Each night we execute all the unit tests automatically, with several sets of options. The result is sent by email to the theano-buildbot mailing list.
For more detail, see The nightly build/tests process.
To run all the tests with the same configuration as the buildbot, run this script:
This script accepts arguments that it forwards to nosetests. You can run only some tests or enable pdb by giving the equivalent nosetests parameters.
Setting up your Editor for PEP8¶
Detection of warnings and errors is done by the pep8 script (or flake8, that also checks for other things, like syntax errors). Syntax highlighting and general integration into Vim is done by the Syntastic plugin for Vim.
To setup VIM:
Install flake8 (if not already installed) with:
pip install "flake8<3"
Starting version 3.0.0, flake8 changed its dependancies and moved its Python API to a legacy module, breaking Theano’s flake8 tests. We recommend using a version prior to 3.
You can use
flake8if you prefer. The important thing is that the
pep8executable ends up in your
Install vundle with:
git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim
~/.vimrcand add the lines:
set nocompatible " be iMproved, required filetype off " required " set the runtime path to include Vundle and initialize set rtp+=~/.vim/bundle/Vundle.vim call vundle#begin() Plugin 'gmarik/Vundle.vim' " let Vundle manage Vundle (required!) Plugin 'scrooloose/syntastic' Plugin 'jimf/vim-pep8-text-width' call vundle#end() " Syntastic settings " You can run checkers explicitly by calling :SyntasticCheck <checker let g:syntastic_python_checkers = ['flake8'] "use one of the following checkers: " flake8, pyflakes, pylint, python (native checker) let g:syntastic_enable_highlighting = 1 "highlight errors and warnings let g:syntastic_style_error_symbol = ">>" "error symbol let g:syntastic_warning_symbol = ">>" "warning symbol let g:syntastic_check_on_open = 1 let g:syntastic_auto_jump = 0 "do not jump to errors when detected
Open a new vim and run
:PluginInstallto automatically install the plugins. When the installation is done, close the installation “window” with
:q. From now on Vim will check for PEP8 errors and highlight them whenever a file is saved.
A few useful commands¶
- Open the list of errors:
:lopen, that can be abbreviated in
- Close that list:
- Next error:
- Previous error:
Once you fix errors, messages and highlighting will still appear in the fixed file until you save it again.
We can also configure the
~/.vimrc to make it easier to work with Syntastic. For instance, to add a summary in the status bar, you can add:
To bind F2 and F3 to navigate to previous and next error, you can add:
map <F2> :lprevious<CR> map <F3> :lnext<CR>
You can prefix those by
autocmd FileType python if you want these bindings to work only on Python files.
There is an excellent system to configure emacs for Python: emacs-for-python. It gathers many emacs config into one, and modifies them to behave together nicely. You can use it to check for pep8 compliance and for Python syntax errors.
To install it on Linux, you can do like this:
cd git clone https://github.com/gabrielelanaro/emacs-for-python.git ~/.emacs.d/emacs-for-python
Then in your
~/.emacs file, add this:
;; Mandatory (load-file "~/.emacs.d/emacs-for-python/epy-init.el") (add-to-list 'load-path "~/.emacs.d/emacs-for-python/") ;; tell where to load the various files ;; Each of them enables different parts of the system. ;; Only the first two are needed for pep8, syntax check. (require 'epy-setup) ;; It will setup other loads, it is required! (require 'epy-python) ;; If you want the python facilities [optional] (require 'epy-completion) ;; If you want the autocompletion settings [optional] (require 'epy-editing) ;; For configurations related to editing [optional] ;; [newer version of emacs-for-python] (require 'epy-nose) ;; For shortcut to call nosetests [optional] ;; Define f10 to previous error ;; Define f11 to next error (require 'epy-bindings) ;; For my suggested keybindings [optional] ;; Some shortcut that do not collide with gnome-terminal, ;; otherwise, "epy-bindings" define f10 and f11 for them. (global-set-key [f2] 'flymake-goto-prev-error) (global-set-key [f3] 'flymake-goto-next-error) ;; Next two lines are the checks to do. You can add more if you wish. (epy-setup-checker "pyflakes %f") ;; For python syntax check (epy-setup-checker "pep8 -r %f") ;; For pep8 check
The script highlights problematic lines. This can make part of the line not readable depending on the background. To replace the line highlight by an underline, add this to your emacs configuration file:
;; Make lines readable when there is an warning [optional] (custom-set-faces ‘(flymake-errline ((((class color)) (:underline “red”)))) ‘(flymake-warnline ((((class color)) (:underline “yellow”)))))
Documentation and docstrings¶
- The documentation and the API documentation are generated using Sphinx.
- The documentation should be written in reStructuredText and the docstrings of all the classes and functions should respect the PEP257 rules and follow the Numpy docstring standard.
- Split the docstrings in sections, according to the Allowed docstring sections in Napoleon
- To cross-reference other objects (e.g. reference other classes or methods) in the docstrings, use the cross-referencing objects syntax.
:pycan be omitted, see e.g. this stackoverflow answer.
- See Documentation Documentation AKA Meta-Documentation, for some information on how to generate the documentation.
A Docstring Example¶
Here is an example on how to add a docstring to a class.
import theano class DoubleOp(theano.Op): """ Double each element of a tensor. Parameters ---------- x : tensor Input tensor Returns ------- tensor a tensor of the same shape and dtype as the input with all values doubled. Notes ----- this is a test note See Also -------- :class:`~theano.tensor.elemwise.Elemwise` : You can use this to replace this example. Just execute `x * 2` with x being a Theano variable. .. versionadded:: 0.6 """
This is how it will show up for files that we auto-list in the library documentation:
Double each element of a tensor.
Parameters: x – input tensor. Returns: a tensor of the same shape and dtype as the input with all values doubled. Note: this is a test note Seealso: You can use the elemwise op to replace this example. Just execute x * 2 with x being a Theano variable.
New in version 0.6.
Installation and configuration¶
This will create your own Theano project on GitHub, referred later as “YourProfile/Theano”, or “origin”, from which you will be able to contribute to the original Theano/Theano, also called “central”.
Create a local copy¶
Clone your fork locally with
git clone firstname.lastname@example.org:YOUR_GITHUB_LOGIN/Theano.git
For this URL to work, you must set your public ssh keys inside your github account setting.
From your local repository, your own fork on GitHub will be called “origin”.
Then, add a reference to the original (“central”) Theano repository with
git remote add central git://github.com/Theano/Theano.git
You can choose another name than “central” to reference Theano/Theano (for instance, NumPy uses “upstream”), but this documentation will stick to “central.”
You can then test your installation of Theano by following the steps of How to test that Theano works properly.
Using your local copy¶
To update your library to the latest revision, you should have a local branch that tracks central/master. You can add one (named “trunk” here) with:
git fetch central git branch trunk central/master
Once you have such a branch, in order to update it, do:
git checkout trunk git pull
Keep in mind that this branch should be “read-only”: if you want to patch Theano, you should work in another branch, like described in the Development Workflow section below.
On your local machine, you need to configure git with basic informations:
git config --global user.email email@example.com git config --global user.name "Your Name Comes Here"
You can also instruct git to use color in diff. For this, you need to add those lines in the file ~/.gitconfig
[color] branch = auto diff = auto interactive = auto status = auto
Start a new local branch¶
When working on a new feature in your own fork, start from an up-to-date copy of the master branch (the principal one) of the central repository (Theano/Theano on GitHub):
git fetch central git checkout -b my_shiny_feature central/master
This last line is a shortcut for:
git branch my_shiny_feature central/master git checkout my_shiny_feature
Submit your changes to the central repository¶
Once your code is ready for others to review, you need to commit all the changes and then push your branch to your github fork first:
git commit -a -m "your message here"
git push -u origin my_shiny_feature
Then, go to your fork’s github page on the github website, select your feature branch and hit the “Pull Request” button in the top right corner. This will signal the maintainers that you wish to submit your changes for inclusion in central/master. If you don’t get any feedback, bug us on the theano-dev mailing list.
Address reviewer comments¶
Your pull request will be reviewed by members of the core development team. If your branch is not directly accepted, the reviewers will use GitHub’s system to add “notes”, either general (on the entire commit), or “line notes”, relative to a particular line of code. In order to have the pull request accepted, you may have to answer the reviewer’s questions, you can do that on GitHub.
You may also have to edit your code to address their concerns. Some of the usual requests include fixing typos in comments, adding or correcting comments, adding unit tests in the test suite. In order to do that, you should continue your edits in the same branch you used (in this example, “my_shiny_feature”). For instance, if you changed your working branch, you should first:
git checkout my_shiny_feature
Then, edit your code, and test it appropriately (see Requirements for Quality Contributions below), and push it again to your GitHub fork, like the first time (except the
-u option is only needed the first time):
git push origin my_shiny_feature
The pull request to the central repository will then be automatically updated by GitHub. However, the reviewers will not be automatically notified of your revision, so it is advised to reply to the comments on GitHub, to let them know that you have submitted a fix.
More Advanced Git Usage¶
You can find information and tips in the numpy development page. Here are a few.
Cleaning up branches¶
When your pull request has been merged, you can delete the branch from your GitHub fork’s list of branches. This is useful to avoid having too many branches staying there. Deleting this remote branch is achieved with:
git push origin :my_shiny_feature
This lines pushes to the “origin” repository (your fork of Theano on GitHub), into the branch “my_shiny_feature”, an empty content (that’s why there is nothing before the colon), effectively removing it.
The branch will still be present in your local clone of the repository. If you want to delete it from there, too, you can run:
git branch -d my_shiny_feature
Amending a submitted pull request¶
If you want to fix a commit already submitted within a pull request (e.g. to fix a small typo), before the pull request is accepted, you can do it like this to keep history clean:
git checkout my_shiny_feature git commit --amend git push origin my_shiny_feature:my_shiny_feature
Do not abuse that command, and please use it only when there are only small issues to be taken care of. Otherwise, it becomes difficult to match the comments made by reviewers with the new modifications. In the general case, you should stick with the approach described above.
Cleaning up history¶
Sometimes you may have commits in your feature branch that are not needed in the final pull request. There is a page that talks about this. In summary:
- Commits to the trunk should be a lot cleaner than commits to your feature branch; not just for ease of reviewing but also because intermediate commits can break blame (the bisecting tool).
- git merge –squash will put all of the commits from your feature branch into one commit.
- There are other tools that are useful if your branch is too big for one squash.
Add another distant repository¶
To collaborate with another user on some feature he is developing, and that is not ready for inclusion in central, the easiest way is to use a branch of their Theano fork (usually on GitHub).
Just like we added Theano/Theano as a remote repository, named “central”, you can add (on your local machine) a reference to their fork as a new remote repository. REPO_NAME is the name you choose to name this fork, and GIT_REPO_PATH is the URL of the fork in question.
git remote add REPO_NAME GIT_REPO_PATH
Then, you can create a new local branch (LOCAL_BRANCH_NAME) based on a specific branch (REMOTE_BRANCH_NAME) from the remote repository (REPO_NAME):
git checkout -b LOCAL_BRANCH_NAME REPO_NAME/REMOTE_BRANCH_NAME
Other tools that can help you¶
- cProfile: time profiler that work at function level.
- Yep: A module for profiling compiled extensions.
- autopep8: A tool that automatically formats Python code to conform to the PEP 8 style guide.
- line_profiler: Line-by-line profiler.
- memory_profiler: memory profiler
- runsnake: Gui for cProfile(time profiler) and Meliae(memory profiler)
- Guppy: Supports object and heap memory sizing, profiling and debugging.
- hub: A tool that adds github commands to the git command line.
- git pull-requests: Another tool for git/github command line.