Skip to content

Commit 112e1b7

Browse files
authored
Update README.md (#288)
1 parent 62b3407 commit 112e1b7

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

tb_plugin/README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ and give optimization recommendations.
3737
[kineto/tb_plugin/examples/resnet50_profiler_api.py](https://github.com/pytorch/kineto/blob/master/tb_plugin/examples/resnet50_profiler_api.py).
3838
Also you can learn how to profile your model and generate profiling data from [PyTorch Profiler](https://pytorch.org/tutorials/intermediate/tensorboard_profiler_tutorial.html?highlight=tensorboard).
3939

40-
Note: The recommended way to produce profiling data is assigning "torch.profiler.tensorboard_trace_handler"
41-
to "on_trace_ready" on creation of "torch.profiler.schedule".
40+
Note: The recommended way to produce profiling data is assigning `torch.profiler.tensorboard_trace_handler`
41+
to `on_trace_ready` on creation of `torch.profiler.schedule`.
4242

4343
* Start TensorBoard
4444

45-
Specify the profiling data folder to "logdir" in Tensorboard. If you use the above samples data, start TensorBoard with:
45+
Specify the profiling data folder to `logdir` in Tensorboard. If you use the above samples data, start TensorBoard with:
4646

4747
`tensorboard --logdir=./samples`
4848

@@ -56,14 +56,17 @@ and give optimization recommendations.
5656
* Open TensorBoard in Chrome browser
5757

5858
Open URL `http://localhost:6006` in the browser.
59-
If you use '--bind_all' in tensorboard start cmd, the hostname may not be 'localhost'. You may find it in the log printed after the cmd.
59+
If you use `--bind_all` in tensorboard start command, the hostname may not be 'localhost'. You may find it in the log printed after the cmd.
6060

6161
* Navigate to PYTORCH_PROFILER tab
6262

6363
If the files under `--logdir` are too big or too many,
6464
please wait a while and refresh the browser to check latest loaded result.
65-
* Also support loading profiling data stored in AWS(S3://), Azure blob(https://\<account\>.blob.core.windows.net) and Google Cloud(GS://)
66-
* S3: install boto3. set environment variables: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`. Optionally, `S3_ENDPOINT` can be set as well.\
65+
66+
* Loading profiling data from cloud
67+
* S3 (S3://)
68+
69+
install `boto3`. set environment variables: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`. Optionally, `S3_ENDPOINT` can be set as well.\
6770
For minio, the S3 url should start with the bucket name `s3://<bucket>/<folder>/` instead of minio prefix `s3://minio/<bucket>/<folder>`. At the same time, the `S3_ENDPOINT` is needed as well. \
6871
For example, the following command can be used to create minio storage after following guides:
6972
* Server: https://docs.min.io/docs/minio-quickstart-guide.html
@@ -81,8 +84,15 @@ and give optimization recommendations.
8184
export S3_ENDPOINT=http://localhost:9000
8285
tensorboard --logdir=s3://profiler/version_2/ --bind_all
8386
```
84-
* Azure Blob: install azure-storage-blob. Optionally, set environment variable `AZURE_STORAGE_CONNECTION_STRING`
85-
* Google Cloud: install google-cloud-storage.
87+
88+
* Azure blob (https://\<account\>.blob.core.windows.net)
89+
90+
install `azure-storage-blob`. Optionally, set environment variable `AZURE_STORAGE_CONNECTION_STRING`
91+
92+
* Google Cloud (GS://)
93+
94+
install `google-cloud-storage`.
95+
8696
---
8797
> **_NOTES:_** For AWS, Google Cloud and Azure Blob, the trace files need to be put on a top level folder under bucket/container.
8898
---
@@ -93,7 +103,7 @@ and give optimization recommendations.
93103

94104
and open tensorboard in browser to see all the views described below.
95105

96-
Note: for accessing data in azure blob, you need to install torch-tb-profiler with cmd: `pip install torch-tb-profiler[blob]`
106+
Note: for accessing data in azure blob, you need to install torch-tb-profiler with `pip install torch-tb-profiler[blob]`
97107

98108
### Quick Usage Instructions
99109

0 commit comments

Comments
 (0)