Skip to content

DNM: run docs build with extra debug verbosity#9344

Closed
jakelishman wants to merge 5 commits intoQiskit:mainfrom
jakelishman:debug-docs
Closed

DNM: run docs build with extra debug verbosity#9344
jakelishman wants to merge 5 commits intoQiskit:mainfrom
jakelishman:debug-docs

Conversation

@jakelishman
Copy link
Copy Markdown
Member

Summary

The documentation build is frequently timing out while executing the jupyter-execute block in the QuantumVolume documentation. Failed runs seem to reach this point at about the same pace that successful runs do, but the job then hangs for ~50 minutes until timeout. For example:

2023-01-04T21:31:31.4753503Z reading sources... [ 31%] stubs/qiskit.circuit.library.QFT
2023-01-04T21:31:31.5925301Z executing qiskit.circuit.library.QFT
2023-01-04T21:31:35.3652889Z reading sources... [ 31%] stubs/qiskit.circuit.library.QFT.inverse
2023-01-04T21:31:35.3913019Z reading sources... [ 31%] stubs/qiskit.circuit.library.QFT.is_inverse
2023-01-04T21:31:35.4039735Z reading sources... [ 31%] stubs/qiskit.circuit.library.QuadraticForm
2023-01-04T21:31:35.5617032Z reading sources... [ 31%] stubs/qiskit.circuit.library.QuadraticForm.required_result_qubits
2023-01-04T21:31:35.5880155Z reading sources... [ 31%] stubs/qiskit.circuit.library.QuantumVolume
2023-01-04T21:31:35.6868508Z executing qiskit.circuit.library.QuantumVolume
2023-01-04T22:22:02.2667118Z ##[error]The operation was canceled.
2023-01-04T22:22:02.2682001Z ##[section]Finishing: Run Docs build

This commit adds full verbosity to the Sphinx build, to see if there's more information available to assist with the debug.

Details and comments

I wasn't able to reproduce the failures locally on mac for now, so reverting to trying to debug live.

We've had a few failed attempts at finding the cause of this in #9340 and #9341 so far, but the cause is proving elusive.

The documentation build is frequently timing out while executing the
`jupyter-execute` block in the `QuantumVolume` documentation.  Failed
runs seem to reach this point at about the same pace that successful
runs do, but the job then hangs for ~50 minutes until timeout.  For
example:

    2023-01-04T21:31:31.4753503Z reading sources... [ 31%] stubs/qiskit.circuit.library.QFT
    2023-01-04T21:31:31.5925301Z executing qiskit.circuit.library.QFT
    2023-01-04T21:31:35.3652889Z reading sources... [ 31%] stubs/qiskit.circuit.library.QFT.inverse
    2023-01-04T21:31:35.3913019Z reading sources... [ 31%] stubs/qiskit.circuit.library.QFT.is_inverse
    2023-01-04T21:31:35.4039735Z reading sources... [ 31%] stubs/qiskit.circuit.library.QuadraticForm
    2023-01-04T21:31:35.5617032Z reading sources... [ 31%] stubs/qiskit.circuit.library.QuadraticForm.required_result_qubits
    2023-01-04T21:31:35.5880155Z reading sources... [ 31%] stubs/qiskit.circuit.library.QuantumVolume
    2023-01-04T21:31:35.6868508Z executing qiskit.circuit.library.QuantumVolume
    2023-01-04T22:22:02.2667118Z ##[error]The operation was canceled.
    2023-01-04T22:22:02.2682001Z ##[section]Finishing: Run Docs build

This commit adds full verbosity to the Sphinx build, to see if there's
more information available to assist with the debug.
@jakelishman jakelishman added the on hold Can not fix yet label Jan 5, 2023
@jakelishman jakelishman requested a review from a team as a code owner January 5, 2023 11:20
@qiskit-bot
Copy link
Copy Markdown
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

  • @Qiskit/terra-core

@coveralls
Copy link
Copy Markdown

coveralls commented Jan 5, 2023

Pull Request Test Coverage Report for Build 3849416089

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.04%) to 84.643%

Files with Coverage Reduction New Missed Lines %
src/sabre_swap/layer.rs 2 98.95%
Totals Coverage Status
Change from base Build 3823792673: 0.04%
Covered Lines: 64174
Relevant Lines: 75817

💛 - Coveralls

jakelishman and others added 4 commits January 5, 2023 12:37
The overly verbose output showed that we weren't hitting a line in the
entry point `nbconvert` that emits a log message

        Loading script exporter: python

This should happen almost immediately after the notebook file is
written.  Beyond this, there wasn't much debugging information to go on,
and the full verbosity blew up the logs.
This commit expands the module documentation for the qiskit.transpiler
module to explain details of working with preset pass managers and how
to modify stages for custom workflows. It also updates some of the
details about the stages which were a bit stale on the exact behavior of
the transpiler.
Locally, I have had success with the docs build with everything
unpinned.  Unfortunately, `sphinx-design` includes a pin to `Sphinx<6`,
and isn't updated frequently.  This commit removes the last of the usage
of the package, and removes it from the documentation build, releasing
all the pins.

This may result in some suppressed warnings becoming visible again,
which we may need to handle separately.
@jakelishman
Copy link
Copy Markdown
Member Author

Superseded by #9346.

@jakelishman jakelishman closed this Jan 6, 2023
@jakelishman jakelishman deleted the debug-docs branch January 6, 2023 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

on hold Can not fix yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants