Skip to content

Commit

Permalink
Update copyright, authors and version (#679)
Browse files Browse the repository at this point in the history
  • Loading branch information
zimmerrol authored Apr 2, 2022
1 parent 48087a5 commit 3536742
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
18 changes: 9 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
:target: https://doi.org/10.21105/joss.02607

===============================================================================================================================
Foolbox Native: Fast adversarial attacks to benchmark the robustness of machine learning models in PyTorch, TensorFlow, and JAX
Foolbox: Fast adversarial attacks to benchmark the robustness of machine learning models in PyTorch, TensorFlow, and JAX
===============================================================================================================================

`Foolbox <https://foolbox.jonasrauber.de>`_ is a **Python library** that lets you easily run adversarial attacks against machine learning models like deep neural networks. It is built on top of EagerPy and works natively with models in `PyTorch <https://pytorch.org>`_, `TensorFlow <https://www.tensorflow.org>`_, and `JAX <https://github.com/google/jax>`_.

🔥 Design
----------

**Foolbox 3** a.k.a. **Foolbox Native** has been rewritten from scratch
**Foolbox 3** has been rewritten from scratch
using `EagerPy <https://github.com/jonasrauber/eagerpy>`_ instead of
NumPy to achieve native performance on models
developed in PyTorch, TensorFlow and JAX, all with one code base without code duplication.
Expand All @@ -49,7 +49,7 @@ developed in PyTorch, TensorFlow and JAX, all with one code base without code du
pip install foolbox
Foolbox is tested with Python 3.9 and newer - however, it will most likely also work with version 3.6 - 3.8. To use it with `PyTorch <https://pytorch.org>`_, `TensorFlow <https://www.tensorflow.org>`_, or `JAX <https://github.com/google/jax>`_, the respective framework needs to be installed separately. These frameworks are not declared as dependencies because not everyone wants to use and thus install all of them and because some of these packages have different builds for different architectures and CUDA versions. Besides that, all essential dependencies are automatically installed.
Foolbox is tested with Python 3.8 and newer - however, it will most likely also work with version 3.6 - 3.8. To use it with `PyTorch <https://pytorch.org>`_, `TensorFlow <https://www.tensorflow.org>`_, or `JAX <https://github.com/google/jax>`_, the respective framework needs to be installed separately. These frameworks are not declared as dependencies because not everyone wants to use and thus install all of them and because some of these packages have different builds for different architectures and CUDA versions. Besides that, all essential dependencies are automatically installed.

You can see the versions we currently use for testing in the `Compatibility section <#-compatibility>`_ below, but newer versions are in general expected to work.

Expand All @@ -74,7 +74,7 @@ a full `ResNet-18 example <./examples/single_attack_pytorch_resnet18.py>`_.
📄 Citation
------------

If you use Foolbox for your work, please cite our `JOSS paper on Foolbox Native <https://doi.org/10.21105/joss.02607>`_ and our `ICML workshop paper on Foolbox <https://arxiv.org/abs/1707.04131>`_ using the following BibTeX entries:
If you use Foolbox for your work, please cite our `JOSS paper on Foolbox Native (i.e., Foolbox 3.0) <https://doi.org/10.21105/joss.02607>`_ and our `ICML workshop paper on Foolbox <https://arxiv.org/abs/1707.04131>`_ using the following BibTeX entries:

.. code-block::
Expand Down Expand Up @@ -117,21 +117,21 @@ marked with `contributions welcome
--------------

If you have a question or need help, feel free to open an issue on GitHub.
Once GitHub Discussions becomes publically available, we will switch to that.
Once GitHub Discussions becomes publicly available, we will switch to that.

💨 Performance
--------------

Foolbox Native is much faster than Foolbox 1 and 2. A basic `performance comparison`_ can be found in the `performance` folder.
Foolbox 3.0 is much faster than Foolbox 1 and 2. A basic `performance comparison`_ can be found in the `performance` folder.

🐍 Compatibility
-----------------

We currently test with the following versions:

* PyTorch 1.4.0
* TensorFlow 2.1.0
* JAX 0.1.57
* PyTorch 1.10.1
* TensorFlow 2.6.3
* JAX 0.2.517
* NumPy 1.18.1

.. _performance comparison: performance/README.md
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
# -- Project information -----------------------------------------------------

project = "Foolbox"
copyright = "2020, Jonas Rauber"
author = "Jonas Rauber"
copyright = "2021, Jonas Rauber, Roland S. Zimmermann"
author = "Jonas Rauber, Roland S. Zimmermann"

version = foolbox.__version__
release = foolbox.__version__
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Welcome to Foolbox Native
=========================

Foolbox is a Python toolbox to create adversarial examples that fool neural networks.
*Foolbox 3.0* a.k.a. *Foolbox Native* has been completely rewritten from scratch.
*Foolbox 3.0* has been completely rewritten from scratch.
It is now built on top of `EagerPy <https://github.com/jonasrauber/eagerpy>`_
and comes with native support for these frameworks:

Expand Down
2 changes: 1 addition & 1 deletion foolbox/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.3.2
3.3.3
4 changes: 2 additions & 2 deletions guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
home: true
heroImage: /logo.png
heroText: Foolbox
tagline: "Foolbox Native: Fast adversarial attacks to benchmark the robustness of machine learning models in PyTorch, TensorFlow, and JAX"
tagline: "Foolbox: Fast adversarial attacks to benchmark the robustness of machine learning models in PyTorch, TensorFlow, and JAX"
actionText: Get Started →
actionLink: /guide/
features:
Expand All @@ -12,7 +12,7 @@ features:
details: Foolbox provides a large collection of state-of-the-art gradient-based and decision-based adversarial attacks.
- title: Type Checking
details: Catch bugs before running your code thanks to extensive type annotations in Foolbox.
footer: Copyright © 2020 Jonas Rauber
footer: Copyright © 2022 Jonas Rauber, Roland S. Zimmermann

---

Expand Down
4 changes: 2 additions & 2 deletions guide/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ You can install the latest release from [PyPI](https://pypi.org/project/foolbox/
python3 -m pip install foolbox
```

Foolbox requires Python 3.6 or newer. To use it with [PyTorch](https://pytorch.org), [TensorFlow](https://www.tensorflow.org), or [JAX](https://github.com/google/jax), the respective framework needs to be installed separately. These frameworks are not declared as dependencies because not everyone wants to use and thus install all of them and because some of these packages have different builds for different architectures and CUDA versions. Besides that, all essential dependencies are automatically installed.
Foolbox requires Python 3.8 or newer. To use it with [PyTorch](https://pytorch.org), [TensorFlow](https://www.tensorflow.org), or [JAX](https://github.com/google/jax), the respective framework needs to be installed separately. These frameworks are not declared as dependencies because not everyone wants to use and thus install all of them and because some of these packages have different builds for different architectures and CUDA versions. Besides that, all essential dependencies are automatically installed.

::: warning NOTE
Foolbox requires Python 3.6 or newer.
Foolbox requires Python 3.8 or newer.
:::

## Getting a Model
Expand Down
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
"typing-extensions>=3.7.4.1",
"requests>=2.24.0",
]
tests_require = ["pytest>=5.3.5", "pytest-cov>=2.8.1"]
tests_require = ["pytest>=7.1.1", "pytest-cov>=3.0.0"]


setup(
name="foolbox",
version=version,
description="Foolbox Native is an adversarial attacks library that works natively with PyTorch, TensorFlow and JAX",
description="Foolbox is an adversarial attacks library that works natively with PyTorch, TensorFlow and JAX",
long_description=README,
long_description_content_type="text/x-rst",
classifiers=[
Expand All @@ -45,8 +45,8 @@
"Topic :: Scientific/Engineering :: Artificial Intelligence",
],
keywords="",
author="Jonas Rauber",
author_email="[email protected]",
author="Jonas Rauber, Roland S. Zimmermann",
author_email="[email protected]",
url="https://github.com/bethgelab/foolbox",
license="MIT License",
packages=find_packages(),
Expand Down

0 comments on commit 3536742

Please sign in to comment.