updated README.md

haowen-xu · Feb 22, 2020 · 5f0b0a1 · 5f0b0a1
1 parent c67f101
commit 5f0b0a1
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,24 @@
 ## TensorKit
 
-### Requirements
+### Dependencies
 
+* Python: 3.6/3.7
 * PyTorch: 1.3.1
 
+### Installation
+
+```bash
+pip install git+https://github.com/haowen-xu/ml-essentials.git
+pip install git+https://github.com/haowen-xu/tensorkit.git
+```
+
+### Examples
+
+* Classification:
+   * MLP: [classification/mlp.py](tensorkit/examples/classification/mlp.py)
+   * ResNet: [classification/resnet.py](tensorkit/examples/classification/resnet.py)
+* Auto Encoders:
+   * VAE: [auto_encoders/vae.py](tensorkit/examples/auto_encoders/vae.py)
+   * ResNet VAE: [auto_encoders/vae_resnet.py](tensorkit/examples/auto_encoders/vae_resnet.py)
+   * VAE with RealNVP posterior: [auto_encoders/vae_realnvp_posterior.py](tensorkit/examples/auto_encoders/vae_realnvp_posterior.py)
+