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

Improve documentation on reshaping SamplerQNN output via interpret Callable #773

Open
edoaltamura opened this issue Feb 21, 2024 · 0 comments
Labels
documentation 📖 good first issue Good for newcomers type: enhancement ✨ Features or aspects to improve
Milestone

Comments

@edoaltamura
Copy link
Collaborator

What should we add?

Related to issue #674, this proposes enhancing the documentation of SamplerQNN to explain how to reshape the output via the interpret=None, output_shape=None arguments.

What should be implemented

An additional example titled Reshaping output by the number of classical registers and include in either or both the API documentation and a short tutorial (if both, then reference each other). NB the default reshapes by the total number of registers and the example should explain how to reshape by the number of classical registers only.
The documentation enhancement should appear as a minimum in the API reference of SamplerQNN.

Useful suggestion from xyzdxf

Use 2**circuit.num_clbits as the default output shape, instead of 2**circuit.num_qubits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 good first issue Good for newcomers type: enhancement ✨ Features or aspects to improve
Projects
None yet
Development

No branches or pull requests

1 participant