From a9bc226496a2002ac519d557254883770edb3ea7 Mon Sep 17 00:00:00 2001 From: Frank Schneider Date: Tue, 16 Apr 2019 13:46:55 +0200 Subject: [PATCH 01/13] Update Gitignore --- .gitignore | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 7adc1d3d..5f174fb9 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,7 @@ wheels/ *.egg-info/ .installed.cfg *.egg + +# ToDo.md file + +ToDo.md From db11d79a8695344fd690b3fa5e5a2256e9e8a45b Mon Sep 17 00:00:00 2001 From: Frank Date: Wed, 8 May 2019 19:25:29 -0500 Subject: [PATCH 02/13] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5d9a529e..8692f979 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ 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.** ## Installation From 73918102e3eabe18f558c6d11db4e37f58d09e8a Mon Sep 17 00:00:00 2001 From: Frank Date: Fri, 6 Sep 2019 12:43:28 +0200 Subject: [PATCH 03/13] Update with link to Aarons Beta version of 1.2 --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8692f979..5cb1a710 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,10 @@ 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. +We are currently working on a new and improved version of DeepOBS. +It will support **PyTorch** as well as TensorFlow, has an easier interface, and +many bugs ironed out. It will be released in a few weeks, until then you can +check out the current working beta version of it over at https://github.com/abahde/DeepOBS. **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.** From 856fbd3095e19f3e85b3434de3e154dd1888fed3 Mon Sep 17 00:00:00 2001 From: Frank Date: Tue, 17 Sep 2019 13:56:13 +0200 Subject: [PATCH 04/13] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..dd84ea78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..bbcbbe7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From 592cb18cbbe7aeeabd03b4662bba24a0acdb21e9 Mon Sep 17 00:00:00 2001 From: Frank Date: Tue, 17 Sep 2019 14:54:22 +0200 Subject: [PATCH 05/13] Personalize issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 33 +++-------------------- .github/ISSUE_TEMPLATE/feature_request.md | 15 +++-------- 2 files changed, 7 insertions(+), 41 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..7aecd4bd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,37 +2,10 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' -assignees: '' +labels: "\U0001F195 Status: New, \U0001F41B Type: Bug" +assignees: fsschneider --- **Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. +A description of what the bug is... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d..b78e383d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,19 +2,12 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: '' -assignees: '' +labels: "\U0001F195 Status: New" +assignees: fsschneider --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**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 clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. +A description of what you want ... From e1fa593d620d13914f831d1c95b55f3707d7e716 Mon Sep 17 00:00:00 2001 From: Frank Date: Wed, 25 Sep 2019 14:02:07 +0200 Subject: [PATCH 06/13] Update README with more info about beta version --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5cb1a710..f9196db9 100644 --- a/README.md +++ b/README.md @@ -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 (see News section below). The full documentation is available on readthedocs: https://deepobs.readthedocs.io/ @@ -35,14 +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 currently working on a new and improved version of DeepOBS. -It will support **PyTorch** as well as TensorFlow, has an easier interface, and -many bugs ironed out. It will be released in a few weeks, until then you can -check out the current working beta version of it over at https://github.com/abahde/DeepOBS. - **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/v1.2.0-beta0). + +A pre-release, version 1.2.0-beta0, will be available shortly and a 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 pip install deepobs @@ -51,5 +57,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 latest stable version, or + + pip install -e git+https://github.com/fsschneider/DeepOBS.git@v1.2.0-beta0#egg=DeepOBS + +to get the preview of DeepOBS 1.2.0. + + Further tutorials and a suggested protocol for benchmarking deep learning optimizers can be found on https://deepobs.readthedocs.io/ From 04abe4b9201dde33c1d7f839583aedae4ac66f38 Mon Sep 17 00:00:00 2001 From: Frank Date: Tue, 29 Oct 2019 14:19:35 +0100 Subject: [PATCH 07/13] Add matplotlib2tikz to requirements for readthedocs --- requirements_doc.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements_doc.txt b/requirements_doc.txt index cc2d743e..b062abd6 100644 --- a/requirements_doc.txt +++ b/requirements_doc.txt @@ -2,3 +2,4 @@ sphinx==1.8.1 sphinx-rtd-theme==0.4.2 sphinx-argparse==0.2.3 tensorflow==1.13.1 +matplotlib2tikz==0.6.18 From 494f3fa58550691c1cf33709a714ba8ecbc8628f Mon Sep 17 00:00:00 2001 From: Frank Schneider Date: Tue, 29 Oct 2019 16:34:32 +0100 Subject: [PATCH 08/13] Remove Travis integration --- .travis.yml | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index bd6c6d61..00000000 --- a/.travis.yml +++ /dev/null @@ -1,16 +0,0 @@ -sudo: required -language: python -python: - - "3.6" -cache: pip -install: - - sudo bash deepobs/scripts/deepobs_prepare_data.sh - - pip install argparse - - pip install numpy - - pip install pandas - - pip install matplotlib - - pip install matplotlib2tikz - - pip install seaborn - - pip install tensorflow==1.12.0 -script: - - python -m unittest discover From 365422593e9f73958e9d73b779ff799629d53024 Mon Sep 17 00:00:00 2001 From: Frank Schneider Date: Tue, 29 Oct 2019 16:34:56 +0100 Subject: [PATCH 09/13] Remove Matplotlib2tikz from doc requirements --- requirements_doc.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/requirements_doc.txt b/requirements_doc.txt index b062abd6..cc2d743e 100644 --- a/requirements_doc.txt +++ b/requirements_doc.txt @@ -2,4 +2,3 @@ sphinx==1.8.1 sphinx-rtd-theme==0.4.2 sphinx-argparse==0.2.3 tensorflow==1.13.1 -matplotlib2tikz==0.6.18 From b389a7c0a3129573d28308cd175002b612b016f6 Mon Sep 17 00:00:00 2001 From: Frank Schneider Date: Tue, 29 Oct 2019 16:35:33 +0100 Subject: [PATCH 10/13] Install specific version of matplotlib2tikz --- setup.py | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/setup.py b/setup.py index fef1fc6d..0c2bfad6 100644 --- a/setup.py +++ b/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='frank.schneider@tue.mpg.de', - license='MIT', + author="Frank Schneider, Lukas Balles and Philipp Hennig,", + author_email="frank.schneider@tue.mpg.de", + 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, +) From 0917d3d2f986d0febc3ebb08f203370922b71831 Mon Sep 17 00:00:00 2001 From: Frank Schneider Date: Tue, 29 Oct 2019 16:35:44 +0100 Subject: [PATCH 11/13] Show Doc Badge of stable version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f9196db9..a6078b69 100644 --- a/README.md +++ b/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) From 52340d78f5ab7e6aef94b0924f481eb48f1431f8 Mon Sep 17 00:00:00 2001 From: Frank Date: Tue, 29 Oct 2019 17:49:07 +0100 Subject: [PATCH 12/13] Updated remark to pre-release --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6078b69..e2de4c01 100644 --- a/README.md +++ b/README.md @@ -27,7 +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 (see News section below). +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/ @@ -43,9 +43,10 @@ We are always interested in feedback and ways to improve DeepOBS.** 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/v1.2.0-beta0). +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, version 1.2.0-beta0, will be available shortly and a full release is expected in a few weeks. +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. From 1ab819cf1389618023bd9e9769ae8bc6e8f987c8 Mon Sep 17 00:00:00 2001 From: Frank Date: Tue, 29 Oct 2019 17:50:24 +0100 Subject: [PATCH 13/13] update installation links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e2de4c01..512401b3 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,11 @@ If you want to create a local and modifiable version of DeepOBS, you can do this pip install -e git+https://github.com/fsschneider/DeepOBS.git#egg=DeepOBS -for the latest stable version, or +for the stable version, or - pip install -e git+https://github.com/fsschneider/DeepOBS.git@v1.2.0-beta0#egg=DeepOBS + pip install -e git+https://github.com/fsschneider/DeepOBS.git@develop#egg=DeepOBS -to get the preview of DeepOBS 1.2.0. +for the latest development version. Further tutorials and a suggested protocol for benchmarking deep learning