Skip to content

Docs build failures are difficult to identify #50330

@mruberry

Description

@mruberry

Warnings in the docs build are now a build failure in CI. These failures, however, are difficult for developers to relate to their PRs. See, for example, #50046 (comment).

The warning:

Jan 05 15:57:22 docstring of torch.linalg.qr:29: WARNING: Explicit markup ends without a blank line; unexpected unindent.

appears in a lengthy printout that can include other warnings like these:

Jan 05 15:57:23 /opt/conda/lib/python3.6/site-packages/torch/jit/_trace.py:804: TracerWarning: Trace had nondeterministic nodes. Did you forget call .eval() on your model? Nodes:
Jan 05 15:57:23 	%13 : Float(4, strides=[1], requires_grad=0, device=cpu) = aten::rand(%8, %9, %10, %11, %12) # <doctest default[0]>:2:0
Jan 05 15:57:23 This may cause errors in trace checking. To disable trace checking, pass check_trace=False to torch.jit.trace()
Jan 05 15:57:23   _module_class,
Jan 05 15:57:23 /opt/conda/lib/python3.6/site-packages/torch/jit/_trace.py:804: TracerWarning: Output nr 1. of the traced function does not match the corresponding output of the Python function. Detailed error:
Jan 05 15:57:23 With rtol=1e-05 and atol=1e-05, found 4 element(s) (out of 12) whose difference(s) exceeded the margin of error (including 0 nan comparisons). The greatest difference was 0.9027273058891296 (0.904914915561676 vs. 0.0021876096725463867), which occurred at index (0, 3).
Jan 05 15:57:23   _module_class,
Jan 05 15:57:23 /opt/conda/lib/python3.6/site-packages/torch/jit/_trace.py:804: TracerWarning: Trace had nondeterministic nodes. Did you forget call .eval() on your model? Nodes:
Jan 05 15:57:23 	%14 : Float(1, 4, strides=[4, 1], requires_grad=0, device=cpu) = aten::rand(%9, %10, %11, %12, %13) # <doctest default[0]>:2:0
Jan 05 15:57:23 This may cause errors in trace checking. To disable trace checking, pass check_trace=False to torch.jit.trace()
Jan 05 15:57:23   _module_class,
Jan 05 15:57:23 /opt/conda/lib/python3.6/site-packages/torch/jit/_trace.py:804: TracerWarning: Output nr 1. of the traced function does not match the corresponding output of the Python function. Detailed error:
Jan 05 15:57:23 With rtol=1e-05 and atol=1e-05, found 4 element(s) (out of 8) whose difference(s) exceeded the margin of error (including 0 nan comparisons). The greatest difference was 0.7007782459259033 (0.7614061832427979 vs. 0.06062793731689453), which occurred at index (0, 3).
Jan 05 15:57:23   _module_class,
Jan 05 15:57:23 /opt/conda/lib/python3.6/site-packages/torch/jit/_recursive.py:197: UserWarning: 'mods' was found in ScriptModule constants,  but it is a non-constant submodule. Consider removing it.
Jan 05 15:57:23   " but it is a non-constant {}. Consider removing it.".format(name, hint))
Jan 05 15:57:24 Makefile:38: recipe for target 'doctest' failed

It would be nice to more clearly describe to developers why the doc build(s) failed on their PR.

cc @ezyang @gchanan @zou3519 @bdhirsh @jbschlosser @jlin27 @mruberry @rgommers @mattip @ranman

Metadata

Metadata

Assignees

Labels

high prioritymodule: docsRelated to our documentation, both in docs/ and docblocksmodule: testingIssues related to the torch.testing module (not tests)triagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions