Skip to content

improve TensorBoard instructions in README #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 27, 2024
Merged

improve TensorBoard instructions in README #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b960c4
improve TensorBoard instructions in README
tianyu-l Feb 27, 2024
8f356fc
Update on "improve TensorBoard instructions in README"
tianyu-l Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,21 @@ run the llama debug model locally to verify the setup is correct:

# TensorBoard

To visualize training metrics on TensorBoard:
To visualize TensorBoard metrics of models trained on a remote server via a local web browser:

1. (by default) set `enable_tensorboard = true` in `torchtrain/train_configs/train_config.toml`
1. Make sure `metrics.enable_tensorboard` option is set to true in model training (either from a .toml file or from CLI).

2. set up SSH tunneling
2. Set up SSH tunneling, by running the following from local CLI
```
ssh -L 6006:127.0.0.1:6006 [username]@[hostname]
```

3. then in the torchtrain repo
3. Inside the SSH tunnel that logged into the remote server, go to the torchtrain repo, and start the TensorBoard backend
```
tensorboard --logdir=./torchtrain/outputs/tb
```

4. go to the URL it provides OR to http://localhost:6006/
4. In the local web browser, go to the URL it provides OR to http://localhost:6006/.

## Multi-Node Training
For training on ParallelCluster/Slurm type configurations, you can use the multinode_trainer.slurm file to submit your sbatch job.</br>
Expand Down