From 4e650d880f9bdfdffeb9b2a0602624994ce230bc Mon Sep 17 00:00:00 2001 From: sree314 Date: Wed, 26 Jun 2024 00:17:21 -0400 Subject: [PATCH] Document TRITON_HOME (#4210) Document the existence of `TRITON_HOME` environment variable. The `TRITON_HOME` variable controls the location of the `.triton` directory that stores, among other things, the files downloaded during a `pip install -e python` virtualenv build. By default, this is located in the user's home directory, at `~/.triton`. I was trying to build Triton on my system on a large local disk, but with limited network home directory space, and the `pip` command kept failing with out of disk space errors. It turned out that during installation, large files were downloaded to the `~/.triton` directory causing failure. After checking that it was not `pip` doing this, I found the `TRITON_HOME` variable which allowed me to workaround the issue and build Triton successfully. After seconding #4007, I decided to contribute this documentation fix. Co-authored-by: sree --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index ac04d1298cbe..9da8241156c8 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,11 @@ arbitrary LLVM version. - Set `TRITON_BUILD_WITH_CCACHE=true` to build with ccache. +- Set `TRITON_HOME=/some/path` to change the location of the `.triton` + directory where Triton's cache is located and downloads are stored + during the build. By default, this is the user's home directory. It + can be changed anytime. + - Pass `--no-build-isolation` to `pip install` to make nop builds faster. Without this, every invocation of `pip install` uses a different symlink to cmake, and this forces ninja to rebuild most of the `.a` files.