add readme instructions

ntakouris · Jun 23, 2021 · 3eda514 · 3eda514
1 parent b12f1d3
commit 3eda514
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,17 @@
-# To Do List
+# TimeSeries Pretrain Tests
+
+## Datasets and Setup
+
+Navigate to [timeseriesclassification.com](http://www.timeseriesclassification.com/dataset.php) and download the **sktime formatted ts files** at `./datasets/`.
+
+`pip install -r requirements.txt` and launch `tests.ipynb`
+
+## To Do List
 
 - [x] LSTM Autoencoder
-- [ ] Transformer
+- [x] Transformer
 - [ ] ConvNet
-- [ ] Denoising Autoencoder w/ Augmentations
+- [ ] Denoising Autoencoder(s) w/ Augmentations
 - [ ] Hyperparameter Sweep
 - [ ] Two Stage Fine Tuning
 - [ ] Bigger Datasets
diff --git a/augmentations.py b/augmentations.py
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,4 @@
+tensorflow>=2.4
+sklearn
+sktime
+numpy
diff --git a/simple.ipynb → tests.ipynb b/simple.ipynb → tests.ipynb