ExAssist 0.3.6

Experiment Assist

ExAssist
========

|build-status| |docs|

``ExAssist`` is an light-weight assist tool that can save your time from doing experiments.
It is designed to help you with:

1. Track the configurations for each experiment.
2. Record any temporary data during experiments.
3. Gather host information for each experiment.

Installation
============

.. code:: python

pip install ExAssist

Example
=======

1. Download the `template files <http://exassist.zhouyichu.com/en/latest/_downloads/templates.zip>`_ into your experiment root directory.

2. Write up your experiments in ``main.py``:

.. code:: python

import ExAssist as EA

# Get an instance of ExAssist just like getting a logger.
assist = EA.getAssist('Test')
with EA.start(assist) as assist:
# Here starts your experiments.
for i in range(100):
assist.info['loss'] = 100 - i
assist.step()

3. Run your experiment:

.. code:: console

python main.py

More details, please see `<http://exassist.zhouyichu.com/en/latest/quickstart.html>`_.

Documents
=========

`<http://exassist.zhouyichu.com/en/latest/>`_

.. |docs| image:: https://readthedocs.org/projects/exassist/badge/?version=latest
:target: http://exassist.readthedocs.io/en/latest/?badge=latest
:scale: 100%
:alt: Documentation Status

.. |build-status| image:: https://travis-ci.org/flyaway1217/ExAssist.svg?branch=master
:target: https://travis-ci.org/flyaway1217/ExAssist