gigl.env.constants#

Environment-variable keys used across GiGL.

These keys are set either on component-process os.environ by gigl.src.common.utils.gigl_runtime.initialize_gigl_runtime or on launched process envs by gigl.src.common.custom_launcher.launch_custom and gigl.src.common.vertex_ai_launcher so that receiving CLIs can os.environ.get(...) their runtime context.

GIGL_RESOURCE_CONFIG_URI is also written to the parent os.environ by gigl.env.pipelines_config.get_resource_config so that downstream readers (e.g. GiglResourceConfigWrapper.get_resource_config_uri) can recover the value within the same process. Use read_resource_config_uri_from_env() to read it; that helper also falls back to the deprecated RESOURCE_CONFIG_PATH with a one-time warning.

Attributes#

`GIGL_APPLIED_TASK_IDENTIFIER_ENV_KEY`
`GIGL_COMPONENT_ENV_KEY`
`GIGL_CPU_DOCKER_URI_ENV_KEY`
`GIGL_CUDA_DOCKER_URI_ENV_KEY`
`GIGL_RESOURCE_CONFIG_URI_ENV_KEY`
`GIGL_TASK_CONFIG_URI_ENV_KEY`

Functions#

read_resource_config_uri_from_env()

Read the resource-config URI from the environment.

Module Contents#

gigl.env.constants.read_resource_config_uri_from_env()[source]#

Read the resource-config URI from the environment.

Prefers GIGL_RESOURCE_CONFIG_URI. Falls back to the deprecated RESOURCE_CONFIG_PATH and emits a one-time warning if that path is taken.

Returns:: The URI string if set under either name, else None.
Return type:: Optional[str]

gigl.env.constants.GIGL_APPLIED_TASK_IDENTIFIER_ENV_KEY: Final[str] = 'GIGL_APPLIED_TASK_IDENTIFIER'[source]#

gigl.env.constants.GIGL_COMPONENT_ENV_KEY: Final[str] = 'GIGL_COMPONENT'[source]#

gigl.env.constants.GIGL_CPU_DOCKER_URI_ENV_KEY: Final[str] = 'GIGL_CPU_DOCKER_URI'[source]#

gigl.env.constants.GIGL_CUDA_DOCKER_URI_ENV_KEY: Final[str] = 'GIGL_CUDA_DOCKER_URI'[source]#

gigl.env.constants.GIGL_RESOURCE_CONFIG_URI_ENV_KEY: Final[str] = 'GIGL_RESOURCE_CONFIG_URI'[source]#

gigl.env.constants.GIGL_TASK_CONFIG_URI_ENV_KEY: Final[str] = 'GIGL_TASK_CONFIG_URI'[source]#