gigl.src.common.utils.gigl_env#

Helpers for constructing GiGL runtime environment variables.

Functions#

get_gigl_runtime_env_vars(applied_task_identifier, ...)

Build standard GiGL runtime environment variables.

Module Contents#

gigl.src.common.utils.gigl_env.get_gigl_runtime_env_vars(applied_task_identifier, task_config_uri, resource_config_uri, component, cpu_docker_uri=None, cuda_docker_uri=None)[source]#

Build standard GiGL runtime environment variables.

Parameters:

  • applied_task_identifier (str) – Unique identifier for the GiGL job.

  • task_config_uri (gigl.common.Uri) – URI to the task config YAML file.

  • resource_config_uri (gigl.common.Uri) – URI to the resource config YAML file.

  • component (gigl.src.common.constants.components.GiGLComponents) – GiGL component being initialized.

  • cpu_docker_uri (Optional[str]) – CPU source image URI. Defaults to the release CPU image.

  • cuda_docker_uri (Optional[str]) – CUDA source image URI. Defaults to the release CUDA image.

Returns:

A mapping of standard GiGL environment variable names to values.

Return type:

dict[str, str]