:py:mod:`mlair.workflows.abstract_workflow`
===========================================

.. py:module:: mlair.workflows.abstract_workflow

.. autoapi-nested-parse::

   Abstract workflow.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   mlair.workflows.abstract_workflow.Workflow




Attributes
~~~~~~~~~~

.. autoapisummary::

   mlair.workflows.abstract_workflow.__author__
   mlair.workflows.abstract_workflow.__date__


.. py:data:: __author__
   :annotation: = Lukas Leufen

   

.. py:data:: __date__
   :annotation: = 2020-06-26

   

.. py:class:: Workflow(name=None, log_level_stream=None)

   Abstract workflow class to handle sequence of stages (run modules). An inheriting class has to first initialise
   this mother class and can afterwards add an arbitrary number of stages by using the add method. The execution order
   is equal to the ordering of the stages have been added. To run the workflow, finally, a single call of the run
   method is sufficient. It must be taken care for inter-stage dependencies, this workflow class only handles the
   execution but not the dependencies (workflow would probably fail in this case).

   .. py:method:: add(self, stage, **kwargs)

      Add a new stage with optional kwargs.


   .. py:method:: run(self)

      Run workflow embedded in a run environment and according to the stage's ordering.