hydraclick.run
==============

.. py:module:: hydraclick.run


Attributes
----------

.. autoapisummary::

   hydraclick.run._logger


Functions
---------

.. autoapisummary::

   hydraclick.run.get_hydra_configs
   hydraclick.run._run_sequential
   hydraclick.run._run_parallel
   hydraclick.run.run_function


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

.. py:data:: _logger

.. py:function:: get_hydra_configs(config_file, hydra_args)

   Load the necessary configuration for running click commands from a config.yaml file.

   :param config_file: Path to the target config.yaml file. If None, the default             config file is loaded.
   :param hydra_args: Arguments passed to hydra for composing the project configuration.

   :returns: list of all the resolved configurations specified by the command arguments.
   :rtype: configs


.. py:function:: _run_sequential(function, configs, num_shards = 0)

   Run the sweep sequentially.


.. py:function:: _run_parallel(function, configs, num_shards = 0)

   Run the sweep sequentially.


.. py:function:: run_function(function, config_file = None, hydra_args = None, multirun = True, parallel = False, num_shards = 0, only_config = False)

   Run the function.