Skip to content

Commit

Permalink
Add a deprecation notice to the Profile Tensorboard tutorial (#3128)
Browse files Browse the repository at this point in the history
* Add a deprecation notice to the Profile Tensorboard tutorial
* Add Perfetto to en-wordlist
  • Loading branch information
svekars authored Oct 31, 2024
1 parent 8d19c5c commit 54273de
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
2 changes: 1 addition & 1 deletion beginner_source/hyperparameter_tuning_tutorial.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Fortunately, there are tools that help with finding the best combination of parameters.
`Ray Tune <https://docs.ray.io/en/latest/tune.html>`_ is an industry standard tool for
distributed hyperparameter tuning. Ray Tune includes the latest hyperparameter search
algorithms, integrates with TensorBoard and other analysis libraries, and natively
algorithms, integrates with various analysis libraries, and natively
supports distributed training through `Ray's distributed machine learning engine
<https://ray.io/>`_.
Expand Down
2 changes: 1 addition & 1 deletion en-wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

ACL
ADI
AOT
Expand Down Expand Up @@ -188,6 +187,7 @@ PIL's
PPO
PatchPredictor
PennFudan
Perfetto
Pixman
Plotly
Pohjonen
Expand Down
8 changes: 8 additions & 0 deletions intermediate_source/tensorboard_profiler_tutorial.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@
This tutorial demonstrates how to use TensorBoard plugin with PyTorch Profiler
to detect performance bottlenecks of the model.
.. warning::
The TensorBoard integration with the PyTorch profiler is now
deprecated. Instead, use Perfetto or the Chrome trace to
view ``trace.json`` files. After
`generating a trace <https://pytorch.org/tutorials/recipes/recipes/profiler_recipe.html#using-tracing-functionality>`__,
simply drag the ``trace.json`` into `Perfetto UI <https://ui.perfetto.dev/>`__
or ``chrome://tracing`` to visualize your profile.
Introduction
------------
PyTorch 1.8 includes an updated profiler API capable of
Expand Down
5 changes: 2 additions & 3 deletions recipes_source/recipes/profiler_recipe.py
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,6 @@ def trace_handler(p):
#
# Take a look at the following recipes/tutorials to continue your learning:
#
# - `PyTorch Benchmark <https://pytorch.org/tutorials/recipes/recipes/benchmark.html>`_
# - `PyTorch Profiler with TensorBoard <https://pytorch.org/tutorials/intermediate/tensorboard_profiler_tutorial.html>`_ tutorial
# - `Visualizing models, data, and training with TensorBoard <https://pytorch.org/tutorials/intermediate/tensorboard_tutorial.html>`_ tutorial
# - `PyTorch Benchmark <https://pytorch.org/tutorials/recipes/recipes/benchmark.html>`_
# - `Visualizing models, data, and training with TensorBoard <https://pytorch.org/tutorials/intermediate/tensorboard_tutorial.html>`_ tutorial
#

0 comments on commit 54273de

Please sign in to comment.