bitorch_engine.utils.mlx_path.get_mlx_include_path

bitorch_engine.utils.mlx_path.get_mlx_include_path() → str | None

Attempts to find the include path for the mlx library.

This function searches for the ‘mlx.h’ header file associated with the mlx library in various possible locations where the library might be installed. The search follows this order: 1. Looks within the package’s submodule search locations if the mlx package is installed. 2. Checks the system’s default include path under the Python environment’s prefix. 3. Scans paths specified in the ‘CPATH’ environment variable.

Returns:

The absolute path to the directory containing ‘mlx.h’ if found. None: If the ‘mlx.h’ file cannot be found in any of the searched locations.

Return type:

str