跳转至

API

概览

  • 模块路径：fieldqkit.api
  • 模块定位：统一硬件执行 API（入口客户端 + 后端发现 + 任务抽象 + provider 适配）

页面导航

深入学习： - Backend —— 后端抽象、拓扑操作、硬件 profile - Task —— 任务协议与适配器接口 - provider_runtime —— Provider Runtime 工厂 - providers —— 六个 Provider 实现（Quafu、TianYan、GuoDun、Tencent、Origin、FieldQuantum 云） - cqlib —— 共享远程平台客户端 - platform_credentials —— 凭证管理

推荐阅读顺序

入门用户（关注功能使用）： 1. QuantumHardwareClient —— 了解如何调用 run_auto() 和 build_circuit() 2. hardware_discovery —— 学习硬件选择与后端解析 3. run_with_backend —— 理解执行流程和结果处理

进阶开发者（关注架构与扩展）： 4. Backend —— 拓扑图、保真度、硬件特性 5. Task —— 任务抽象与适配器设计模式 6. provider_runtime —— Provider 动态注册与初始化

集成新 Provider： 7. providers —— 参考现有 Quafu/TianYan/GuoDun/Tencent/Origin/FieldQuantum 实现 8. cqlib —— TianYan/GuoDun 共享的 HTTP 客户端层 9. platform_credentials —— 认证配置管理

参数详解速查

各文档中的关键方法参数说明如下：

  • QuantumHardwareClient
  • run_auto(...) 的 16 个参数（不含 self）及返回 RunResult 字段 —— see QuantumHardwareClient.md

  • build_circuit(kind, **kwargs) 的 4 种线路及其参数 —— see QuantumHardwareClient.md 下的展开说明

  • hardware_discovery

  • discover_hardware(num_qubits, prefer_hardware) —— see hardware_discovery.md

  • resolve_backend(...) —— see hardware_discovery.md

  • Backend

  • Backend(chip) + 拓扑操作方法 —— see Backend.md

  • Task

  • TaskAdapter.submit_openqasm() / query_status() / fetch_result() —— see Task.md

  • providers

  • Quafu/TianYan/GuoDun 特定方法 —— see providers.md

相关页面