Document VH_TPU

valohai · Mar 23, 2020 · b41c2b6 · b41c2b6
1 parent 4c19be7
commit b41c2b6
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/source/executions/envvar-config/index.rst b/source/executions/envvar-config/index.rst
@@ -27,3 +27,12 @@ By default, Valohai defines the following environment variables:
 
     In your code, you can check if ``VH_JOB_ID`` exists to know if you are running on Valohai.
 
+
+Special environment variables
+-----------------------------
+
+``VH_TPU``
+  For private environments where Google Cloud TPU is enabled, this environment variable will contain the GRPC endpoint(s)
+  of the allocated Cloud TPU(s), separated by spaces.  This may be passed in as the argument for ``TPUClusterResolver``,
+  e.g. ``TPUClusterResolver(tpu=os.environ["VH_TPU"].split()).get_master()``or similar.
+  When TPUs are not enabled, this variable will not be set.