API 参考

sphinx-autoapiuniqc/ 源码自动 生成。make html / make html-fast 在每次构建时都会重新跑 sphinx-apidoc, 所以这一章总是与当前 git checkout 的源码保持一致。

顶层公共 API

最常用的符号都从 uniqc 顶层导出(见 uniqc/__init__.py__all__); 新增公共符号时请在 __init__.py 同步更新。

  • uniqc.Circuit, uniqc.NamedCircuit, uniqc.QReg, uniqc.Qubit, uniqc.circuit_def()

  • uniqc.compile(), uniqc.compile_for_backend(), uniqc.TranspilerConfig

  • uniqc.submit_task(), uniqc.dry_run_task(), uniqc.submit_batch(), uniqc.wait_for_result(), uniqc.query_task(), uniqc.get_task()

  • uniqc.QuantumBackend, uniqc.OriginQBackend, uniqc.IBMBackend, uniqc.QuarkBackend, uniqc.DummyBackend

  • uniqc.BackendInfo, uniqc.QubitTopology, uniqc.RegionSelector

  • uniqc.M3Mitigator, uniqc.ReadoutEM

  • 异常都在 uniqc.exceptions

子模块索引

索引