API 参考¶
由 sphinx-apidoc 从 uniqc/ 源码自动生成。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_defuniqc.compile(),uniqc.compile_for_backend,uniqc.TranspilerConfiguniqc.submit_task,uniqc.dry_run_task,uniqc.submit_batch,uniqc.wait_for_result,uniqc.query_task,uniqc.get_taskuniqc.QuantumBackend,uniqc.OriginQBackend,uniqc.IBMBackend,uniqc.QuarkBackend,uniqc.DummyBackenduniqc.BackendInfo,uniqc.QubitTopology,uniqc.RegionSelector异常都在
uniqc.exceptions
按主题找指南页¶
每个 API 领域都有对应的叙事文档(含示例与坑位说明):
API 领域 |
指南页 |
|---|---|
|
|
模拟器 |
|
编译( |
|
任务提交( |
|
后端 / 适配器( |
|
校准 / QEM( |
|
PyTorch |
|
CLI |
子模块索引¶
PyTorch 与训练 API¶
以下公开页面与完整 API 树一起生成,并在缺失时由 sphinx -W 阻止文档构建: