Merge 90d6b38 into 003f9fa

axondeepseg · Nov 9, 2018 · e475601 · e475601
2 parents 003f9fa + 90d6b38
commit e475601
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 37 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,26 +2,34 @@
 
 All notable changes to the AxonDeepSeg project will be documented in this file.
 
+## [2.2dev] - XXXX-XX-XX
+
+### Changed
+
+- Resolve image rescale warnings
+- Handle exception for images smaller than minimum patch size after resizing
+- Revert tensorflow requirekment to 1.3.0 and remove tifffile requirement
+
 ## [2.1] - 2018-09-25
 
-## Changed
+### Changed
 
-– Fixed bug that would crash when user inputed consent for Sentry tracking
+- Fixed bug that would crash when user inputed consent for Sentry tracking
 
 ## [2.0] - 2018-09-11
 
-## Changed
+### Changed
 
-– Upgraded ADS for Python 3.6-compatibility (no longer supporting Python 2.7)
+- Upgraded ADS for Python 3.6-compatibility (no longer supporting Python 2.7)
 - Minor changes to make ADS Windows-compatibile
-– Removed plot hold commands (deprecated)
+- Removed plot hold commands (deprecated)
 
 ## [1.1] - 2018-08-02
 
-## Changed
+### Changed
 
-– Minor Mac OSX-related bug fix
-– Changed installation requirements to exact release versions
+- Minor Mac OSX-related bug fix
+- Changed installation requirements to exact release versions
 
 ## [1.0] - 2018-08-02
 
@@ -31,31 +39,31 @@ Versions 1.x will remain Python 2.7-compatible
 
 (version 0.5 was skipped due to conflicting file on PyPI)
 
-## Added
+### Added
 
-– Comprehensive testing suite
-– Bug tracking (Sentry)
-– Blue-red visualisation function for segmented masks
+- Comprehensive testing suite
+- Bug tracking (Sentry)
+- Blue-red visualisation function for segmented masks
 
-## Changed
+### Changed
 
-– Dataset building and training notebook
-– Minor documentation improvements
-– Minor bug fixes
+- Dataset building and training notebook
+- Minor documentation improvements
+- Minor bug fixes
 
 ## [0.4.1] - 2018-05-16
 
 ### Added
 
-– GIMP procedure for ground truth labelling or segmentation correction added in the documentation.
-– Compatibility with tiff images.
-– Continuous integration with Travis is now supported.
+- GIMP procedure for ground truth labelling or segmentation correction added in the documentation.
+- Compatibility with tiff images.
+- Continuous integration with Travis is now supported.
 
 ### Changed
 
-– The documentation website is now hosted on ReadTheDocs.
-– Updated documentation on the usage of AxonDeepSeg.
-– Change of axon and myelin masks filenames for better clarity.
+- The documentation website is now hosted on ReadTheDocs.
+- Updated documentation on the usage of AxonDeepSeg.
+- Change of axon and myelin masks filenames for better clarity.
 
 ## [0.3] - 2018-02-22
 

diff --git a/docs/source/documentation.rst b/docs/source/documentation.rst
@@ -8,31 +8,38 @@ AxonDeepSeg was developed by NeuroPoly, the neuroimagery laboratory of Polytechn
 Changelog
 ===============================================================================
 
-## [2.1] - 2018-09-25
+Version [2.2dev] - XXXX-XX-XX
+-------------------------------------------------------------------------------
 
-Version [2.0] - 2018-09-11
+**Changed:**
+
+- Resolve image rescale warnings
+- Handle exception for images smaller than minimum patch size after resizing
+- Revert tensorflow requirekment to 1.3.0 and remove tifffile requirement
+
+Version [2.1] - 2018-09-25
 -------------------------------------------------------------------------------
 
 **Changed:**
 
-– Fixed bug that would crash when user inputed consent for Sentry tracking
+- Fixed bug that would crash when user inputed consent for Sentry tracking
 
 Version [2.0] - 2018-09-11
 -------------------------------------------------------------------------------
 
 **Changed:**
 
-– Upgraded ADS for Python 3.6-compatibility (no longer supporting Python 2.7)
+- Upgraded ADS for Python 3.6-compatibility (no longer supporting Python 2.7)
 - Minor changes to make ADS Windows-compatibile
-– Removed plot hold commands (deprecated)
+- Removed plot hold commands (deprecated)
 
 Version [1.1] - 2018-08-02
 -------------------------------------------------------------------------------
 
 **Changed:**
 
-– Minor Mac OSX-related bug fix
-– Changed installation requirements to exact release versions
+- Minor Mac OSX-related bug fix
+- Changed installation requirements to exact release versions
 
 Version [1.0] - 2018-08-02
 -------------------------------------------------------------------------------
@@ -46,15 +53,15 @@ Version [0.6] - 2018-08-01
 
 **Added:**
 
-– Comprehensive testing suite
-– Bug tracking (Sentry)
-– Blue-red visualisation function for segmented masks
+- Comprehensive testing suite
+- Bug tracking (Sentry)
+- Blue-red visualisation function for segmented masks
 
 **Changed:**
 
-– Dataset building and training notebook
-– Minor documentation improvements
-– Minor bug fixes
+- Dataset building and training notebook
+- Minor documentation improvements
+- Minor bug fixes
 
 Version [0.4.1] - 2018-05-16
 -------------------------------------------------------------------------------
@@ -181,10 +188,10 @@ To install the latest stable release of AxonDeepSeg, you just need to install it
   "Could not find a version that satisfies the requirement tensorflow>=XXX (from axondeepseg) (from versions: )... ",
   you will need to manually install the TensorFlow dependency.
 
-  Run the following command to install TensorFlow 1.9.0:
+  Run the following command to install TensorFlow 1.3.0:
   ::
 
-       pip install tensorflow==1.9.0
+       pip install tensorflow==1.3.0
 
   You can get more information by following the instructions from the `TensorFlow website <https://www.tensorflow.org/install/install_mac#the_url_of_the_tensorflow_python_package>`_.