Skip to content

Commit e1fa593

Browse files
authored
Update README with more info about beta version
1 parent 592cb18 commit e1fa593

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ DeepOBS automates several steps when benchmarking deep learning optimizers:
2727

2828
The code for the current implementation working with **TensorFlow** can be found
2929
on [Github](https://github.com/fsschneider/DeepOBS).
30+
A PyTorch version is currently developed (see News section below).
3031

3132
The full documentation is available on readthedocs:
3233
https://deepobs.readthedocs.io/
@@ -35,14 +36,19 @@ The paper describing DeepOBS has been accepted for ICLR 2019 and can be found
3536
here:
3637
https://openreview.net/forum?id=rJg6ssC5Y7
3738

38-
We are currently working on a new and improved version of DeepOBS.
39-
It will support **PyTorch** as well as TensorFlow, has an easier interface, and
40-
many bugs ironed out. It will be released in a few weeks, until then you can
41-
check out the current working beta version of it over at https://github.com/abahde/DeepOBS.
42-
4339
**If you find any bugs in DeepOBS, or find it hard to use, please let us know.
4440
We are always interested in feedback and ways to improve DeepOBS.**
4541

42+
## News
43+
44+
We are currently working on a new and improved version of DeepOBS, version 1.2.0.
45+
It will support **PyTorch** in addition to TensorFlow, has an easier interface, and
46+
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).
47+
48+
A pre-release, version 1.2.0-beta0, will be available shortly and a full release is expected in a few weeks.
49+
50+
Many thanks to [Aaron Bahde](https://github.com/abahde) for spearheading the developement of DeepOBS 1.2.0.
51+
4652
## Installation
4753

4854
pip install deepobs
@@ -51,5 +57,16 @@ We tested the package with Python 3.6 and TensorFlow version 1.12. Other
5157
versions of Python and TensorFlow (>= 1.4.0) might work, and we plan to expand
5258
compatibility in the future.
5359

60+
If you want to create a local and modifiable version of DeepOBS, you can do this directly from this repo via
61+
62+
pip install -e git+https://github.com/fsschneider/DeepOBS.git#egg=DeepOBS
63+
64+
for the latest stable version, or
65+
66+
pip install -e git+https://github.com/fsschneider/DeepOBS.git@v1.2.0-beta0#egg=DeepOBS
67+
68+
to get the preview of DeepOBS 1.2.0.
69+
70+
5471
Further tutorials and a suggested protocol for benchmarking deep learning
5572
optimizers can be found on https://deepobs.readthedocs.io/

0 commit comments

Comments
 (0)