hparam support (#470)

* hparam support * add test and doc * fix test for py2 * fix CI test again * minor improves * further improvements
lanpa · Jul 16, 2019 · dce4fb1 · dce4fb1
1 parent a66b1ac
commit dce4fb1
Show file tree

Hide file tree

Showing 11 changed files with 2,012 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 Write TensorBoard events with simple function call.
 
-* Support `scalar`, `image`, `figure`, `histogram`, `audio`, `text`, `graph`, `onnx_graph`, `embedding`, `pr_curve`, `mesh`
+* Support `scalar`, `image`, `figure`, `histogram`, `audio`, `text`, `graph`, `onnx_graph`, `embedding`, `pr_curve`, `mesh`, `hyper-parameters`
   and `video` summaries.
 
 * requirement for `demo_graph.py` is tensorboardX>=1.6 and pytorch>=1.1

diff --git a/docs/_static/img/tensorboard/add_hparam.png b/docs/_static/img/tensorboard/add_hparam.png
diff --git a/examples/demo_hparams.py b/examples/demo_hparams.py
@@ -0,0 +1,24 @@
+from tensorboardX import SummaryWriter
+import time
+import random
+
+
+hparam = {'lr': [0.1, 0.01, 0.001],
+          'bsize': [1, 2, 4],
+          'n_hidden': [100, 200]}
+
+metrics = {'accuracy', 'loss'}
+
+def train(lr, bsize, n_hidden):
+    x = random.random()
+    return x, x*5
+
+with SummaryWriter() as w:
+    for lr in hparam['lr']:
+        for bsize in hparam['bsize']:
+            for n_hidden in hparam['n_hidden']:
+                accu, loss = train(lr, bsize, n_hidden)
+
+                w.add_hparams({'lr': lr, 'bsize': bsize, 'n_hidden': n_hidden},
+                                    {'accuracy': accu, 'loss': loss})
+