Doc warnings #41068

mattip · 2020-07-07T10:39:17Z

solves most of gh-38011 in the framework of solving gh-32703.

These should only be formatting fixes, I did not try to fix grammer and syntax.

mattip · 2020-07-07T10:45:47Z

docs/source/packages.rst

-.. toctree::
-   :maxdepth: 2
-
-   org/pytorch/package-index


This should have been removed with the rest of the Javadoc docs in gh-38920

mattip · 2020-07-07T10:47:35Z

torch/_torch_docs.py

-    The input is expected to have the last dimension of :attr:`size` 2. In addition, the tensor must have a `stride` of 1
-    for its last dimension. The strides of all other dimensions must be even numbers.
+    :func:`view_as_complex` is only supported for tensors with
+    :class:`torch.dtype` ``torch.float64`` and ``torch.float32``.  The input is


this section was reformatted, but the real fix was adding another back-tick after torch.float32

mattip · 2020-07-07T10:50:21Z

torch/autograd/functional.py

+
+            vhp (tuple of Tensors or Tensor): result of the dot product with the
+            same shape as the inputs.
+


This section was reformatted to fit into 80 char lines, the real fix was the "Returns" formatting. The rendered text wants to use the first line as a return type, so I had to play with it to get the formatting right.

mattip · 2020-07-07T10:53:58Z

torch/jit/supported_ops.py

    magic_methods_rows = []
    for fn, magic_method in magic_methods:
-        magic_methods_rows.append('":any:`{}`", "``{}``"'.format(fn, magic_method))
+        magic_methods_rows.append('"{}", "``{}``"'.format(fn, magic_method))


the linking here did not work so I removed it.

We should probably inform whoever wrote this in the first place (EDIT) just in case the links were important

That would be @driazati in gh-30347

They're not that important, they were just linking to the Python docs for built in functions like int() and str()

facebook-github-bot

@zou3519 has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

zou3519 · 2020-07-07T14:44:09Z

We should try to finish off the rest of gh-38011 and set it up so that any warnings fail the doc build so that we don't regress in this aspect

mattip · 2020-07-07T14:50:03Z

We should try to finish off the rest of gh-38011 and set it up so that any warnings fail the doc build so that we don't regress in this aspect

11 of the remaining 13 warnings (see details below) have to do with quantization.rst which needs some work.

The other ones are due to missing tensorboard and torchvision:

Jul 07 11:24:16 No module named 'tensorboard'

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/index.rst:65: WARNING: toctree contains reference to nonexisting document 'torchvision/index'

Details

Jul 07 11:23:40 Running Sphinx v2.4.4

Jul 07 11:23:41 making output directory... done

Jul 07 11:23:41 [autosummary] generating autosummary for: config.rst, amp.rst, autograd.rst, bottleneck.rst, checkpoint.rst, community/contribution_guide.rst, community/governance.rst, community/persons_of_interest.rst, cpp_extension.rst, cpp_index.rst, ..., rpc/distributed_autograd.rst, rpc/rref.rst, sparse.rst, storage.rst, tensor_attributes.rst, tensor_view.rst, tensorboard.rst, tensors.rst, torch.rst, type_info.rst

Jul 07 11:23:43 [autosummary] generating autosummary for: /var/lib/jenkins/workspace/docs/source/generated/torch.Generator.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.abs.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.absolute.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.acos.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.acosh.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.add.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.addbmm.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.addcdiv.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.addcmul.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.addmm.rst, ..., /var/lib/jenkins/workspace/docs/source/generated/torch.unique_consecutive.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.unsqueeze.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.vander.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.var.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.var_mean.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.view_as_complex.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.view_as_real.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.where.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.zeros.rst, /var/lib/jenkins/workspace/docs/source/generated/torch.zeros_like.rst

Jul 07 11:23:43 loading intersphinx inventory from https://docs.python.org/3/objects.inv...

Jul 07 11:23:43 loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv...

Jul 07 11:23:44 building [mo]: targets for 0 po files that are out of date

Jul 07 11:23:44 building [doctest]: targets for 59 source files that are out of date

Jul 07 11:23:44 updating environment: [new config] 499 added, 0 changed, 0 removed

Jul 07 11:23:44 reading sources... [ 9%] config .. generated/torch.bitwise_or

Jul 07 11:23:44 /var/lib/jenkins/workspace/docs/source/conf.py:31: UserWarning: unable to load "torchvision" package

Jul 07 11:23:44 warnings.warn('unable to load "torchvision" package')

Jul 07 11:23:44 reading sources... [ 18%] generated/torch.bitwise_xor .. generated/torch.erfc

Jul 07 11:23:44 reading sources... [ 27%] generated/torch.erfinv .. generated/torch.jit.ignore

Jul 07 11:23:44 reading sources... [ 36%] generated/torch.jit.load .. generated/torch.mvlgamma

Jul 07 11:23:44 reading sources... [ 45%] generated/torch.narrow .. generated/torch.nn.Hardshrink

Jul 07 11:23:44 reading sources... [ 54%] generated/torch.nn.Hardsigmoid .. generated/torch.nn.ReflectionPad1d

Jul 07 11:23:44 reading sources... [ 63%] generated/torch.nn.ReflectionPad2d .. generated/torch.nn.utils.prune.ln_structured

Jul 07 11:23:44 reading sources... [ 72%] generated/torch.nn.utils.prune.random_structured .. generated/torch.result_type

Jul 07 11:23:44 reading sources... [ 81%] generated/torch.rfft .. generated/torch.tril_indices

Jul 07 11:23:44 reading sources... [ 90%] generated/torch.triu .. rpc/distributed_autograd

Jul 07 11:23:44 reading sources... [100%] rpc/rref .. type_info

Jul 07 11:23:44

Jul 07 11:23:44 waiting for workers...

Jul 07 11:23:57 /opt/conda/lib/python3.6/site-packages/torch/distributed/distributed_c10d.py:125: UserWarning: torch.distributed.reduce_op is deprecated, please use torch.distributed.ReduceOp instead

Jul 07 11:23:57 warnings.warn("torch.distributed.reduce_op is deprecated, please use "

Jul 07 11:24:16 WARNING: autodoc: failed to import class 'tensorboard.writer.SummaryWriter' from module 'torch.utils'; the following exception was raised:

Jul 07 11:24:16 No module named 'tensorboard'

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/index.rst:65: WARNING: toctree contains reference to nonexisting document 'torchvision/index'

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/nn.rst:271::1: WARNING: Unknown target name: "kullback-leibler divergence".

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:669: WARNING: duplicate label quantization:convbn2d, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:674: WARNING: duplicate label quantization:convbnrelu2d, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:679: WARNING: duplicate label quantization:convrelu2d, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:684: WARNING: duplicate label quantization:linearrelu, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:696: WARNING: duplicate label quantization:convrelu2d, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:701: WARNING: duplicate label quantization:convrelu3d, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:706: WARNING: duplicate label quantization:linearrelu, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:783: WARNING: duplicate label quantization:conv2d, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:813: WARNING: duplicate label quantization:linear, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 /var/lib/jenkins/workspace/docs/source/quantization.rst:858: WARNING: duplicate label quantization:linear, other instance in /var/lib/jenkins/workspace/docs/source/quantization.rst

Jul 07 11:24:16 looking for now-outdated files... none found

Jul 07 11:24:16 pickling environment... done

Jul 07 11:24:16 checking consistency... done

Jul 07 11:24:16 running tests...

Jul 07 11:24:17

Jul 07 11:24:17 Document: jit_language_reference

Jul 07 11:24:17 --------------------------------

Jul 07 11:24:17 1 items passed all tests:

Jul 07 11:24:17 11 tests in default

Jul 07 11:24:17 11 tests in 1 items.

Jul 07 11:24:17 11 passed and 0 failed.

Jul 07 11:24:17 Test passed.

Jul 07 11:24:17

Jul 07 11:24:17 Document: jit

Jul 07 11:24:17 -------------

Jul 07 11:24:17 1 items passed all tests:

Jul 07 11:24:17 15 tests in default

Jul 07 11:24:17 15 tests in 1 items.

Jul 07 11:24:17 15 passed and 0 failed.

Jul 07 11:24:17 Test passed.

Jul 07 11:24:18

Jul 07 11:24:18 Doctest summary

Jul 07 11:24:18 ===============

Jul 07 11:24:18 26 tests

Jul 07 11:24:18 0 failures in tests

Jul 07 11:24:18 0 failures in setup code

Jul 07 11:24:18 0 failures in cleanup code

Jul 07 11:24:18 build succeeded, 13 warnings.

facebook-github-bot · 2020-07-07T22:18:00Z

@zou3519 merged this pull request in 75155df.

mattip added 2 commits July 7, 2020 13:29

remove document left-over from PR 38920

4098998

DOC: fix warnings

a059eb7

mattip requested review from albanD and apaszke as code owners July 7, 2020 10:39

facebook-github-bot added the oncall: jit Add this issue/PR to JIT oncall triage queue label Jul 7, 2020

mattip mentioned this pull request Jul 7, 2020

Build documentation without emitting warnings #38011

Closed

mattip commented Jul 7, 2020

View reviewed changes

pytorchbot added the open source label Jul 7, 2020

mattip commented Jul 7, 2020

View reviewed changes

remove links form magic functions

827db51

mattip commented Jul 7, 2020

View reviewed changes

zou3519 approved these changes Jul 7, 2020

View reviewed changes

facebook-github-bot reviewed Jul 7, 2020

View reviewed changes

facebook-github-bot closed this in 75155df Jul 7, 2020

facebook-github-bot added the merged label Jul 7, 2020

mruberry added the Merged label Oct 28, 2020


		vhp (tuple of Tensors or Tensor): result of the dot product with the
		same shape as the inputs.

Doc warnings #41068

Doc warnings #41068

Uh oh!

Conversation

mattip commented Jul 7, 2020

Uh oh!

mattip Jul 7, 2020

Choose a reason for hiding this comment

Uh oh!

mattip Jul 7, 2020

Choose a reason for hiding this comment

Uh oh!

mattip Jul 7, 2020

Choose a reason for hiding this comment

Uh oh!

mattip Jul 7, 2020

Choose a reason for hiding this comment

Uh oh!

zou3519 Jul 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zou3519 Jul 7, 2020

Choose a reason for hiding this comment

Uh oh!

mattip Jul 7, 2020

Choose a reason for hiding this comment

Uh oh!

driazati Jul 8, 2020

Choose a reason for hiding this comment

Uh oh!

facebook-github-bot left a comment

Choose a reason for hiding this comment

Uh oh!

zou3519 commented Jul 7, 2020

Uh oh!

mattip commented Jul 7, 2020

Uh oh!

facebook-github-bot commented Jul 7, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

zou3519 Jul 7, 2020 •

edited

Loading