/Whetlab-Python-Client

The Whetlab Python-Client

Primary LanguagePythonOtherNOASSERTION

Welcome to Whetlab!

Whetlab automates the tuning of your favorite tool and optimizes its performance.

What "tool" you ask? Well, it could be a lot of things. It could be a piece of software, whose performance is controlled by a few parameters (such as a compression computer program or a machine learning algorithm), or it could even be a complicated physical process (such as the manufacture of a device or even a cooking recipe). As long as your tool has a few knobs which you can crank up or down in order to impact its performance, Whetlab can help you!

Whetlab works by suggesting tests you should run with your tool in order to improve it. Once you have the result of these tests, you tell Whetlab how they turned out and it will suggest new tests, and so on until you're satisfied with the improved performance of your tool.

Installation Instructions

Installation is really simple. Simply navigate to the directory containing whetlab.py and type:

python setup.py install

Getting Started

We have written up a tutorial to get you up and running quickly with whetlab. If you're feeling really impatient there are also a number of example scripts in this directory to demonstrate the usage of the Python client. Just log in to Whetlab, navigate to the Account page and grab your api token to get started.