Skip to main content

IBM Adversarial machine learning toolbox

Project description

Adversarial Robustness Toolbox (ART v0.5.0)

Build Status Documentation Status GitHub version Language grade: Python Total alerts

This is a library dedicated to adversarial machine learning. Its purpose is to allow rapid crafting and analysis of attacks and defense methods for machine learning models. The Adversarial Robustness Toolbox provides an implementation for many state-of-the-art methods for attacking and defending classifiers.

The library is still under development. Feedback, bug reports and extensions are highly appreciated. Get in touch with us on Slack (invite here)!

Supported attack and defense methods

The library contains implementations of the following evasion attacks:

The following defence methods are also supported:

ART also implements detection methods of adversarial samples:

  • Basic detector based on inputs
  • Detector trained on the activations of a specific layer

The following detector of poisoning attacks is also supported:

Setup

Installation with pip

The toolbox is designed to run with Python 2 and 3. The library can be installed from the PyPi repository using pip:

pip install adversarial-robustness-toolbox

Manual installation

For the most recent version of the library, either download the source code or clone the repository in your directory of choice:

git clone https://github.com/IBM/adversarial-robustness-toolbox

To install ART, do the following in the project folder:

pip install .

The library comes with a basic set of unit tests. To check your install, you can run all the unit tests by calling the test script in the install folder:

bash run_tests.sh

Running ART

Some examples of how to use ART when writing your own code can be found in the examples folder. See examples/README.md for more information about what each example does. To run an example, use the following command:

python examples/<example_name>.py

The notebooks folder contains Jupyter notebooks with detailed walkthroughs of some usage scenarios.

Contributing

Adding new features, improving documentation, fixing bugs, or writing tutorials are all examples of helpful contributions. Furthermore, if you are publishing a new attack or defense, we strongly encourage you to add it to the Adversarial Robustness Toolbox so that others may evaluate it fairly in their own work.

Bug fixes can be initiated through GitHub pull requests. When making code contributions to the Adversarial Robustness Toolbox, we ask that you follow the PEP 8 coding standard and that you provide unit tests for the new features.

This project uses DCO. Be sure to sign off your commits using the -s flag or adding Signed-off-By: Name<Email> in the commit message.

Example

git commit -s -m 'Add new feature'

Citing ART

If you use ART for research, please consider citing the following reference paper:

@article{art2018,
    title = {Adversarial Robustness Toolbox v0.5.0},
    author = {Nicolae, Maria-Irina and Sinn, Mathieu and Tran, Minh~Ngoc and Rawat, Ambrish and Wistuba, Martin and Zantedeschi, Valentina and Baracaldo, Nathalie and Chen, Bryant and Ludwig, Heiko and Molloy, Ian and Edwards, Ben},
    journal = {CoRR},
    volume = {1807.01069}
    year = {2018},
    url = {https://arxiv.org/pdf/1807.01069}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Adversarial Robustness Toolbox-0.5.0.tar.gz (121.7 kB view details)

Uploaded Source

Built Distribution

Adversarial_Robustness_Toolbox-0.5.0-py3-none-any.whl (204.7 kB view details)

Uploaded Python 3

File details

Details for the file Adversarial Robustness Toolbox-0.5.0.tar.gz.

File metadata

  • Download URL: Adversarial Robustness Toolbox-0.5.0.tar.gz
  • Upload date:
  • Size: 121.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.0

File hashes

Hashes for Adversarial Robustness Toolbox-0.5.0.tar.gz
Algorithm Hash digest
SHA256 03154c0c68c72968b1604bc780aa153b343c563fde49bcb772616ceadddb5312
MD5 dcae818a9e8acce446d269537d571c6f
BLAKE2b-256 4cca9455b08312fb0702cb8e7224366dc36803a1f98d497a4bf88713e43285ae

See more details on using hashes here.

File details

Details for the file Adversarial_Robustness_Toolbox-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: Adversarial_Robustness_Toolbox-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 204.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.0

File hashes

Hashes for Adversarial_Robustness_Toolbox-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32b4864fad35c1ac2580616d9640f03e5fb40800523a50a187aa3dcba56afee8
MD5 d1d35678b42c7834ffe73490d5ae2062
BLAKE2b-256 2557b9acec5ee6b36550e1ed3ee21ae3259a75b069c4c6bc103447db153f088d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page