Fix is_active / add explanation (closes #47), added disclaimer (closes …

…#46).
chrisranderson · Oct 3, 2017 · bbc75be · bbc75be
1 parent d45da7b
commit bbc75be
Show file tree

Hide file tree

Showing 2 changed files with 95 additions and 9 deletions.
diff --git a/beholder/client_side/beholder-dashboard.html b/beholder/client_side/beholder-dashboard.html
@@ -141,16 +141,55 @@
           </paper-button>
         </div>
 
+        <div class="sidebar-section">
+          <p class="disclaimer"><i>Note: Beholder currently only works well on local file systems.</i></p>
+        </div>
+
       </div>
       <div class="center">
 
-        <beholder-video id="video"> </beholder-video>
+        <template is="dom-if" if="[[!_is_active]]">
+          <div class="no-data-warning">
+            <h3>No Beholder data was found.</h3>
 
-        <template is="dom-if" if="[[_valuesNotFrame(_values)]]">
-          <beholder-info
-            id="info"
-            fps="[[_FPS]]">
-          </beholder-info>
+            <p>Probable causes:</p>
+            <ul>
+              <li>Your script isn't running.</li>
+              <li>You aren't calling the <pre>update</pre> function.</li>
+            </ul>
+
+            <p>To use Beholder, import and instantiate the Beholder class:</p>
+
+            <pre>
+from beholder.beholder import Beholder
+visualizer = Beholder(session=sess,
+                      logdir=LOG_DIRECTORY)</pre>
+
+            <p>And call the update function after every train step (both arguments are optional):</p>
+
+            <pre>
+visualizer.update(
+  arrays=list_of_np_arrays,
+  frame=two_dimensional_np_array,
+)</pre>
+
+            <p>If you think everything is set up properly, please see
+            <a href="https://github.com/chrisranderson/beholder/">the README</a>
+            for more information and consider <a href="https://github.com/chrisranderson/beholder/issues/new">filing an issue on GitHub</a>.</p>
+
+            <p class="disclaimer"><i>Note: Beholder currently only works well on local file systems.</i></p>
+          </div>
+        </template>
+
+        <template is="dom-if" if="[[_is_active]]">
+          <beholder-video id="video"></beholder-video>
+
+          <template is="dom-if" if="[[_valuesNotFrame(_values)]]">
+            <beholder-info
+              id="info"
+              fps="[[_FPS]]">
+            </beholder-info>
+          </template>
         </template>
 
       </div>
@@ -162,41 +201,51 @@
         display: flex;
         padding: 0;
       }
+
       .no-data-warning {
         max-width: 540px;
         margin: 80px auto 0 auto;
       }
+
       .title {
         font-size: 16px;
         margin: 8px 5px 8px 0;
         color: black;
       }
+
       .title small {
         font-weight: normal;
       }
+
       paper-checkbox {
         display: block;
         padding: 4px;
       }
+
       paper-radio-button {
         display: block;
         padding: 5px;
       }
+
       paper-radio-group {
         margin-top: 5px;
       }
+
       paper-slider {
         margin-left: 12px;
         --paper-slider-knob-color: var(--tb-orange-strong);
         --paper-slider-active-color: var(--tb-orange-strong);
         flex-grow: 2;
       }
+
       pre {
         display: inline;
       }
+
       paper-button#record_button {
         color: #D32F2F;
       }
+
       paper-button#record_button.is-recording {
         background: #D32F2F;
         color: white;
@@ -210,14 +259,25 @@
         display: flex;
         margin-top: 5px;
       }
+
       #colormap-selection-label {
         margin-top: 13px;
       }
+
       #colormap-selection paper-dropdown-menu {
         margin-left: 10px;
         --paper-input-container-focus-color: var(--tb-orange-strong);
         width: 105px;
       }
+
+      .sidebar {
+        max-width: 350px;
+      }
+
+      p.disclaimer {
+        color: #999;
+      }
+
     </style>
   </template>
   <script>
@@ -296,7 +356,12 @@
           type: String,
           value: 'magma',
           observer: '_configChanged'
-        }
+        },
+
+        _is_active: {
+          type: Boolean,
+          value: false,
+        },
       },
 
       _valuesNotFrame(values) {
@@ -353,7 +418,16 @@
         this.$.record_button.classList.toggle('is-recording')
       },
 
+      ready() {
+        this.reload()
+      },
+
       reload() {
+        const url = getRouter().pluginRoute(PLUGIN_NAME, '/is-active');
+
+        this._requestManager.request(url).then(response => {
+          this.set('_is_active', response['is_active'])
+        })
       },
     });
   </script>

diff --git a/beholder/server_side/beholder_plugin.py b/beholder/server_side/beholder_plugin.py
@@ -42,18 +42,30 @@ def __init__(self, context):
       write_pickle(DEFAULT_CONFIG, '{}/{}'.format(self.PLUGIN_LOGDIR,
                                                   CONFIG_FILENAME))
 
+
   def get_plugin_apps(self):
     return {
         '/change-config': self._serve_change_config,
         '/beholder-frame': self._serve_beholder_frame,
         '/section-info': self._serve_section_info,
         '/ping': self._serve_ping,
-        '/tags': self._serve_tags
+        '/tags': self._serve_tags,
+        '/is-active': self._serve_is_active,
     }
 
 
   def is_active(self):
-    return True
+    summary_filename = '{}/{}'.format(self.PLUGIN_LOGDIR, SUMMARY_FILENAME)
+    info_filename = '{}/{}'.format(self.PLUGIN_LOGDIR, SECTION_INFO_FILENAME)
+    return tf.gfile.Exists(summary_filename) and\
+           tf.gfile.Exists(info_filename)
+
+
+  @wrappers.Request.application
+  def _serve_is_active(self, request):
+    return http_util.Respond(request,
+                             {'is_active': self.is_active()},
+                             'application/json')
 
 
   def _fetch_current_frame(self):