API 参考

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

顶层公共 API

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

按主题找指南页

每个 API 领域都有对应的叙事文档(含示例与坑位说明):

API 领域

指南页

Circuit / 线路构建

构建量子线路 · 线路分析

模拟器

本地模拟 · MPS 模拟器 · 噪声模拟 · 动态电路

编译(compile / TranspilerConfig)

编译选项与 Region 选择器 · 编译策略

任务提交(submit_task 等)

提交任务到量子云平台 · 任务管理器

后端 / 适配器(BackendInfo / RegionSelector)

云平台适配器架构 · 平台约定

校准 / QEM(M3Mitigator / ReadoutEM)

芯片校准与量子错误缓解

PyTorch

PyTorch 集成

CLI

命令行工具

子模块索引

PyTorch 与训练 API

以下公开页面与完整 API 树一起生成,并在缺失时由 sphinx -W 阻止文档构建:

索引