文档总览¶
本目录分两层：用户指南帮助你安装、配置、跑通；API 参考面向二次开发。
用户指南¶
- 配置凭证 (Configuration) — 真机 token 的三种配置方式与查找优先级（本地模拟器无需配置）
- 上手教程见下方 下方「教程入口（Notebook）」；安装与快速开始见项目根 README
API 参考¶
教程入口（Notebook）¶
- 全览入门：demo_full.ipynb
- 线路与 core：demo_circuit_core.ipynb
- Shadow：demo_shadow.ipynb
- Readout + ZNE：demo_readout_zne.ipynb
- Clifford fitting：demo_clifford_fitting.ipynb
- VQE：demo_vqe.ipynb
- QAOA：demo_qaoa.ipynb
- QML Iris 分类：demo_qml_iris.ipynb
- QNN BAS 分布学习：demo_qnn_bas.ipynb
- QNN 无监督分布学习：demo_qnn_unsupervised.ipynb
- Backend：demo_backend.ipynb
- 含噪模拟：demo_noisy_simulation.ipynb
学习路径（入门 → 进阶 → 硬件 → 优化）¶
- 入门： 全览入门：demo_full.ipynb
- 进阶： 线路与 core：demo_circuit_core.ipynb
- 硬件： Readout + ZNE：demo_readout_zne.ipynb
- 优化：
- 量子机器学习：
- 拓扑补充： Backend：demo_backend.ipynb
API¶
- api module reference
- QuantumHardwareClient
- run_with_backend
- hardware_discovery
- Backend
- Task
- provider runtime
- provider adapters
- shared cqlib layer
- platform credentials
建议阅读顺序：
QuantumHardwareClient→run_with_backend→hardware_discovery→Backend→Task→provider_runtime→providers→cqlib→platform_credentials。
Algorithms¶
- algorithms module reference
- ShadowTomography.run
- VQERunner.run_model
- QAOARunner.run_model
- QML — run_pqc_classifier / run_qnn_unsupervised / run_qnn_conditional
- QMLRunner
- optimizer utils
- qml encoding
- circuit compression
- ansatz templates
Calibration¶
- ReadoutCalibrationManager
- build_confusion_matrix
- NativeTwoQubitRBManager
- NativeTwoQubitTomographyManager
Core¶
建议阅读顺序：circuits → observables → utils → readout → zne → result_types。
Compile¶
- compile module reference
- Transpiler
- Layout
- SabreRouting
- GateCompressor
- DynamicalDecoupling
- Decompose
- TranslateToBasisGates
- DAG 工具
建议阅读顺序：
Transpiler（总览）→Layout→SabreRouting→TranslateToBasisGates→GateCompressor→DynamicalDecoupling→Decompose→DAG。