:py:mod:`sovabids.heuristics`
=============================

.. py:module:: sovabids.heuristics

.. autoapi-nested-parse::

   Heuristics Module

   Functions should return a dictionary.



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


Functions
~~~~~~~~~

.. autoapisummary::

   sovabids.heuristics.from_io_example



.. py:function:: from_io_example(sourcepath, targetpath)

   Get the path pattern from a source-target mapping example.

   The name of the function means "from input-output example", as one provides an input and output pair of (source,target) paths.

   :param sourcepath: The sourcepath that will be modified to get the path pattern
   :type sourcepath: str
   :param targetpath: The bidspath we are going to derive the information on.
   :type targetpath: str

   :returns:

             {
                 'pattern': The path pattern in placeholder format.
             }
   :rtype: dict