cleaned up notebooks

StanfordASL · Aug 6, 2021 · 0fde7bb · 0fde7bb
1 parent 2da6190
commit 0fde7bb
Show file tree

Hide file tree

Showing 28 changed files with 3,897 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,24 +1,11 @@
 STLCG
 ======
 
-A toolbox to compute the robustness of STL formulas using computations graphs (PyTorch).
-
-The `wafr20` branch reproduces the results from our [WAFR2020 paper](http://asl.stanford.edu/wp-content/papercite-data/pdf/Leung.Arechiga.Pavone.WAFR20.pdf). Note that the stlcg code in the `master` and `dev` branches have been updated since. So the `wafr20` branch works in isolation. 
+A toolbox to compute the robustness of STL formulas using computations graphs.
 
 ## Installation
-This was done on a linux machine running Python 3.5. You may need to change some of the packages in requirements to make it work on your setup. If you are running Python3.6 or higher, you may need to remove `importlib==1.0.4`.
 
-First create a virtual environment
-```
-python3 -m venv stlcg-env
-source stlcg-env/bin/activate
-pip3 install -r requirements.txt
-```
-Then, since this project uses IPython notebooks, we'll install this conda environment as a kernel.
-```
-python3 -m ipykernel install --user --name stlcg-env --display-name "Python 3.X (stlcg)"
-```
-where X is the python3 version number.
+You need Python3 and PyTorch installed.
 
 The vizualization code here is constructed from https://github.com/szagoruyko/pytorchviz but with modifications to represent STL operators.
 
@@ -27,6 +14,8 @@ The vizualization code here is constructed from https://github.com/szagoruyko/py
 
 `demo.ipynb` is an IPython jupyter notebook that showcases the basic functionality of the toolbox.
 
+The `examples` folder contains example usage of STLCG in a number of applications. These are the examples investigated in the WAFR 2020 publication (see below).
+
 ## Publications
 Here are a list of publications that use stlcg. Please file an issue, or pull request to add your publication to the list.
 

diff --git a/examples/Motion planning.ipynb b/examples/Motion planning.ipynb
diff --git a/examples/Neural networks.ipynb b/examples/Neural networks.ipynb
diff --git a/examples/VAE.ipynb b/examples/VAE.ipynb
diff --git a/examples/models/bump.npy b/examples/models/bump.npy
diff --git a/examples/models/bump_0.00.model b/examples/models/bump_0.00.model
diff --git a/examples/models/bump_2.00.model b/examples/models/bump_2.00.model
diff --git a/examples/models/bump_data_0.00.npy b/examples/models/bump_data_0.00.npy
diff --git a/examples/models/bump_data_2.00.npy b/examples/models/bump_data_2.00.npy
diff --git a/examples/models/intent_0.00.model b/examples/models/intent_0.00.model
diff --git a/examples/models/intent_0.10.model b/examples/models/intent_0.10.model
diff --git a/examples/models/intent_test.npy b/examples/models/intent_test.npy
diff --git a/examples/models/intent_train.npy b/examples/models/intent_train.npy
diff --git a/examples/models/phi1_margin=0.0.npy b/examples/models/phi1_margin=0.0.npy
diff --git a/examples/models/phi1_margin=0.05.npy b/examples/models/phi1_margin=0.05.npy
diff --git a/examples/models/phi2_margin=0.0.npy b/examples/models/phi2_margin=0.0.npy
diff --git a/examples/models/phi2_margin=0.05.npy b/examples/models/phi2_margin=0.05.npy
diff --git a/examples/models/psi1_margin=0.0.npy b/examples/models/psi1_margin=0.0.npy
diff --git a/examples/models/psi1_margin=0.05.npy b/examples/models/psi1_margin=0.05.npy
diff --git a/examples/models/psi2_margin=0.0.npy b/examples/models/psi2_margin=0.0.npy
diff --git a/examples/models/psi2_margin=0.05.npy b/examples/models/psi2_margin=0.05.npy
diff --git a/examples/models/stlvae.model b/examples/models/stlvae.model
diff --git a/examples/models/stlvae_stl_loss.npy b/examples/models/stlvae_stl_loss.npy
diff --git a/examples/models/stlvae_train_loss.npy b/examples/models/stlvae_train_loss.npy
diff --git a/examples/models/stlvae_vae_loss.npy b/examples/models/stlvae_vae_loss.npy
diff --git a/examples/models/vae.model b/examples/models/vae.model
diff --git a/examples/models/vae_train_loss.npy b/examples/models/vae_train_loss.npy
diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
     name="stlcg",
     version="0.0.1",
     author="Karen Leung and Nikos Arechiga",
-    author_email="[email protected] and [email protected]",
+    author_email="[email protected] and [email protected]",
     description="A toolbox to compute the robustness of STL formulas using computations graphs (PyTorch).",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -19,3 +19,4 @@
         "Operating System :: OS Independent",
     ],
 )
+