diff --git a/README.rst b/README.rst index 09beb1c41325085c7ed8584ae8b6f60198669713..13eb9343088fe41593bd6c381cecd44ce4884076 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,24 @@ Sparse Coding Library for Tensorflow ================================= +Installation +------------ + +To install the package, clone it to a local folder, then run `pip install -e .` from the folder to install the package in edit mode (so changes to the code are used). + + Overview ------------ Main sparse coding file is found at: -keras/train_sparse_model.py +sparse_coding_torch/train_sparse_model.py Sparse coding command example: python train_sparse_model.py Main classification model is found at: -keras/train_classifier.py +sparse_coding_torch/train_classifier.py Classification command example: python small_data_classifier.py --checkpoint sparse.pt