diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..7aecd4bd --- /dev/null +++ b/.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... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..b78e383d --- /dev/null +++ b/.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 ... 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 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 diff --git a/README.md b/README.md index 5d9a529e..512401b3 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) @@ -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/ 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, +)