Skip to content

Commit eb03af4

Browse files
Svetlana Karslioglupytorchmergebot
authored andcommitted
Fixes to the torch.compile doc and doctest (pytorch#104911)
Fixing the user warning in doctest by removing autosummary from the compile/index.rst : ``` /opt/conda/envs/py_3.8/lib/python3.8/site-packages/torch/__init__.py:docstring of torch.compile:1: WARNING: duplicate object description of torch.compile, other instance in compile/generated/torch.compile, use :noindex: for one of them ``` The error is no longer present in the log: https://github.com/pytorch/pytorch/actions/runs/5513741050/jobs/10052379357?pr=104911 Pull Request resolved: pytorch#104911 Approved by: https://github.com/kit1980, https://github.com/malfet
1 parent 6abe0b2 commit eb03af4

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

docs/source/compile/index.rst

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,14 @@ There is some nuance involved in benchmarking ``torch.compile`` so we've provide
4545

4646
You can get the full list of community backends by running :func:`~torch._dynamo.list_backends`
4747

48-
.. autosummary::
49-
:toctree: generated
50-
:nosignatures:
48+
Troubleshooting
49+
---------------
5150

52-
compile
53-
54-
Troubleshooting and Gotchas
55-
---------------------------
56-
57-
IF you experience issues with models failing to compile, running of out of memory, recompiling too often, not giving accurate results,
58-
odds are you will find the right tool to solve your problem in our guides.
51+
If you experience issues with models failing to compile, running out of memory, recompiling too often, not giving accurate results, you might find the right tool to solve your problem in one of our guides.
5952

6053
.. WARNING::
61-
A few features are still very much in development and not likely to work for most users. Please do not use these features
62-
in production code and if you're a library maintainer please do not expose these options to your users
54+
A few features are still in development and not likely to work for most users. Please do not use these features
55+
in production code and if you're a library maintainer please do not expose these options to your users.
6356
Dynamic shapes ``dynamic=true`` and max autotune ``mode="max-autotune"`` which can be passed in to :func:`~torch.compile`.
6457
Distributed training has some quirks which you can follow in the troubleshooting guide below. Model export is not ready yet.
6558

@@ -72,8 +65,8 @@ odds are you will find the right tool to solve your problem in our guides.
7265
Learn more
7366
----------
7467

75-
If you can't wait to get started and want to learn more about the internals of the PyTorch 2.0 stack then
76-
please check out the references below.
68+
To learn more about the internals of the PyTorch 2.0 stack, check out the
69+
following references:
7770

7871
.. toctree::
7972
:maxdepth: 1

0 commit comments

Comments
 (0)