Update outdated docs for torch logs #3127

nluu175 · 2024-10-30T03:44:30Z

Fixes #137285

Description

Update Python code to better address the usage of python logging and torch.compile.

Checklist

The issue that is being fixed is referred in the description (see above "Fixes #ISSUE_NUMBER")
Only one issue is addressed in this pull request
Labels from the issue that this PR is fixing are added to this pull request
No unnecessary issues are included into this pull request.

cc @williamwen42 @msaroufim @anijain2305

pytorch-bot · 2024-10-30T03:44:33Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3127

📄 Preview Python docs built from this PR

Note: Links to docs will display an error until the docs builds have been completed.

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

[DomainsOnly] Jobs fail with GLIBC version not found

❌ 1 New Failure

As of commit 26d2b0e with merge base 0088d45 ():

NEW FAILURE - The following job has failed:

Build tutorials / pytorch_tutorial_build_manager (gh)
cp: cannot stat 'worker_12/docs/*': No such file or directory

This comment was automatically generated by Dr. CI and updates every 15 minutes.

nluu175 · 2024-10-30T03:48:51Z

@ezyang could you please give me some feedbacks on this fix?

nluu175 · 2024-10-30T03:50:14Z

@pytorchbot label "torch.compile"

pytorch-bot · 2024-10-30T03:50:17Z

Didn't find following labels among repository labels: module: logging

ezyang · 2024-10-31T02:41:05Z

TBH, maybe we should introduce tlparse here, it's much better for looking at the output code bits. Description at https://docs.google.com/document/d/1y5CRfMLdwEoF1nTk9q8qEu1mgMUuUtvhklPKJ2emLU8/edit?tab=t.0#heading=h.u9711c2s6w0c

nluu175 · 2024-10-31T02:42:28Z

TBH, maybe we should introduce tlparse here, it's much better for looking at the output code bits. Description at https://docs.google.com/document/d/1y5CRfMLdwEoF1nTk9q8qEu1mgMUuUtvhklPKJ2emLU8/edit?tab=t.0#heading=h.u9711c2s6w0c

Thank you! I'll take a look at it.

ezyang · 2024-11-07T16:52:43Z

waiting for render

svekars

A few editorial suggestions.

svekars · 2024-11-07T16:54:40Z

recipes_source/torch_logs.py

-    separator("")
+######################################################################
+# Use TORCH_TRACE/tlparse to produce produce compilation reports
+# ~~~~~~~~~~


Suggested change

# ~~~~~~~~~~

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

svekars · 2024-11-07T16:54:54Z

recipes_source/torch_logs.py


-    separator("")
+######################################################################
+# Use TORCH_TRACE/tlparse to produce produce compilation reports


Suggested change

# Use TORCH_TRACE/tlparse to produce produce compilation reports

# Using ``TORCH_TRACE/tlparse`` to produce produce compilation reports

svekars · 2024-11-07T16:55:29Z

recipes_source/torch_logs.py

+# Use TORCH_TRACE/tlparse to produce produce compilation reports
+# ~~~~~~~~~~
+#
+# In this section, we introduce the usage of TORCH_TRACE and tlparse to produce reports.


Suggested change

# In this section, we introduce the usage of TORCH_TRACE and tlparse to produce reports.

# In this section, we introduce ``TORCH_TRACE`` and ``tlparse`` to produce reports.

svekars · 2024-11-07T16:57:16Z

recipes_source/torch_logs.py

+# ~~~~~~~~~~
+#
+# In this section, we introduce the usage of TORCH_TRACE and tlparse to produce reports.
+# First, we run `TORCH_TRACE="/tmp/tracedir" python script.py` to generate the raw trace logs.


Suggested change

# First, we run `TORCH_TRACE="/tmp/tracedir" python script.py` to generate the raw trace logs.

#

# 1. Generate the raw trace logs by running the following command:

#

# .. code-block:: bash

#

# TORCH_TRACE="/tmp/tracedir" python script.py`

#

svekars · 2024-11-07T16:58:42Z

recipes_source/torch_logs.py

+#
+# In this section, we introduce the usage of TORCH_TRACE and tlparse to produce reports.
+# First, we run `TORCH_TRACE="/tmp/tracedir" python script.py` to generate the raw trace logs.
+# We have replace `/tmp/tracedir` with a path to a directory you want to store the trace logs


Suggested change

# We have replace `/tmp/tracedir` with a path to a directory you want to store the trace logs

# Ensure you replace ``/tmp/tracedir`` with the path to the directory where you want to store the trace logs

svekars · 2024-11-07T17:03:13Z

recipes_source/torch_logs.py

+# `pip install tlparse` and then `tlparse /tmp/tracedir`. This will open up your browser with 
+# HTML like generated above.


Suggested change

# `pip install tlparse` and then `tlparse /tmp/tracedir`. This will open up your browser with

# HTML like generated above.

# This will open your browser with the HTML-like generated above.

#

svekars · 2024-11-07T17:03:22Z

recipes_source/torch_logs.py

+# `pip install tlparse` and then `tlparse /tmp/tracedir`. This will open up your browser with 
+# HTML like generated above.
+#
+# By default, reports generated by `tlparse` are 


Suggested change

# By default, reports generated by `tlparse` are

# By default, reports generated by ``tlparse`` are

recipes_source/torch_logs.py

nluu175 · 2024-11-14T03:07:23Z

@ezyang hello. Do I need to make any more modifications for this issue? I see that the pipeline is still waiting to be reported.

Modify example code to fix torch logs doc

134d92a

facebook-github-bot added the cla signed label Oct 30, 2024

nluu175 changed the title ~~Modify example code to fix torch logs doc~~ Update outdated docs for torch logs Oct 30, 2024

svekars requested a review from mlazos October 30, 2024 15:11

svekars added the torch.compile Torch compile and other relevant tutorials label Oct 30, 2024

Introduced TORCH_TRACE/tlparse

368e062

svekars reviewed Nov 7, 2024

View reviewed changes

nluu175 and others added 2 commits November 7, 2024 13:56

Adjust the wording based on suggestions

8859a58

Merge branch 'main' into logs-doc-fix

7c1e3ae

svekars reviewed Nov 8, 2024

View reviewed changes

recipes_source/torch_logs.py Outdated Show resolved Hide resolved

Update recipes_source/torch_logs.py

26d2b0e

svekars requested a review from ezyang November 15, 2024 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update outdated docs for torch logs #3127

Update outdated docs for torch logs #3127

nluu175 commented Oct 30, 2024 •

edited

Loading

pytorch-bot bot commented Oct 30, 2024 •

edited

Loading

nluu175 commented Oct 30, 2024

nluu175 commented Oct 30, 2024 •

edited

Loading

pytorch-bot bot commented Oct 30, 2024

ezyang commented Oct 31, 2024

nluu175 commented Oct 31, 2024

ezyang commented Nov 7, 2024

svekars left a comment

svekars Nov 7, 2024

svekars Nov 7, 2024

svekars Nov 7, 2024

svekars Nov 7, 2024

svekars Nov 7, 2024

svekars Nov 7, 2024

svekars Nov 7, 2024

nluu175 commented Nov 14, 2024 •

edited

Loading

	# ~~~~~~~~~~
	# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

	# Use TORCH_TRACE/tlparse to produce produce compilation reports
	# Using ``TORCH_TRACE/tlparse`` to produce produce compilation reports

	# In this section, we introduce the usage of TORCH_TRACE and tlparse to produce reports.
	# In this section, we introduce ``TORCH_TRACE`` and ``tlparse`` to produce reports.

-# First, we run `TORCH_TRACE="/tmp/tracedir" python script.py` to generate the raw trace logs.
+#
+# 1. Generate the raw trace logs by running the following command:
+#
+# .. code-block:: bash
+#
+#    TORCH_TRACE="/tmp/tracedir" python script.py`
+#

	# We have replace `/tmp/tracedir` with a path to a directory you want to store the trace logs
	# Ensure you replace ``/tmp/tracedir`` with the path to the directory where you want to store the trace logs

		# `pip install tlparse` and then `tlparse /tmp/tracedir`. This will open up your browser with
		# HTML like generated above.

	# By default, reports generated by `tlparse` are
	# By default, reports generated by ``tlparse`` are

Update outdated docs for torch logs #3127

Are you sure you want to change the base?

Update outdated docs for torch logs #3127

Conversation

nluu175 commented Oct 30, 2024 • edited Loading

Description

Checklist

pytorch-bot bot commented Oct 30, 2024 • edited Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3127

❗ 1 Active SEVs

❌ 1 New Failure

nluu175 commented Oct 30, 2024

nluu175 commented Oct 30, 2024 • edited Loading

pytorch-bot bot commented Oct 30, 2024

ezyang commented Oct 31, 2024

nluu175 commented Oct 31, 2024

ezyang commented Nov 7, 2024

svekars left a comment

Choose a reason for hiding this comment

svekars Nov 7, 2024

Choose a reason for hiding this comment

svekars Nov 7, 2024

Choose a reason for hiding this comment

svekars Nov 7, 2024

Choose a reason for hiding this comment

svekars Nov 7, 2024

Choose a reason for hiding this comment

svekars Nov 7, 2024

Choose a reason for hiding this comment

svekars Nov 7, 2024

Choose a reason for hiding this comment

svekars Nov 7, 2024

Choose a reason for hiding this comment

nluu175 commented Nov 14, 2024 • edited Loading

nluu175 commented Oct 30, 2024 •

edited

Loading

pytorch-bot bot commented Oct 30, 2024 •

edited

Loading

nluu175 commented Oct 30, 2024 •

edited

Loading

nluu175 commented Nov 14, 2024 •

edited

Loading