From 11ccf6634607f45c8cd15c0b54d52d47d800addf Mon Sep 17 00:00:00 2001
From: Ashwinee Panda <kiddyboots216@berkeley.edu>
Date: Mon, 24 Jun 2019 11:26:53 -0700
Subject: [PATCH] [docs] docs for running Tensorboard without sudo (#5015)

* Instructions for running Tensorboard without sudo

When we run Tensorboard to visualize the results of Ray outputs on multi-user clusters where we don't have sudo access, such as RISE clusters, a few commands need to first be run to make sure tensorboard can edit the tmp directory. This is a pretty common usecase so I figured we may as well put it in the documentation for Tune.

* Update tune-usage.rst
---
 doc/source/tune-usage.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/source/tune-usage.rst b/doc/source/tune-usage.rst
index 281ccbd6107e0..e8ce405d94572 100644
--- a/doc/source/tune-usage.rst
+++ b/doc/source/tune-usage.rst
@@ -355,6 +355,12 @@ Then, after you run a experiment, you can visualize your experiment with TensorB
 
     $ tensorboard --logdir=~/ray_results/my_experiment
 
+If you are running Ray on a remote multi-user cluster where you do not have sudo access, you can run the following commands to make sure tensorboard is able to write to the tmp directory:
+
+.. code-block:: bash
+
+    $ export TMPDIR=/tmp/$USER; mkdir -p $TMPDIR; tensorboard --logdir=~/ray_results
+
 .. image:: ray-tune-tensorboard.png
 
 To use rllab's VisKit (you may have to install some dependencies), run: