update README

README.md

@@ -10,4 +10,40 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+- ConvAE model (from [`Digits that are not: Generating new types through deep neural nets`](https://arxiv.org/pdf/1606.04345.pdf))
+- DeepConvAE model (from [here](https://tel.archives-ouvertes.fr/tel-01838272/file/75406_CHERTI_2018_diffusion.pdf), Section 10.1 with `L=3`)
+- Dense K-Sparse model (from [`Out-of-class novelty generation`](https://openreview.net/forum?id=r1QXQkSYg))
+
+These models were trained on MNIST only (digits), but were found to generate new kinds of symbols, see the references for more details.
+
+![](image.png)
+
+# Install requirements
+
+`pip install -r requirements.txt`
+
+# Download models
+
+```bash
+git lfs pull
+```
+
+# Training
+
+`python cli.py train  --dataset=mnist --folder=convae --model=convae`
+
+`python cli.py train  --dataset=mnist --folder=deep_convae --model=deep_convae`
+
+# Generate samples
+
+```bash
+python cli.py test --model-path=convae.th --nb-generate=100 --folder=convae
+```
+
+```bash
+python cli.py test --model-path=deep_convae.th --nb-generate=100 --folder=deep_convae
+```
+
+```bash
+python cli.py test --model-path=fc_sparse.th --nb-generate=100 --folder=deep_convae
+```