aitune.utils.env_vars

View as Markdown

Environment variables for AITune.

Module Contents

Functions

NameDescription
get_bool_env_variableGet a boolean environment variable.

Data

AITUNE_CACHE_DIR

AITUNE_DIFFUSERS_INTEGRATION

AITUNE_JIT_CACHE_DIR

AITUNE_NVTX_EVENTS

AITUNE_TRANSFORMERS_INTEGRATION

CONSOLE_OUTPUT_ENABLE

HARDWARE_METRICS_ENABLED

HARDWARE_METRICS_PATH

TUNING_DATA_PATH

_CACHE_DIR

API

aitune.utils.env_vars.get_bool_env_variable(
env_variable: str,
default: bool
) -> bool

Get a boolean environment variable.

Parameters:

env_variable
str

The name of the environment variable.

default
bool

The default value if the environment variable is not set.

Returns: bool

The value of the environment variable.

aitune.utils.env_vars.AITUNE_CACHE_DIR = Path(os.environ.get('AITUNE_CACHE_DIR', _CACHE_DIR / 'aitune'))
aitune.utils.env_vars.AITUNE_DIFFUSERS_INTEGRATION = get_bool_env_variable('AITUNE_DIFFUSERS_INTEGRATION', False)
aitune.utils.env_vars.AITUNE_JIT_CACHE_DIR = Path(os.environ.get('AITUNE_JIT_CACHE_DIR', _CACHE_DIR / 'aitune.jit'))
aitune.utils.env_vars.AITUNE_NVTX_EVENTS = get_bool_env_variable('AITUNE_NVTX_EVENTS', False)
aitune.utils.env_vars.AITUNE_TRANSFORMERS_INTEGRATION = get_bool_env_variable('AITUNE_TRANSFORMERS_INTEGRATION', True)
aitune.utils.env_vars.CONSOLE_OUTPUT_ENABLE = get_bool_env_variable('AITUNE_CONSOLE_OUTPUT', False)
aitune.utils.env_vars.HARDWARE_METRICS_ENABLED = get_bool_env_variable('AITUNE_HARDWARE_METRICS', False)
aitune.utils.env_vars.HARDWARE_METRICS_PATH: str | None = os.environ.get('AITUNE_HARDWARE_METRICS_PATH')
aitune.utils.env_vars.TUNING_DATA_PATH: str | None = os.environ.get('AITUNE_TUNING_DATA_PATH')
aitune.utils.env_vars._CACHE_DIR = Path(os.environ.get('XDG_CACHE_HOME', Path.home() / '.cache'))