Skip to Content

API 使用总览

本页按任务列出公共入口、返回形式和对应参考页。普通线路工作流从 unitarylab 顶层导入;算法和应用能力从 unitarylab.library 及其子模块导入。

线路与寄存器

from unitarylab import Circuit, Register, ClassicalRegister
任务入口返回或行为文档
创建线路Circuit(...)新 Circuit创建线路与寄存器
添加门或线路测量h()、cx()、measure() 等原地修改线路量子门与测量
复制、求逆或展开copy()、inverse()、decompose() 等新 Circuit线路变换
组合或初始化append()、prepend()、initialize()原地修改线路线路变换

执行与结果

任务入口返回值文档
纯态或 MPS 执行Circuit.execute()ExecutionResult执行线路与查看结果
密度矩阵执行Circuit.execute_density()DensityMatrixResult密度矩阵与噪声模型
选择执行实现和设备backend、device、dtype执行配置执行后端与参数
概率、采样和期望值probability()、sample()、expectation()标量、字典或列表执行线路与查看结果

execute() 的 shots 表示整条含线路测量程序的重复执行次数。ExecutionResult.sample() 从已有结果分布采样,不会重新执行线路。

绘图、分析与格式转换

任务入口返回值文档
绘制线路Circuit.draw()绘图对象或文本表示线路分析与绘图
分析线路Circuit.analyze()CircuitInfo线路分析与绘图
导入或导出 OpenQASMfrom_qasm*()、to_qasm*()Circuit、字符串或文件OpenQASM 与 Python 导入导出
生成 Python 重建代码to_python*()字符串或文件OpenQASM 与 Python 导入导出

编译与真机

from unitarylab import QCompiler, CompileConfig, CompilationResult, HardwareResult
阶段入口返回值是否提交任务
规则优化Circuit.optimize()新 Circuit否
门基转译Circuit.transpile()新 Circuit否
映射与编译Circuit.compile()CompilationResult否
真机提交Circuit.submit()HardwareResult是

编译和提交的参数、凭据及额度风险见线路优化与编译和真机任务提交。

算法顶层入口

from unitarylab.library import ( QFT, IQFT, QPE, LCU, block_encode, hamiltonian_simulation, solve, QSVT, QSP, QSP_hamiltonian_simulation, )
返回形式入口
CircuitQFT()、IQFT()、LCU()
线路或三元组QPE()
结果对象block_encode()、hamiltonian_simulation()、solve()、QSVT()
低层线路或元组QSP()、QSP_hamiltonian_simulation()

参数和返回字段见算法库概览。

应用子模块

任务模块主要返回形式
Pauli 分解和线路构造unitarylab.library.pauli_operator列表、矩阵或 Circuit
Fermi–Hubbard 工具unitarylab.library.fermi_hubbard字典、字符串或结果对象
Ising/QUBO 求解unitarylab.library.qubocore字典
PDE 求解unitarylab.library.equation字典和生成文件
量子机器学习unitarylab.library.qmlPyTorch 张量、模型和训练记录
量子化学扩展unitarylab_chemistry分阶段结果对象

对应页面分别为 Pauli 工具、Fermi–Hubbard 工具、QUBO 与 Ising 求解、PDE 求解框架、QML 概览与后端和量子化学扩展。

最后更新于