Metadata-Version: 2.0
Name: sacred
Version: 0.5.1
Summary: Facilitates automated and reproducible experimental research
Home-page: https://github.com/Qwlouse/sacred
Author: Klaus Greff
Author-email: qwlouse@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Utilities
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: docopt
Requires-Dist: wrapt

Sacred
======

    | *Every experiment is sacred*
    | *Every experiment is great*
    | *If an experiment is wasted*
    | *God gets quite irate*

.. image:: http://img.shields.io/pypi/v/sacred.png
    :target: https://pypi.python.org/pypi/sacred
    :alt: Current PyPi Version

.. image:: http://img.shields.io/badge/license-MIT-blue.png
    :target: http://choosealicense.com/licenses/mit/
    :alt: MIT licensed

.. image:: https://readthedocs.org/projects/sacred/badge/?version=latest
    :target: http://sacred.readthedocs.org/
    :alt: ReadTheDocs

.. image:: https://travis-ci.org/Qwlouse/sacred.svg
    :target: https://travis-ci.org/Qwlouse/sacred
    :alt: Travis-CI Status

.. image:: https://coveralls.io/repos/Qwlouse/sacred/badge.png
    :target: https://coveralls.io/r/Qwlouse/sacred
    :alt: Coverage Report

.. image:: https://scrutinizer-ci.com/g/Qwlouse/sacred/badges/quality-score.png?b=master
    :target: https://scrutinizer-ci.com/g/Qwlouse/sacred/
    :alt: Code Scrutinizer Quality

.. image:: https://pypip.in/wheel/sacred/badge.png
    :target: https://pypi.python.org/pypi/sacred/
    :alt: Wheel Status


Sacred is a tool to help you configure, organize, log and reproduce experiments.
It is designed to do all the tedious overhead work that you need to do around
your actual experiment in order to:

- keep track of all the parameters of your experiment
- easily run your experiment for different settings
- save configurations for individual runs in a database
- reproduce your results

In Sacred we achieve this through the following main mechanisms:

-  **ConfigScopes** A very convenient way of the local variables in a function
   to define the parameters your experiment uses.
-  **Config Injection**: You can access all parameters of your configuration
   from every function. They are automatically injected by name.
-  **Command-line interface**: You get a powerful command-line interface for each
   experiment that you can use to change parameters and run different variants.
-  **Observers**: Sacred provides Observers that log all kinds of information
   about your experiment, its dependencies, the configuration you used,
   the machine it is run on, and of course the result. These can be saved
   to a MongoDB, for easy access later.
-  **Automatic seeding** helps controlling the randomness in your experiments,
   such that the results remain reproducible.


Documentation
-------------
The documentation is hosted at `ReadTheDocs <http://sacred.readthedocs.org/>`_.

Installing
----------
You can directly install it from the Python Package Index with pip:

    pip install sacred

Or if you want to do it manually you can checkout the current version from git
and install it yourself:

   | git clone https://github.com/Qwlouse/sacred.git
   | cd sacred
   | python setup.py install

You might want to also install the ``numpy`` and the ``pymongo`` packages. They are
optional dependencies but they offer some cool features:

    pip install numpy, pymongo

Tests
-----
The tests for sacred use the `py.test <http://pytest.org/latest/>`_ package.
You can execute them like this:

    python setup.py test

There is also a config file for `tox <https://testrun.org/tox/latest/>`_ so you
can automatically run the tests for various python versions like this:

    tox


License
-------
This project is released under the terms of the `MIT license <http://opensource.org/licenses/MIT>`_.


