You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@submarine.apache.org by GitBox <gi...@apache.org> on 2021/02/04 14:22:53 UTC
[GitHub] [submarine] ByronHsu opened a new pull request #507: SUBMARINE-733. Documentation for tensorboard
ByronHsu opened a new pull request #507:
URL: https://github.com/apache/submarine/pull/507
### 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
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on a change in pull request #507: SUBMARINE-733. Documentation for tensorboard
Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #507:
URL: https://github.com/apache/submarine/pull/507#discussion_r570548091
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
Review comment:
Could you update to `` because above syntax can not be parsed by https://v2.docusaurus.io/docs/installation
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(LOG_DIR)` (**NOTICE: it is `()` not `{}`**), and you can inspect the process on the tensorboard webpage.
Review comment:
```suggestion
- `SUBMARINE_LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(LOG_DIR)` (**NOTICE: it is `()` not `{}`**), and you can inspect the process on the tensorboard webpage.
```
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
Review comment:
```suggestion
```
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
+
+2. Inspect the process on tensorboard page.
+
+<img src="../../assets/tensorboard-webpage.png">
Review comment:
```suggestion
```
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
Review comment:
https://v2.docusaurus.io/docs/static-assets/
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on a change in pull request #507: SUBMARINE-733. Documentation for tensorboard
Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #507:
URL: https://github.com/apache/submarine/pull/507#discussion_r570551726
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
Review comment:
https://v2.docusaurus.io/docs/static-assets/
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] ByronHsu commented on pull request #507: SUBMARINE-733. Documentation for tensorboard
Posted by GitBox <gi...@apache.org>.
ByronHsu commented on pull request #507:
URL: https://github.com/apache/submarine/pull/507#issuecomment-774044287
@pingsutw Thanks! I have fixed it!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] asfgit closed pull request #507: SUBMARINE-733. Documentation for tensorboard
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #507:
URL: https://github.com/apache/submarine/pull/507
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [submarine] pingsutw commented on a change in pull request #507: SUBMARINE-733. Documentation for tensorboard
Posted by GitBox <gi...@apache.org>.
pingsutw commented on a change in pull request #507:
URL: https://github.com/apache/submarine/pull/507#discussion_r570548091
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
Review comment:
Could you update to `` because above syntax can not be parsed by https://v2.docusaurus.io/docs/installation
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(LOG_DIR)` (**NOTICE: it is `()` not `{}`**), and you can inspect the process on the tensorboard webpage.
Review comment:
```suggestion
- `SUBMARINE_LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(LOG_DIR)` (**NOTICE: it is `()` not `{}`**), and you can inspect the process on the tensorboard webpage.
```
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
Review comment:
```suggestion
```
##########
File path: 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
+
+### Usage
+
+- `LOG_DIR`: This environment variable already exists in every experiment container. You just need to direct your logs to `$(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=$(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.
+
+<img src="../../assets/tensorboard-experiment-page.png">
+
+2. Inspect the process on tensorboard page.
+
+<img src="../../assets/tensorboard-webpage.png">
Review comment:
```suggestion
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org