Installation¶
Foolbox is a Python package to create adversarial examples. It supports Python 3.5 and newer (try Foolbox 1.x if you still need to use Python 2.7).
Stable release¶
You can install the latest stable release of Foolbox from PyPI using pip:
pip install foolbox
Make sure that pip installs packages for Python 3, otherwise you might need to use pip3 instead of pip.
Pre-release versions¶
You can install the latest stable release of Foolbox from PyPI using pip:
pip install foolbox --pre
Make sure that pip installs packages for Python 3, otherwise you might need to use pip3 instead of pip.
Development version¶
Alternatively, you can install the latest development version of Foolbox from GitHub. We try to keep the master branch stable, so this version should usually work fine. Feel free to open an issue on GitHub if you encounter any problems.
pip install https://github.com/bethgelab/foolbox/archive/master.zip
Contributing to Foolbox¶
If you would like to contribute the development of Foolbox, install it in editable mode:
git clone https://github.com/bethgelab/foolbox.git
cd foolbox
pip install --editable .
To contribute your changes, you will need to fork the Foolbox repository on GitHub. You can than add it as a remote:
git remote add fork git@github.com/<your-github-name>/foolbox.git
You can now commit your changes, push them to your fork and create a pull-request to contribute them to Foolbox. See Running Tests for more information on the necessary tools and conventions.