Skip to content

Commit 77371ab

Browse files
authored
[DOC] Add hosted tensorboard summaries (tensorboard.dev links) to README files (#339)
Using permalinks from Hosted TensorBoard (tensorboard.dev). tensorboard.dev links are added for the following examples: - date-conversion-attention - mnist-acgan - sentiment - snake-dqn DOC
1 parent f0d5861 commit 77371ab

File tree

4 files changed

+25
-7
lines changed

4 files changed

+25
-7
lines changed

date-conversion-attention/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ advantanges:
5353

5454
![date-conversion attention model training: TensorBoard example](./date-conversion-attention-tensorboard-example.png)
5555

56+
A detailed tensorboard training log is hosted and viewable at this
57+
[TensorBoard.dev link](https://tensorboard.dev/experiment/CqhZhKlNSgimJbnIwvbmnw/#scalars).
58+
5659
To do this in this example, add the flag `--logDir` to the `yarn train`
5760
command, followed by the directory to which you want the logs to
5861
be written, e.g.,

mnist-acgan/README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This example of TensorFlow.js runs simultaneously in two different environments:
2121
- Demonstration of generation in the browser. The demo webpage will load
2222
the checkpoints saved from the training process and use it to generate
2323
fake MNIST images in the browser.
24-
24+
2525
## How to use this example
2626

2727
This example can be used in two ways:
@@ -32,7 +32,7 @@ This example can be used in two ways:
3232
the web.
3333

3434
For approach 1, you can start the training by:
35-
35+
3636
```sh
3737
yarn
3838
yarn train
@@ -71,6 +71,9 @@ advantanges:
7171

7272
![MNIST ACGAN Training: TensorBoard Example](./mnist-acgan-tensorboard-example.png)
7373

74+
Detailed loss profiles are hosted and viewable at this
75+
[TensorBoard.dev link](https://tensorboard.dev/experiment/iBcGONlbQbmVyNd8H6unJg/#scalars).
76+
7477
To do this in this example, add the flag `--logDir` to the `yarn train`
7578
command, followed by the directory to which you want the logs to
7679
be written, e.g.,
@@ -93,9 +96,9 @@ navigate to the URL to view the loss curves in the Scalar dashboard of
9396
TensorBoard.
9497

9598
### Running Generator demo in the Browser
96-
99+
97100
To start the demo in the browser, do in a separate terminal:
98-
101+
99102
```sh
100103
yarn
101104
yarn watch
@@ -109,13 +112,13 @@ been started), the user may still click the "Load Hosted Model" button
109112
to load a remotely-hosted generator.
110113

111114
### Training the model on CUDA GPUs using tfjs-node-gpu
112-
115+
113116
It is recommended to use tfjs-node-gpu to train the model on a CUDA-enabled GPU,
114117
as the convolution heavy operations run several times faster a GPU than on the
115118
CPU with tfjs-node.
116119

117120
By default, the [training script](./gan.js) runs on the CPU using tfjs-node. To
118-
run it on the GPU, repace the line
121+
run it on the GPU, repace the line
119122

120123
```js
121124
require('@tensorflow/tfjs-node');

sentiment/README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,17 @@ Other arguments of the `yarn train` command include:
9090
tensorboard (by default: http://localhost:6006) to view the loss and accuracy
9191
curves.
9292

93-
The detailed code for training are in the file [train.js](./train.js).
93+
The links below point to TensorBoard.dev training loss for various model
94+
types:
95+
96+
- [`multihot`](https://tensorboard.dev/experiment/8Ltk9awdQVeEdIqmZF6UZg/#scalars)
97+
- [`flatten`](https://tensorboard.dev/experiment/8dYnJmlDRe21vNJrHYB3Yg/#scalars)
98+
- [`cnn`](https://tensorboard.dev/experiment/pP6s7BozQESnbXXQy1rJtQ/#scalars)
99+
- [`simpleRNN`](https://tensorboard.dev/experiment/zl266tMbRuKAr4PBsny8XQ/#scalars)
100+
- [`lstm`](https://tensorboard.dev/experiment/VHKxx8OnSze7glfzqCXi9A/#scalars)
101+
- [`bidirectionalLSTM`](https://tensorboard.dev/experiment/osVo6vAaR0SZWzUvElz5ow/#scalars)
94102

103+
The detailed code for training are in the file [train.js](./train.js).
95104

96105
### Visualizing the word embeddings in embedding projector
97106

snake-dqn/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ pip install tensorboard
6161
tensorboard --logdir /tmp/snake_logs
6262
```
6363

64+
A detailed TensorBoard training log is hosted and viewable at this
65+
[TensorBoard.dev link](https://tensorboard.dev/experiment/TJFBWBx3T5WrFBs4Ar76Sw/#scalars).
66+
6467
Once started, the tensorboard backend process will print an `http://` URL to the
6568
console. Open your browser and navigate to the URL to see the logged curves.
6669

0 commit comments

Comments
 (0)