scaffold.hydra.initialize
=========================

.. py:module:: scaffold.hydra.initialize


Functions
---------

.. autoapisummary::

   scaffold.hydra.initialize.initialize


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

.. py:function:: initialize(config_dir: Optional[str] = None, job_name: Optional[str] = 'app', exists_ok: Optional[bool] = True) -> Iterator[hydra.core.global_hydra.GlobalHydra]

   Context manager, that either uses an existing hydra instance, or initializes one temporarily.

   .. deprecated::
       This helper is no longer needed in most cases. Use hydra's own ``hydra.initialize`` directly,
       or define configs with ``hydra_zen.builds()`` and ``hydra_zen.ZenStore`` which do not require
       manual initialization. This function will be removed in a future release.

   :param config_dir: Absolute directory that should be added to the search path.
   :type config_dir: Optional[str]
   :param job_name: hydra.job.name which should be set.
   :type job_name: Optional[str]
   :param exists_ok: Do not fail if hydra is already initialized and yield GlobalHydra.instance().
   :type exists_ok: Optional[bool]