Created docs for make_fx in torch.fx.experimental.proxy_tensor

[ignaciobartol]

Fixes #127886

Description

Created docs to document the make_fx function to solve the issue #127886.
The variable names were pretty descriptive so I added what would be the functionality of some of them. The way this function seems to be used across users is always initializing it with a call, so that is why in the Return section I added what will be the return when called.

My logic for the examples was to demonstrate in Example 1 the raw functionality and Example 2 an actual usage of the function. Let me know if you think Example 1 is not necesary.

Summary of Changes

• Added docs for torch.fx.experimental.proxy_tensor.make_fx
• Added the proxy_tensor.make_fx function in the autosummary of docs/source/fx.experimental.rst

Checklist

• The issue that is being fixed is referred in the description
• 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 unnecesary issues are included into this pull request

cc @svekars @brycebortree @ezyang @SherlockNoMad @EikanWang @jgong5 @wenzhe-nrv

[pytorch-bot]

🔗 Helpful Links

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

• 📄 Preview Python docs built from this PR
• 📄 Preview C++ docs built from this PR
• ❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

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

❌ 10 New Failures, 12 Unrelated Failures

As of commit 3b7c81c with merge base 50567f7 ():

NEW FAILURES - The following jobs have failed:

• pull / linux-focal-cuda12.1-py3.10-gcc9 / test (default, 1, 5, linux.4xlarge.nvidia.gpu) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-focal-cuda12.1-py3.10-gcc9-sm86 / test (default, 1, 5, linux.g5.4xlarge.nvidia.gpu) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-focal-py3.11-clang10 / test (crossref, 1, 2, linux.2xlarge) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-focal-py3.11-clang10 / test (default, 1, 3, linux.2xlarge) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-focal-py3.11-clang10 / test (dynamo, 2, 3, linux.2xlarge) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-focal-py3.8-clang10 / test (crossref, 1, 2, linux.2xlarge) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-focal-py3.8-clang10 / test (default, 1, 3, linux.2xlarge) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-focal-py3.8-clang10 / test (dynamo, 2, 3, linux.2xlarge) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-jammy-py3.10-clang15-asan / test (default, 1, 6, linux.4xlarge) (gh)
  RuntimeError: doctests 1/1 failed!
• pull / linux-jammy-py3.8-gcc11 / test (default, 1, 3, linux.2xlarge) (gh)
  RuntimeError: doctests 1/1 failed!

UNSTABLE - The following jobs failed but were likely due to flakiness present on trunk and has been marked as unstable:

• inductor / cuda12.1-py3.10-gcc9-sm86 / test (aot_inductor_torchbench, 1, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128903)
  ImportError: attempted relative import with no known parent package
• inductor / cuda12.1-py3.10-gcc9-sm86 / test (aot_inductor_torchbench, 2, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128903)
  ImportError: attempted relative import with no known parent package
• inductor / cuda12.1-py3.10-gcc9-sm86 / test (dynamic_inductor_torchbench, 1, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128902)
  ImportError: attempted relative import with no known parent package
• inductor / cuda12.1-py3.10-gcc9-sm86 / test (dynamic_inductor_torchbench, 2, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128902)
  ImportError: attempted relative import with no known parent package
• inductor / cuda12.1-py3.10-gcc9-sm86 / test (inductor_torchbench, 1, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128901)
  ImportError: attempted relative import with no known parent package
• inductor / cuda12.1-py3.10-gcc9-sm86 / test (inductor_torchbench, 2, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128901)
  ImportError: attempted relative import with no known parent package
• inductor-periodic / cuda12.1-py3.10-gcc9-sm86-periodic-dynamo-benchmarks / test (aot_eager_torchbench, 1, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128929)
  ImportError: attempted relative import with no known parent package
• inductor-periodic / cuda12.1-py3.10-gcc9-sm86-periodic-dynamo-benchmarks / test (aot_eager_torchbench, 2, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128929)
  ImportError: attempted relative import with no known parent package
• inductor-periodic / cuda12.1-py3.10-gcc9-sm86-periodic-dynamo-benchmarks / test (dynamic_aot_eager_torchbench, 1, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128931)
  ImportError: attempted relative import with no known parent package
• inductor-periodic / cuda12.1-py3.10-gcc9-sm86-periodic-dynamo-benchmarks / test (dynamic_aot_eager_torchbench, 2, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128931)
  ImportError: attempted relative import with no known parent package
• inductor-periodic / cuda12.1-py3.10-gcc9-sm86-periodic-dynamo-benchmarks / test (dynamo_eager_torchbench, 1, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128932)
  ImportError: attempted relative import with no known parent package
• inductor-periodic / cuda12.1-py3.10-gcc9-sm86-periodic-dynamo-benchmarks / test (dynamo_eager_torchbench, 2, 2, linux.g5.4xlarge.nvidia.gpu, unstable) (gh) (#128932)
  ImportError: attempted relative import with no known parent package

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

[svekars]

@pytorchbot rebase

[pytorchmergebot]

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

[pytorchmergebot]

Successfully rebased docs-make_fx onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via git checkout docs-make_fx && git pull --rebase)

[svekars]

You need to fix CI here by adding :noindex: to one of the instances.

[ignaciobartol]

You need to fix CI here by adding :noindex: to one of the instances.

Thanks, I was just working on it and tracking down the problem so thanks for the solution! I will amend the commit soon

[ignaciobartol]

You need to fix CI here by adding :noindex: to one of the instances.

@svekars I believe the problem is raised because torch.fx.experimental.proxy_tensor it is also mentioned in fx.rst L1146. Should I add :noindex: to the .. automodule:: directive I added? or would be better to delete that line from fx.rst that is added for coverage but does not add anything to the docs?

[ignaciobartol]

@pytorchbot rebase

[pytorchmergebot]

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

[pytorchmergebot]

Successfully rebased docs-make_fx onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via git checkout docs-make_fx && git pull --rebase)

[ignaciobartol]

Hi @albanD I fixed the CI and the PR is ready to be reviewed :). Thanks!

cc @svekars