# Quick Start¶

DeepOBS is a Python package to benchmark deep learning optimizers. It currently supports TensorFlow but a PyTorch version is currently in development.

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.

## Installation¶

You can install the latest stable release of DeepOBS using pip:

pip install deepobs


Note

The package requires the following packages:

• argparse
• numpy
• pandas
• matplotlib
• matplotlib2tikz
• seaborn

TensorFlow is not a required package to allow for both the CPU and GPU version. Make sure that one of those is installed.

Hint

We do not specify the exact version of the required package. However, if any problems occur while using DeepOBS, it might be a good idea to upgrade those packages to the newest release (especially matplotlib and numpy).

## Set-Up Data Sets¶

After installing DeepOBS, you have to download the data sets for the test problems. This can be done by simply running the Prepare Data script:

deepobs_prepare_data.sh


This will automatically download, sort and prepare all the data sets (except ImageNet) in a folder called data_deepobs in the current directory. It can take a while, as it will download roughly 1 GB.

Note

The ImageNet data set is currently excluded from this automatic downloading and preprocessing. ImageNet requires a registration to do this and has a total size of hundreds of GBs. You can download it and add it to the imagenet folder by yourself if you wish to use the ImageNet data set.

Hint

If you already have some of the data sets on your computer, you can only download the rest. If you have all data sets, you can skip this step, and always tell DeepOBS where the data sets are located. However, the DeepOBS package requires the data sets to be organized in a specific way.

You are now ready to run different optimizers on various test problems. We provide a Simple Example for this, as well as our Suggested Protocol for benchmarking deep learning optimizers.

## Contributing to DeepOBS¶

If you want to see a certain data set or test problem added to DeepOBS, you can just fork DeepOBS, and implemented following the structure of the existing modules and create a pull-request. We are very happy to expand DeepOBS with more data sets and models.

We also invite the authors of other optimization algorithms to add their own method to the benchmark. Just edit a run script to include the new optimization method and create a pull-request.

Provided that this new optimizer produces competitive results, we will add the results to the set of provided baselines.