Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problem with graph in some API docs #13558

Open
beckykd opened this issue Dec 11, 2024 · 1 comment
Open

Problem with graph in some API docs #13558

beckykd opened this issue Dec 11, 2024 · 1 comment
Labels
bug Something isn't working documentation Something is not clear or an error documentation good first issue Good for newcomers
Milestone

Comments

@beckykd
Copy link
Collaborator

beckykd commented Dec 11, 2024

Environment

Windows - chrome

What is happening?

In these topics, the graphs / tables / images look wrong:

https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.GraphState
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.QuantumVolume
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.InnerProduct
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.InnerProductGate
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.AND
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.AndGate
https://docs.quantum.ibm.com/api/qiskit/pulse#pulse-builder
https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling#dynamicaldecoupling
https://docs.quantum.ibm.com/api/qiskit/qiskit.visualization.plot_histogram#qiskitvisualizationplot_histogram
https://docs.quantum.ibm.com/api/qiskit/qiskit.visualization.plot_bloch_multivector#qiskitvisualizationplot_bloch_multivector
https://docs.quantum.ibm.com/api/qiskit/qiskit.visualization.plot_state_paulivec#qiskitvisualizationplot_state_paulivec
https://docs.quantum.ibm.com/api/qiskit/qiskit.visualization.timeline_drawer#qiskitvisualizationtimeline_drawer

Examples of some of the problems:
Image

The first column of this one is cut off:
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.QuantumVolume
Image

Something is squished and cut off on the left in several. For example:
https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.InnerProduct
Image

The top and bottom are cut off on this one:
https://docs.quantum.ibm.com/api/qiskit/pulse#pulse-builder
Image

Also in the pulse file, these captions seem all squished:
Image
Image

The legend is cut off:
Image

This title is cut off:
Image

How can we reproduce the issue?

look at the above links.

What should happen?

All images should display properly.

Any suggestions?

This API doc has a similar graph that displays fine: https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.iqp_function

@beckykd beckykd added the bug Something isn't working label Dec 11, 2024
@beckykd beckykd changed the title Problem with graph Problem with graph in GraphState API docs Dec 11, 2024
@beckykd beckykd changed the title Problem with graph in GraphState API docs Problem with graph in some API docs Dec 11, 2024
@alexanderivrii alexanderivrii added this to the 1.3.2 milestone Dec 12, 2024
@alexanderivrii alexanderivrii added the good first issue Good for newcomers label Dec 12, 2024
@github-project-automation github-project-automation bot moved this to Tagged but unassigned in Contributor Monitoring Dec 12, 2024
@alexanderivrii alexanderivrii added the documentation Something is not clear or an error documentation label Dec 12, 2024
@alexanderivrii
Copy link
Contributor

Thanks for opening this issue, @beckykd. Are you also planning to make a PR that fixes this?

My own guess is that the output we get using _generate_circuit_library_generalization is worse than using circuit.draw(), and we may want to change the former calls to latter ones across the board. What do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Something is not clear or an error documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants