Skip to content

Latest commit

 

History

History
141 lines (104 loc) · 7.21 KB

README.md

File metadata and controls

141 lines (104 loc) · 7.21 KB
Raw

Jupyter Notebook using FfDL with Adversarial Robustness Toolbox to test the robustness of Deep Learning Models

The Adversarial Robustness Toolbox (ART), an open source software library, supports both researchers and developers in defending deep neural networks against adversarial attacks, making AI systems more secure. Its purpose is to allow rapid crafting and analysis of attack and defense methods for machine learning models.

Fabric for Deep Learning (FfDL, pronounced “fiddle”) provides a consistent way to run deep-learning frameworks such as TensorFlow, PyTorch, Caffe, Keras etc. as a service on Kubernetes.

This Jupyter notebook trains a Fashion MNIST model with Fabric for Deep Learning (FfDL) on a Kubernetes Cluster and uses the Adversarial Robustness Toolbox (ART) to generate adversarial samples and test the robustness of the model against adversarial attacks.

FfDL

The notebook is structured into sections which can be run as a whole or in individual pieces like the model training or adversarial attacks on a trained model.

Notebook Contents

  1. Set up the environment - Configure access to FfDL cluster, to cloud object storage. Upload the training data to cloud object storage.

  2. Create a Keras model - Create a Convolutional Neural Network (CNN) training script based on keras/examples/mnist_cnn.py and upload it to cloud object storage. Create a FfDL manifest.yml to describing the model, the deep learning framework, the object store information, resource requirements, and hyperparameters required for training and testing.

  3. Train the model - Setup the FfDL command line environment, start the training job with FfDL on your Kubernetes cluster. While the training job is running you can monitor the training logs, or, optionally cancel the training job.

  4. Generate adversarial samples for a robustness check - Once the training job is completed, download the generated model artifacts and load the model in the notebook. Use one of ART's attack methods, the Fast Gradient Method (FGM), to craft adversarial samples which can be used to measure the model's robustness against adversarial attacks. Show robustness metrics and compare model predictions on adversarial samples to predictions on the original test images.

    model predictions on adversarial samples

  5. Summary and next steps - This notebook showed how to use Jupyter notebooks to interact with a FfDL cluster and how the Adversarial Robustness Toolbox can be integrated into a deep learning pipeline. To learn more about ART go to https://github.com/IBM/adversarial-robustness-toolbox

Follow the Prerequisites and the Setup steps below before Running the Notebook.

Prerequisites

Kubernetes Cluster with FfDL

You need to have Fabric for Deep Learning deployed on a Kubernetes Cluster with at least 2 CPUs and 4 Gb Memory.

Cloud Object Storage

To store model and training data, this notebook requires access to a Cloud Object Storage (COS) instance. BlueMix Cloud Object Storage offers a free lite plan. Follow these instructions to create your COS instance and generate service credentials with HMAC keys. Then go to the COS dashboard:

  • Get the cos_service_endpoint from the Endpoint tab
  • In the Service credentials tab, click New Credential +
    • Add the "HMAC" inline configuration parameter: {"HMAC":true}, click Add
    • Get the access_key_id (AWS_ACCESS_KEY_ID) and secret_access_key (AWS_SECRET_ACCESS_KEY) from the cos_hmac_keys section of the instance credentials: 
        "cos_hmac_keys": {
      "access_key_id": "1234567890abcdefghijklmnopqrtsuv",
      "secret_access_key": "0987654321zxywvutsrqponmlkjihgfedcba1234567890ab"
   }

Setup

Environment Variables

Optional, this step can be done in the notebook itself.

export FFDL_DIR=""              # Path to local clone of FfDL repository
export PUBLIC_IP=""             # Public IP of FfDL cluster
export KUBECONFIG=""            # Path to Kubernetes cluster configuration file
export AWS_ACCESS_KEY_ID=""     # Cloud Object Storage (AWS) Access Key ID
export AWS_SECRET_ACCESS_KEY="" # Cloud Object Storage (AWS) Secret Access Key
export AWS_DEFAULT_REGION=""    # Cloud Object Storage region name, i.e. 'us-east-1'
export AWS_ENDPOINT_URL=""      # Cloud Object Storage endpoint, i.e. 'https://s3-api.us-geo.objectstorage.softlayer.net'

Virtual Environment

Before running this notebook for the first time we recommend creating a Python 3 virtual environment using either virtualenv, venv (since Python 3.3), or Conda.

# assuming present working directory to be the FfDL project root
pip3 install virtualenv
virtualenv .venv/art
.venv/art/bin/pip install -r demos/fashion-mnist-adversarial/requirements.txt --upgrade

Running the Notebook

Activate the Python virtual environment

source .venv/art/bin/activate

Start the Jupyter notebook server

jupyter-notebook --notebook-dir demos/fashion-mnist-adversarial
# ... use Control-C to stop the notebook server

Deactivate the virtual environment after stopping the Jupyter notebook server

deactivate

To delete the Python virtual environment run the following command

rm -rf .venv/art

Dataset

Fashion-MNIST is a dataset of clothing images provided by Zalando Research. It is intended to serve as a direct drop-in replacement for the original MNIST dataset of hand-written digits for benchmarking Machine Learning algorithms. The Fashion-MNIST dataset is split into 60,000 training examples and 10,000 test examples. Each example is a 28x28 grayscale image, associated with a label from 10 classes.

Fashion-MNIST

Acknowledgements

Special thanks to Anupama-Murthi and Vijay Arya who created the original notebook which we modified here to showcase how to use ART with FfDL.

License

Apache 2.0