Skip to content

Commit ee2393a

Browse files
Irina NicolaeIrina Nicolae
authored andcommitted
Update docs and version number (0.4.0)
(cherry picked from commit 5cff7ae) Conflicts: README.md docs/conf.py
1 parent 9a7dbc4 commit ee2393a

File tree

8 files changed

+44
-14
lines changed

8 files changed

+44
-14
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Adversarial Robustness Toolbox (ART v0.3.0)
1+
# Adversarial Robustness Toolbox (ART v0.4.0)
22
[![Build Status](https://travis-ci.org/IBM/adversarial-robustness-toolbox.svg?branch=master)](https://travis-ci.org/IBM/adversarial-robustness-toolbox) [![Documentation Status](https://readthedocs.org/projects/adversarial-robustness-toolbox/badge/?version=latest)](http://adversarial-robustness-toolbox.readthedocs.io/en/latest/?badge=latest) [![GitHub version](https://badge.fury.io/gh/IBM%2Fadversarial-robustness-toolbox.svg)](https://badge.fury.io/gh/IBM%2Fadversarial-robustness-toolbox) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/IBM/adversarial-robustness-toolbox.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/IBM/adversarial-robustness-toolbox/context:python) [![Total alerts](https://img.shields.io/lgtm/alerts/g/IBM/adversarial-robustness-toolbox.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/IBM/adversarial-robustness-toolbox/alerts/)
33

44
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.
@@ -86,15 +86,15 @@ This project uses [DCO](https://developercertificate.org/). Be sure to sign off
8686
#### Example
8787

8888
```bash
89-
git commit -s -m 'Informative commit message'
89+
git commit -s -m 'Add new feature'
9090
```
9191

9292
## Citing ART
9393

9494
If you use ART for research, please consider citing the following reference paper:
9595
```
9696
@article{art2018,
97-
title = {Adversarial Robustness Toolbox v0.3.0},
97+
title = {Adversarial Robustness Toolbox v0.4.0},
9898
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},
9999
journal = {CoRR},
100100
volume = {1807.01069}

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424
author = 'Maria-Irina Nicolae'
2525

2626
# The short X.Y version
27-
version = '0.3'
27+
version = '0.4'
2828
# The full version, including alpha/beta/rc tags
29-
release = '0.3.0'
29+
release = '0.4.0'
3030

3131

3232
# -- General configuration ---------------------------------------------------

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ The following detector of poisoning attacks is also supported:
6262

6363
modules/attacks
6464
modules/classifiers
65+
modules/data_generators
6566
modules/defences
6667
modules/detection
6768
modules/poison_detection

docs/modules/attacks.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Carlini and Wagner Attack
77
.. autoclass:: CarliniL2Method
88
:members:
99

10+
.. autoclass:: CarliniLInfMethod
11+
:members:
12+
1013
DeepFool
1114
--------
1215
.. autoclass:: DeepFool

docs/modules/classifiers.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Base Class
77
.. autoclass:: Classifier
88
:members:
99

10-
Concrete Model Wrappers
11-
-----------------------
10+
Framework-Specific Model Wrappers
11+
---------------------------------
1212
.. autoclass:: KerasClassifier
1313
:members:
1414
.. autoclass:: MXClassifier
@@ -17,3 +17,8 @@ Concrete Model Wrappers
1717
:members:
1818
.. autoclass:: TFClassifier
1919
:members:
20+
21+
Ensemble Wrapper
22+
----------------
23+
.. autoclass:: EnsembleClassifier
24+
:members:

docs/modules/data_generators.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
:mod:`art.data_generators`
2+
==========================
3+
.. automodule:: art.data_generators
4+
5+
Base Class
6+
----------
7+
.. autoclass:: DataGenerator
8+
:members:
9+
10+
11+
Framework-Specific Data Generators
12+
----------------------------------
13+
.. autoclass:: KerasDataGenerator
14+
:members:
15+
16+
.. autoclass:: MXDataGenerator
17+
:members:
18+
19+
.. autoclass:: PyTorchDataGenerator
20+
:members:
21+
22+
.. autoclass:: TFDataGenerator
23+
:members:

docs/modules/utils.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ Preprocess
1414
----------
1515
.. autofunction:: preprocess
1616

17-
Fixing Random Number Generators Seed
18-
------------------------------------
17+
Fixing the Seed for Random Number Generators
18+
--------------------------------------------
1919
.. autofunction:: master_seed

setup.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,22 @@
2121
with open("README.md", "r") as fh:
2222
long_description = fh.read()
2323

24-
install_requires = ['h5py',
25-
'numpy',
24+
install_requires = ['numpy',
2625
'scipy',
27-
'keras',
28-
'tensorflow',
2926
'six',
3027
'setuptools',
3128
'scikit-learn']
3229

3330
tests_require = ['mxnet',
31+
'h5py',
3432
'keras',
3533
'Pillow',
3634
'requests',
3735
'tensorflow',
3836
'torch']
3937

4038
setup(name='Adversarial Robustness Toolbox',
41-
version='0.3.0',
39+
version='0.4.0',
4240
description='IBM Adversarial machine learning toolbox',
4341
long_description=long_description,
4442
long_description_content_type='text/markdown',

0 commit comments

Comments
 (0)