add future structure for ch

cleverhans-lab · Apr 4, 2019 · 4590d31 · 4590d31
1 parent 04792c4
commit 4590d31
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,10 @@ of the latest attacks and defenses.
 In particular, we always welcome help towards resolving the [issues](https://github.com/tensorflow/cleverhans/issues)
 currently open.
 
+## Major updates coming to CleverHans
+
+CleverHans will soon support 3 frameworks: JAX, PyTorch, and TF2. 
+
 ## Setting up CleverHans
 
 ### Dependencies

diff --git a/cleverhans/future/README.md b/cleverhans/future/README.md
@@ -0,0 +1,7 @@
+# CleverHans [Future]
+
+This folder contains (experimental) code that will eventually replace the
+existing CleverHans package. In the future, CleverHans will support three
+frameworks (JAX, PyTorch, and TF2). The package itself will focus on its
+initial principle: reference implementation of attacks against machine learning
+models to help with benchmarking models against adversarial examples.
diff --git a/cleverhans/future/__init__.py b/cleverhans/future/__init__.py
@@ -0,0 +1 @@
+
diff --git a/cleverhans/future/jax/__init__.py b/cleverhans/future/jax/__init__.py
@@ -0,0 +1 @@
+
diff --git a/cleverhans/future/tf2/__init__.py b/cleverhans/future/tf2/__init__.py
@@ -0,0 +1 @@
+
diff --git a/cleverhans/future/torch/__init__.py b/cleverhans/future/torch/__init__.py
@@ -0,0 +1 @@
+
diff --git a/defenses/README.md b/defenses/README.md
@@ -0,0 +1,4 @@
+# Defenses [Future]
+
+In the future, the content of `future/` will be moved to this folder.
+
diff --git a/defenses/future/README.md b/defenses/future/README.md
@@ -0,0 +1,9 @@
+# Defenses [Future]
+
+In the future, this folder will be at the root of this repository `//defenses`.
+
+This folder contains implementations of defenses (as standalone scripts) in one
+of the three frameworks (JAX, PyTorch, TF2). Each defense should be implemented
+as a script that helps reproduce results reported in the paper introducing the
+defense. The goal is for these scripts to be authoritative ways to reproduce
+the defense. 
diff --git a/defenses/future/jax/README.md b/defenses/future/jax/README.md
@@ -0,0 +1 @@
+# Defenses implemented with JAX
diff --git a/defenses/future/tf2/README.md b/defenses/future/tf2/README.md
@@ -0,0 +1 @@
+# Defenses implemented with TensorFlow 2
diff --git a/defenses/future/torch/README.md b/defenses/future/torch/README.md
@@ -0,0 +1 @@
+# Defenses implemented with PyTorch
diff --git a/tutorials/README.md b/tutorials/README.md
@@ -0,0 +1,3 @@
+# Tutorials [Future]
+
+In the future, the content of `future/` will be moved to this folder. 
diff --git a/tutorials/future/README.md b/tutorials/future/README.md
@@ -0,0 +1,6 @@
+# Tutorials [Future]
+
+In the future, this folder will be at the root of this repository `//tutorials`
+
+This folder contains scripts demonstrating the features of CleverHans
+implemented in one of the three supported frameworks (JAX, PyTorch, and TF2).