:py:mod:`gnn_tracking_hpo.util.paths`
=====================================

.. py:module:: gnn_tracking_hpo.util.paths


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


Functions
~~~~~~~~~

.. autoapisummary::

   gnn_tracking_hpo.util.paths.find_result_dir
   gnn_tracking_hpo.util.paths.find_checkpoint
   gnn_tracking_hpo.util.paths.get_config
   gnn_tracking_hpo.util.paths.add_scripts_path



Attributes
~~~~~~~~~~

.. autoapisummary::

   gnn_tracking_hpo.util.paths._default_base_path


.. py:data:: _default_base_path

   

.. py:function:: find_result_dir(project: str, part: str, *, base_path=_default_base_path) -> pathlib.Path

   Find result dir of a trial

   :param project: Ray project name/folder
   :param part: Part of filename of trial (part of the hash)
   :param base_path: Path to ray folder

   :returns: Path to result dir


.. py:function:: find_checkpoint(project: str, part: str, epoch: int = -1, *, base_path=_default_base_path) -> pathlib.Path

   Find checkpoints

   :param project: Ray project name/folder
   :param part: Part of filename of trial (part of the hash)
   :param epoch: Epoch to which the checkpoint should belong. If -1, the last
                 epoch will be taken
   :param base_path: Path to ray folder

   :returns: Path to `checkpoint.pt` file


.. py:function:: get_config(project: str, part: str, *, base_path=_default_base_path) -> dict[str, Any]

   Get config of a trial

   :param project: Ray project name/folder
   :param part: Part of filename of trial (part of the hash)
   :param base_path: Path to ray folder

   :returns: Config of trial


.. py:function:: add_scripts_path() -> None

   Add the path of the scripts directory of this repository to
   the python PATH in order to import from there.