Add Tensorboard command to example script docstrings

tensorflow · May 13, 2019 · 0d4818c · 0d4818c
1 parent c170034
commit 0d4818c
Show file tree

Hide file tree

Showing 18 changed files with 35 additions and 3 deletions.
diff --git a/tf_agents/agents/ddpg/examples/v1/train_eval.py b/tf_agents/agents/ddpg/examples/v1/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/ddpg_v1/gym/HalfCheetah-v2/ --port 2223 &
+
 python tf_agents/agents/ddpg/examples/v1/train_eval.py \
   --root_dir=$HOME/tmp/ddpg_v1/gym/HalfCheetah-v2/ \
   --num_iterations=2000000 \

diff --git a/tf_agents/agents/ddpg/examples/v1/train_eval_rnn.py b/tf_agents/agents/ddpg/examples/v1/train_eval_rnn.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/ddpg_rnn_v1/dm/CartPole-Balance/ --port 2223 &
+
 python tf_agents/agents/ddpg/examples/v1/train_eval_rnn.py \
   --root_dir=$HOME/tmp/ddpg_rnn_v1/dm/CartPole-Balance/ \
   --num_iterations=2000000 \

diff --git a/tf_agents/agents/ddpg/examples/v2/train_eval.py b/tf_agents/agents/ddpg/examples/v2/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/ddpg/gym/HalfCheetah-v2/ --port 2223 &
+
 python tf_agents/agents/ddpg/examples/v2/train_eval.py \
   --root_dir=$HOME/tmp/ddpg/gym/HalfCheetah-v2/ \
   --num_iterations=2000000 \

diff --git a/tf_agents/agents/ddpg/examples/v2/train_eval_rnn.py b/tf_agents/agents/ddpg/examples/v2/train_eval_rnn.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/ddpg_rnn/dm/CartPole-Balance/ --port 2223 &
+
 python tf_agents/agents/ddpg/examples/v2/train_eval_rnn.py \
   --root_dir=$HOME/tmp/ddpg_rnn/dm/CartPole-Balance/ \
   --num_iterations=2000000 \

diff --git a/tf_agents/agents/dqn/examples/v1/oog_train_eval.py b/tf_agents/agents/dqn/examples/v1/oog_train_eval.py
@@ -23,6 +23,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/dqn_v1/gym/CartPole-v0/ --port 2223 &
+
 python tf_agents/agents/dqn/examples/v1/oog_train_eval.py \
   --root_dir=$HOME/tmp/dqn_v1/gym/CartPole-v0/ \
   --alsologtostderr

diff --git a/tf_agents/agents/dqn/examples/v1/train_eval_gym.py b/tf_agents/agents/dqn/examples/v1/train_eval_gym.py
@@ -18,8 +18,10 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/dqn_v1/gym/CartPole-v0/ --port 2223 &
+
 python tf_agents/agents/dqn/examples/v1/train_eval_gym.py \
-  --root_dir=$HOME/tmp/dqn/gym_v1/CartPole-v0/ \
+  --root_dir=$HOME/tmp/dqn_v1/gym/CartPole-v0/ \
   --alsologtostderr
 ```
 """

diff --git a/tf_agents/agents/dqn/examples/v1/train_eval_rnn_gym.py b/tf_agents/agents/dqn/examples/v1/train_eval_rnn_gym.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/dqn_rnn_v1/gym/MaskedCartPole-v0/ --port 2223 &
+
 python tf_agents/agents/dqn/examples/v1/train_eval_rnn_gym.py \
   --root_dir=$HOME/tmp/dqn_rnn_v1/gym/MaskedCartPole-v0/ \
   --alsologtostderr

diff --git a/tf_agents/agents/dqn/examples/v2/train_eval.py b/tf_agents/agents/dqn/examples/v2/train_eval.py
@@ -18,6 +18,8 @@
 To run DQN on CartPole:
 
 ```bash
+tensorboard --logdir $HOME/tmp/dqn/gym/CartPole-v0/ --port 2223 &
+
 python tf_agents/agents/dqn/examples/v2/train_eval.py \
  --root_dir=$HOME/tmp/dqn/gym/CartPole-v0/ \
  --alsologtostderr

diff --git a/tf_agents/agents/ppo/examples/v1/train_eval.py b/tf_agents/agents/ppo/examples/v1/train_eval.py
@@ -18,7 +18,7 @@
 To run:
 
 ```bash
-tensorboard --logdir ~/tmp/ppo --port 2223 &
+tensorboard --logdir $HOME/tmp/ppo_v1/gym/HalfCheetah-v2/ --port 2223 &
 
 python tf_agents/agents/ppo/examples/v1/train_eval.py \
   --root_dir=$HOME/tmp/ppo_v1/gym/HalfCheetah-v2/ \

diff --git a/tf_agents/agents/ppo/examples/v2/train_eval.py b/tf_agents/agents/ppo/examples/v2/train_eval.py
@@ -18,7 +18,7 @@
 To run:
 
 ```bash
-tensorboard --logdir ~/tmp/ppo --port 2223 &
+tensorboard --logdir $HOME/tmp/ppo/gym/HalfCheetah-v2/ --port 2223 &
 
 python tf_agents/agents/ppo/examples/v2/train_eval.py \
   --root_dir=$HOME/tmp/ppo/gym/HalfCheetah-v2/ \

diff --git a/tf_agents/agents/reinforce/examples/v1/train_eval.py b/tf_agents/agents/reinforce/examples/v1/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/reinforce_v1/gym/CartPole-v0/ --port 2223 &
+
 python tf_agents/agents/reinforce/examples/v1/train_eval.py \
   --root_dir=$HOME/tmp/reinforce_v1/gym/CartPole-v0/ \
   --alsologtostderr

diff --git a/tf_agents/agents/reinforce/examples/v2/train_eval.py b/tf_agents/agents/reinforce/examples/v2/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/reinforce/gym/CartPole-v0/ --port 2223 &
+
 python tf_agents/agents/reinforce/examples/v2/train_eval.py \
   --root_dir=$HOME/tmp/reinforce/gym/CartPole-v0/ \
   --alsologtostderr

diff --git a/tf_agents/agents/sac/examples/v1/train_eval.py b/tf_agents/agents/sac/examples/v1/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/sac_v1/gym/HalfCheetah-v2/ --port 2223 &
+
 python tf_agents/agents/sac/examples/v1/train_eval.py \
   --root_dir=$HOME/tmp/sac_v1/gym/HalfCheetah-v2/ \
   --alsologtostderr

diff --git a/tf_agents/agents/sac/examples/v2/train_eval.py b/tf_agents/agents/sac/examples/v2/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/sac/gym/HalfCheetah-v2/ --port 2223 &
+
 python tf_agents/agents/sac/examples/v2/train_eval.py \
   --root_dir=$HOME/tmp/sac/gym/HalfCheetah-v2/ \
   --alsologtostderr

diff --git a/tf_agents/agents/td3/examples/v1/train_eval.py b/tf_agents/agents/td3/examples/v1/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/td3_v1/gym/HalfCheetah-v2/ --port 2223 &
+
 python tf_agents/agents/td3/examples/v1/train_eval.py \
   --root_dir=$HOME/tmp/td3_v1/gym/HalfCheetah-v2/ \
   --num_iterations=2000000 \

diff --git a/tf_agents/agents/td3/examples/v1/train_eval_rnn.py b/tf_agents/agents/td3/examples/v1/train_eval_rnn.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/td3_rnn_v1/dm/CartPole-Balance/ --port 2223 &
+
 python tf_agents/agents/td3/examples/v1/train_eval_rnn.py \
   --root_dir=$HOME/tmp/td3_rnn_v1/dm/CartPole-Balance/ \
   --alsologtostderr

diff --git a/tf_agents/agents/td3/examples/v2/train_eval.py b/tf_agents/agents/td3/examples/v2/train_eval.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/td3/gym/HalfCheetah-v2/ --port 2223 &
+
 python tf_agents/agents/td3/examples/v2/train_eval.py \
   --root_dir=$HOME/tmp/td3/gym/HalfCheetah-v2/ \
   --num_iterations=2000000 \

diff --git a/tf_agents/agents/td3/examples/v2/train_eval_rnn.py b/tf_agents/agents/td3/examples/v2/train_eval_rnn.py
@@ -18,6 +18,8 @@
 To run:
 
 ```bash
+tensorboard --logdir $HOME/tmp/td3_rnn/dm/CartPole-Balance/ --port 2223 &
+
 python tf_agents/agents/td3/examples/v2/train_eval_rnn.py \
   --root_dir=$HOME/tmp/td3_rnn/dm/CartPole-Balance/ \
   --alsologtostderr