.. _surround-api:

API Reference
*****************
Here you can find documentation on all classes and their methods in Surround.

.. _assembler:   

Assembler
========

.. autoclass:: surround.assembler.Assembler
    :members:

.. automodule:: surround

    Config
    ^^^^^^
    
    .. autoclass:: surround.config.Config       
        :members:          
 
        .. automodule:: surround  
 
    State                              
    ^^^^^   
                
    .. autoclass:: surround.State        
        :members:                   

    .. automodule:: surround.stage

    Stage
    ^^^^^
    
    .. autoclass:: surround.stage.Stage
        :members:

    Estimator
    ^^^^^^^^^

    .. autoclass:: surround.stage.Estimator
        :members:

Runner
=======
.. autoclass:: surround.runners.Runner  
    :members:

Data Container
==============

.. autoclass:: surround.data.container.DataContainer
    :members:

Metadata
========

.. autoclass:: surround.data.metadata.Metadata
    :members: