copying some docs from master

paninski-lab · Aug 23, 2018 · 8315f0c · 8315f0c
1 parent eb733ac
commit 8315f0c
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 6 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,12 +1,24 @@
 Changelog
 =========
 
-0.9dev
-------
-* This version incorporates Cat's branch changes
-* New deconvolution method
-* New clustering method
-* Implemented parallelization in several functions
+0.10dev
+-------
+* Colored logs
+* Improved testing coverage
+* Neural network code was simplified considerably
+* Added features to Neural networks objects
+* Added neural networks to documentation
+* Option to create all tensorflow sessions with a specific configuration
+* Shortcut in command line to limit GPU memory in all tensorflow sessions (through gpu_options.per_process_gpu_memory_fraction)
+* Refactored test suite
+* Integrats new triage network (using Keras)
+
+
+0.9 (2018-05-24)
+-----------------
+* Added parallelization to batch processor
+* Preprocess step now runs in parallel
+* Filtering and standarization running in one step to avoid I/O overhead
 
 
 0.8 (2018-04-19)

diff --git a/README.rst b/README.rst
@@ -82,6 +82,17 @@ Documentation hosted at `https://yass.readthedocs.io`_
 Running tests
 -------------
 
+Before running the tests, download the testing data:
+
+
+.. code-block:: shell
+
+    export YASS_TESTING_DATA_URL=[URL-TO-TESTING-DATA]
+
+    make download-test-data
+
+    make test
+
 To run tests and flake8 checks (from the root folder):
 
 .. code-block:: shell

diff --git a/doc/api.rst b/doc/api.rst
@@ -11,3 +11,5 @@ API Reference
     api/deconvolute
     api/geometry
     api/batch
+    api/augment
+    api/neuralnetwork