:orphan:

API Example
==================

The example below illustrates how to use BugDoc to debug arbitrary computational pipelines. To do that, we need to write two scripts that run in separate parallel processes and communicate with each other through TCP messages.
The *Debugger* script defines the pipeline parameter space, provides an entry point for the pipeline, and calls BugDoc's API.
The second script, *Worker*, is responsible for receiving messages from BugDoc's algorithms and calling the pipeline execution engine to run a pipeline instance and evaluate its output.



.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This script is responsible for receiving pipeline configurations from BugDoc&#x27;s algorithms. It runs and evaluates the pipeline instances, and returns the result to BugDoc.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_api_interface_thumb.png
    :alt:

  :doc:`/auto_examples/api_interface`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Worker script</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This script defines the pipeline entry point, the parameter-space,  and invokes one of BugDoc&#x27;s algorithm to debug the pipeline.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_debugger_thumb.png
    :alt:

  :doc:`/auto_examples/debugger`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Debugger script</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use BugDoc&#x27;s algorithms in standalone mode without requiring ZMQ or an external worker process.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_standalone_example_thumb.png
    :alt:

  :doc:`/auto_examples/standalone_example`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Standalone Debugger Example</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/api_interface
   /auto_examples/debugger
   /auto_examples/standalone_example


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_