Merge pull request #1 from fsschneider/master

Update to version 1.1.2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,11 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: "\U0001F195 Status: New, \U0001F41B Type: Bug"
+assignees: fsschneider
+
+---
+
+**Describe the bug**
+A description of what the bug is...

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,13 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: "\U0001F195 Status: New"
+assignees: fsschneider
+
+---
+
+**Are you requesting a new feature or an enhancement of an existing one? Please use the labels accordingly.**
+
+**Describe the solution you'd like**
+A description of what you want ...

.gitignore

@@ -33,3 +33,7 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+
+# ToDo.md file
+
+ToDo.md

README.md

@@ -3,7 +3,7 @@
 ![DeepOBS](docs/deepobs_banner.png "DeepOBS")
 
 [![PyPI version](https://badge.fury.io/py/deepobs.svg)](https://badge.fury.io/py/deepobs)
-[![Documentation Status](https://readthedocs.org/projects/deepobs/badge/?version=latest)](https://deepobs.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/deepobs/badge/?version=stable)](https://deepobs.readthedocs.io/en/latest/?badge=stable)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 
@@ -27,6 +27,7 @@ DeepOBS automates several steps when benchmarking deep learning optimizers:
 
 The code for the current implementation working with **TensorFlow** can be found
 on [Github](https://github.com/fsschneider/DeepOBS).
+A PyTorch version is currently developed and can be accessed via the pre-release or the develop branch (see News section below).
 
 The full documentation is available on readthedocs:
 https://deepobs.readthedocs.io/
@@ -35,10 +36,19 @@ The paper describing DeepOBS has been accepted for ICLR 2019 and can be found
 here:
 https://openreview.net/forum?id=rJg6ssC5Y7
 
-We are actively working on a **PyTorch** version and will be releasing it in the
-next months. In the meantime, PyTorch users can still use parts of DeepOBS such
-as the data preprocessing scripts or the visualization features.
+**If you find any bugs in DeepOBS, or find it hard to use, please let us know.
+We are always interested in feedback and ways to improve DeepOBS.**
 
+## News
+
+We are currently working on a new and improved version of DeepOBS, version 1.2.0.
+It will support **PyTorch** in addition to TensorFlow, has an easier interface, and
+many bugs ironed out. You can find the latest version of it in [this branch](https://github.com/fsschneider/DeepOBS/tree/develop).
+
+A [pre-release](https://github.com/fsschneider/DeepOBS/releases/tag/v1.2.0-beta0) is available now. 
+The full release is expected in a few weeks.
+
+Many thanks to [Aaron Bahde](https://github.com/abahde) for spearheading the developement of DeepOBS 1.2.0.
 
 ## Installation
 
@@ -48,5 +58,16 @@ We tested the package with Python 3.6 and TensorFlow version 1.12. Other
 versions of Python and TensorFlow (>= 1.4.0) might work, and we plan to expand
 compatibility in the future.
 
+If you want to create a local and modifiable version of DeepOBS, you can do this directly from this repo via
+
+	pip install -e git+https://github.com/fsschneider/DeepOBS.git#egg=DeepOBS
+
+for the stable version, or 
+
+	pip install -e git+https://github.com/fsschneider/DeepOBS.git@develop#egg=DeepOBS
+
+for the latest development version.
+
+
 Further tutorials and a suggested protocol for benchmarking deep learning
 optimizers can be found on https://deepobs.readthedocs.io/

setup.py

@@ -5,17 +5,18 @@
 
 
 def readme():
-    with open('README.md') as f:
+    with open("README.md") as f:
         return f.read()
 
+
 setuptools.setup(
-    name='deepobs',
-    version='1.1.1',
-    description='Deep Learning Optimizer Benchmark Suite',
+    name="deepobs",
+    version="1.1.2",
+    description="Deep Learning Optimizer Benchmark Suite",
     long_description=readme(),
-    author='Frank Schneider, Lukas Balles and Philipp Hennig,',
-    author_email='[email protected]',
-    license='MIT',
+    author="Frank Schneider, Lukas Balles and Philipp Hennig,",
+    author_email="[email protected]",
+    license="MIT",
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3.6",
@@ -26,13 +27,18 @@ def readme():
         "Topic :: Scientific/Engineering :: Artificial Intelligence",
     ],
     install_requires=[
-        'argparse', 'numpy', 'pandas', 'matplotlib', 'matplotlib2tikz',
-        'seaborn'
+        "argparse",
+        "numpy",
+        "pandas",
+        "matplotlib",
+        "matplotlib2tikz==0.6.18",
+        "seaborn",
     ],
     scripts=[
-        'deepobs/scripts/deepobs_prepare_data.sh',
-        'deepobs/scripts/deepobs_get_baselines.sh',
-        'deepobs/scripts/deepobs_plot_results.py',
-        'deepobs/scripts/deepobs_estimate_runtime.py'
+        "deepobs/scripts/deepobs_prepare_data.sh",
+        "deepobs/scripts/deepobs_get_baselines.sh",
+        "deepobs/scripts/deepobs_plot_results.py",
+        "deepobs/scripts/deepobs_estimate_runtime.py",
     ],
-    zip_safe=False)
+    zip_safe=False,
+)