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

Weird NoiseLearner.run parameter type in docs #1877

Open
jyu00 opened this issue Aug 19, 2024 · 1 comment
Open

Weird NoiseLearner.run parameter type in docs #1877

jyu00 opened this issue Aug 19, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@jyu00
Copy link
Collaborator

jyu00 commented Aug 19, 2024

Describe the bug

The NoiseLearner.run API page describes the circuits input type as

image

That's not exactly digestible.

Steps to reproduce

Expected behavior

Suggested solutions

Additional Information

@Eric-Arellano Maybe this is trying to reference EstimatorPubLike in a weird way? Estimator's API doc doesn't have this issue though.

cc @SamFerracin

  • qiskit-ibm-runtime version:
  • Python version:
  • Operating system:
@jyu00 jyu00 added the bug Something isn't working label Aug 19, 2024
@Eric-Arellano
Copy link
Collaborator

Maybe this is trying to reference EstimatorPubLike in a weird way? Estimator's API doc doesn't have this issue though.

Yes, that is what's going on. I'm not sure why Sphinx is expanding inlining EstimatorPubLike in https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner#run but not https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2#run 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

No branches or pull requests

2 participants