API 参考
按模块查阅签名、参数、返回值和生命周期约定。第一次编写程序可先阅读快速上手,完整操作过程位于各主题教程。
常用执行接口与 QuantumCircuit、Parameter 可从 pivotq 顶层导入;完整电路入口、作业管理与性能预测分别从 pivotq.circuit、pivotq.jobs、pivotq.performance 导入。
| 模块 | 主要接口 |
|---|---|
| 运行时与结果引用 | Runtime、ResultRef、submit/get/release、wait/status/resources |
| 组件与 Actor | ComponentSpec、ComponentHandle、register/actor |
| 工作流 | Workflow、NodeRef、WorkflowRun、Runtime.run |
| 电路构造与参数 | pivotq.circuit:电路、寄存器、参数、编译与序列化 |
| 量子后端与结果 | QuantumBackend、QuantumResult、quantum_backend |
| Provider 扩展协议 | BackendCapabilities、QuantumRequest、ProviderResult、QuantumProvider |
| 模块 | 主要接口 |
|---|---|
| 状态与执行报告 | InvocationStatus、ExecutionReport、Runtime.report |
| 集群作业 | JobClient、JobSpec、JobHandle、JobStatus |
| 异常与错误处理 | PivotQError、ResultUnknownError、提交异常和重试建议 |
| 模块 | 主要接口 |
|---|---|
| 性能模型与预测 | Workload、Hardware、CPU/QPU/链路配置、Predictor、PredictionResult |
性能模型独立描述任务与硬件,不依赖正在运行的 Ray 集群或 QPU。执行程序使用 Runtime;预测模型使用 Workload。