Storage and Retrieval
=====================

.. role:: python(code)
   :language: python

Experiments
------------
The Experiment class that is used by hermes to store results also provides methods
which allow you to easily access the saved data in a structured manner.

.. autoclass:: pyhermes.storage.Experiment
   :members:

Experiment Lists
-----------------
When loading multiple experiments with :meth:`pyhermes.storage.Experiment.load_all`, hermes returns a list of experiments.

.. autoclass:: pyhermes.storage.ExperimentList
    :members:

Experiment Frames
-----------------
If you installed pandas as optional dependency, you can also transform an :class:`ExperimentList` into a special :python:`pandas.DataFrame`
that allows even more flexible access to experiments via their exec arguments.

.. autoclass:: pyhermes.storage.ExperimentFrame
    :members:

Results
=======
Hermes provides a wrapper-class around python dictionaries that tries to simplify system IO-operations,
dictionary write- and read-access and also has a rudimentary plot functionality

.. autoclass:: pyhermes.result.Result
   :members:

Evaluation Utilities
====================
Plotting
--------
The module `pyhermes.plot` provides you with a multitude of functions which can
aid you with visualizing experiment results such as training curves.

.. automodule:: pyhermes.plot
   :members: