search

Qiskit / qiskit-ibm-runtime

IBM Client for Qiskit Runtime
https://docs.quantum.ibm.com/api/qiskit-ibm-runtime
Apache License 2.0
148 stars 155 forks source link

Weird NoiseLearner.run parameter type in docs #1877

Open jyu00 opened 3 weeks ago

jyu00 commented 3 weeks ago

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

Eric-Arellano commented 3 weeks ago

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 🤔