You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by pi...@apache.org on 2021/02/18 02:28:58 UTC
[submarine] branch master updated: SUBMARINE-733. Documentation for
tensorboard
This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new b0368d8 SUBMARINE-733. Documentation for tensorboard
b0368d8 is described below
commit b0368d8aac39a8529730c5f9d24b10a720f2cd66
Author: ByronHsu <by...@gmail.com>
AuthorDate: Thu Feb 18 10:16:10 2021 +0800
SUBMARINE-733. Documentation for tensorboard
### What is this PR for?
The instruction for tensorboard usage
### What type of PR is it?
[Documentation]
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-733
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: ByronHsu <by...@gmail.com>
Signed-off-by: Kevin <pi...@apache.org>
Closes #507 from ByronHsu/TFBOARD_DOC and squashes the following commits:
3f81245e [ByronHsu] move doc to website
4bb30080 [ByronHsu] update readme
000339a4 [ByronHsu] update readme
f61e45d4 [ByronHsu] clarify env name
fb72bf90 [ByronHsu] update readme
084ee513 [ByronHsu] update readme
61570705 [ByronHsu] update readme
1e9bbe3e [ByronHsu] add tensorboard doc
---
.../docs/assets/tensorboard-experiment-page.png | Bin 0 -> 286667 bytes
website/docs/assets/tensorboard-webpage.png | Bin 0 -> 436355 bytes
.../docs/userDocs/k8s/how-to-use-tensorboard.md | 62 +++++++++++++++++++++
3 files changed, 62 insertions(+)
diff --git a/website/docs/assets/tensorboard-experiment-page.png b/website/docs/assets/tensorboard-experiment-page.png
new file mode 100644
index 0000000..1eb0531
Binary files /dev/null and b/website/docs/assets/tensorboard-experiment-page.png differ
diff --git a/website/docs/assets/tensorboard-webpage.png b/website/docs/assets/tensorboard-webpage.png
new file mode 100644
index 0000000..8ac348c
Binary files /dev/null and b/website/docs/assets/tensorboard-webpage.png differ
diff --git a/website/docs/userDocs/k8s/how-to-use-tensorboard.md b/website/docs/userDocs/k8s/how-to-use-tensorboard.md
new file mode 100644
index 0000000..2931ee6
--- /dev/null
+++ b/website/docs/userDocs/k8s/how-to-use-tensorboard.md
@@ -0,0 +1,62 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# How to use tensorboard in submarine
+
+## Write to LogDirs by the environment variable
+
+### Environment variable
+
+- `SUBMARINE_TENSORBOARD_LOG_DIR`: Exist in every experiment container. You just need to direct your logs to `$(SUBMARINE_TENSORBOARD_LOG_DIR)` (**NOTICE: it is `()` not `{}`**), and you can inspect the process on the tensorboard webpage.
+
+### Example
+
+```
+{
+ "meta": {
+ "name": "tensorflow-tensorboard-dist-mnist",
+ "namespace": "default",
+ "framework": "TensorFlow",
+ "cmd": "python /var/tf_mnist/mnist_with_summaries.py --log_dir=$(SUBMARINE_TENSORBOARD_LOG_DIR) --learning_rate=0.01 --batch_size=20",
+ "envVars": {
+ "ENV_1": "ENV1"
+ }
+ },
+ "environment": {
+ "image": "apache/submarine:tf-mnist-with-summaries-1.0"
+ },
+ "spec": {
+ "Worker": {
+ "replicas": 1,
+ "resources": "cpu=1,memory=512M"
+ }
+ }
+}
+
+```
+
+## Connect to the tensorboard webpaage
+
+1. Open the experiment page in the workbench, and Click the `TensorBoard` button.
+
+
+
+2. Inspect the process on tensorboard page.
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org